cardinal_pythonlib.sqlalchemy.table_identity

Original code copyright (C) 2009-2022 Rudolf Cardinal (rudolf@pobox.com).

This file is part of cardinal_pythonlib.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Class to refer to database tables either by name or by SQLAlchemy Table object.

class cardinal_pythonlib.sqlalchemy.table_identity.TableIdentity(tablename: str | None = None, table: Table | None = None, metadata: MetaData | None = None)[source]

Convenient way of passing around SQLAlchemy Table objects when you might know either either its name or the Table object itself.

Initialize with either tablename or table, not both.

Parameters:

tablename¶ – string name of the table
table¶ – SQLAlchemy Table object
metadata¶ – optional MetaData object

set_metadata(metadata: MetaData) → None[source]: Sets the MetaData.

set_metadata_if_none(metadata: MetaData) → None[source]: Sets the MetaData unless it was set already.

property table: Table: Returns a SQLAlchemy Table object. This is either the Table object that was used for initialization, or one that was constructed from the tablename plus the metadata.

property tablename: str: Returns the string name of the table.