sqlalchemy.dialects.postgresql.base.PGInspector

class documentation

class PGInspector(reflection.Inspector): (source)

View In Hierarchy

Undocumented

Method get_domains Return a list of DOMAIN objects.
Method get_enums Return a list of ENUM objects.
Method get_foreign_table_names Return a list of FOREIGN TABLE names.
Method get_table_oid Return the OID for the given table name.
Method has_type Return if the database has the specified type in the provided schema.
Class Variable dialect Undocumented

Inherited from Inspector:

Class Method from_engine Construct a new dialect-specific Inspector object from the given engine or connection.
Method __init__ Initialize a new :class:`_reflection.Inspector`.
Method clear_cache reset the cache for this :class:`.Inspector`.
Method get_check_constraints Return information about check constraints in ``table_name``.
Method get_columns Return information about columns in ``table_name``.
Method get_foreign_keys Return information about foreign_keys in ``table_name``.
Method get_indexes Return information about indexes in ``table_name``.
Method get_materialized_view_names Return all materialized view names in `schema`.
Method get_multi_check_constraints Return information about check constraints in all tables in the given schema.
Method get_multi_columns Return information about columns in all objects in the given schema.
Method get_multi_foreign_keys Return information about foreign_keys in all tables in the given schema.
Method get_multi_indexes Return information about indexes in in all objects in the given schema.
Method get_multi_pk_constraint Return information about primary key constraints in all tables in the given schema.
Method get_multi_table_comment Return information about the table comment in all objects in the given schema.
Method get_multi_table_options Return a dictionary of options specified when the tables in the given schema were created.
Method get_multi_unique_constraints Return information about unique constraints in all tables in the given schema.
Method get_pk_constraint Return information about primary key constraint in ``table_name``.
Method get_schema_names Return all schema names.
Method get_sequence_names Return all sequence names in `schema`.
Method get_sorted_table_and_fkc_names Return dependency-sorted table and foreign key constraint names in referred to within a particular schema.
Method get_table_comment Return information about the table comment for ``table_name``.
Method get_table_names Return all table names within a particular schema.
Method get_table_options Return a dictionary of options specified when the table of the given name was created.
Method get_temp_table_names Return a list of temporary table names for the current bind.
Method get_temp_view_names Return a list of temporary view names for the current bind.
Method get_unique_constraints Return information about unique constraints in ``table_name``.
Method get_view_definition Return definition for the plain or materialized view called ``view_name``.
Method get_view_names Return all non-materialized view names in `schema`.
Method has_index Check the existence of a particular index name in the database.
Method has_schema Return True if the backend has a schema with the given name.
Method has_sequence Return True if the backend has a sequence with the given name.
Method has_table Return True if the backend has a table, view, or temporary table of the given name.
Method reflect_table Given a :class:`_schema.Table` object, load its internal constructs based on introspection.
Method sort_tables_on_foreign_key_dependency Return dependency-sorted table and foreign key constraint names referred to within multiple schemas.
Instance Variable bind Undocumented
Instance Variable engine Undocumented
Instance Variable info_cache Undocumented
Property default_schema_name Return the default schema name presented by the dialect for the current engine's database user.
Class Method _construct Undocumented
Method _connection_insp Undocumented
Method _engine_insp Undocumented
Method _get_reflection_info Undocumented
Method _init_connection Undocumented
Method _init_engine Undocumented
Method _init_legacy Undocumented
Method _inspection_context Return an :class:`_reflection.Inspector` from this one that will run all operations on a single connection.
Method _instantiate_types Undocumented
Method _operation_context Return a context that optimizes for multiple operations on a single transaction.
Method _reflect_check_constraints Undocumented
Method _reflect_column Undocumented
Method _reflect_fk Undocumented
Method _reflect_indexes Undocumented
Method _reflect_pk Undocumented
Method _reflect_table_comment Undocumented
Method _reflect_unique_constraints Undocumented
Class Variable _index_sort_exprs Undocumented
Instance Variable _op_context_requires_connect Undocumented

Inherited from Inspectable (via Inspector):

Class Variable __slots__ Undocumented
def get_domains(self, schema: Optional[str] = None) -> List[ReflectedDomain]: (source)

Return a list of DOMAIN objects. Each member is a dictionary containing these fields: * name - name of the domain * schema - the schema name for the domain. * visible - boolean, whether or not this domain is visible in the default search path. * type - the type defined by this domain. * nullable - Indicates if this domain can be ``NULL``. * default - The default value of the domain or ``None`` if the domain has no default. * constraints - A list of dict wit the constraint defined by this domain. Each element constaints two keys: ``name`` of the constraint and ``check`` with the constraint text. :param schema: schema name. If None, the default schema (typically 'public') is used. May also be set to ``'*'`` to indicate load domains for all schemas. .. versionadded:: 2.0

def get_enums(self, schema: Optional[str] = None) -> List[ReflectedEnum]: (source)

Return a list of ENUM objects. Each member is a dictionary containing these fields: * name - name of the enum * schema - the schema name for the enum. * visible - boolean, whether or not this enum is visible in the default search path. * labels - a list of string labels that apply to the enum. :param schema: schema name. If None, the default schema (typically 'public') is used. May also be set to ``'*'`` to indicate load enums for all schemas. .. versionadded:: 1.0.0

def get_foreign_table_names(self, schema: Optional[str] = None) -> List[str]: (source)

Return a list of FOREIGN TABLE names. Behavior is similar to that of :meth:`_reflection.Inspector.get_table_names`, except that the list is limited to those tables that report a ``relkind`` value of ``f``. .. versionadded:: 1.0.0

def get_table_oid(self, table_name: str, schema: Optional[str] = None) -> int: (source)

Return the OID for the given table name. :param table_name: string name of the table. For special quoting, use :class:`.quoted_name`. :param schema: string schema name; if omitted, uses the default schema of the database connection. For special quoting, use :class:`.quoted_name`.

def has_type(self, type_name: str, schema: Optional[str] = None, **kw: Any) -> bool: (source)

Return if the database has the specified type in the provided schema. :param type_name: the type to check. :param schema: schema name. If None, the default schema (typically 'public') is used. May also be set to ``'*'`` to check in all schemas. .. versionadded:: 2.0

dialect: PGDialect = (source)
overrides sqlalchemy.engine.reflection.Inspector.dialect

Undocumented