Schemas

from sqlalchemy_declarative_extensions import Schema, Schemas

schemas = Schemas().are("foo", "bar", Schema("baz"))
class sqlalchemy_declarative_extensions.schema.base.Schema

Represents a schema.

classmethod coerce_from_unknown(unknown)
Parameters:

unknown (Self | str)

Return type:

Self

name: str
to_sql_create()
Return type:

sqlalchemy.sql.base.Executable | str

to_sql_drop()
Return type:

sqlalchemy.sql.base.Executable | str

use_role: sqlalchemy_declarative_extensions.role.Role | str | None = None
class sqlalchemy_declarative_extensions.schema.base.Schemas

A collection of schemas and the settings for diff/collection.

Parameters:
  • schemas – The list of grants

  • ignore_unspecified – Optionally ignore detected grants which do not match the set of defined grants.

Examples

  • No schemas

>>> schemas = Schemas()
  • Some options set

>>> schemas = Schemas(ignore_unspecified=True)
  • With some actual schemas

>>> from sqlalchemy_declarative_extensions import Schema, Schemas
>>> schema = Schemas().are("foo", Schema("bar"), ...)
are(*schemas)

Declare the set of schemas which should exist.

Parameters:

schemas (Schema | str)

classmethod coerce_from_unknown(unknown)
Parameters:

unknown (None | Iterable[Schema | str] | Schemas)

Return type:

Schemas | None

classmethod extract(metadata)
Parameters:

metadata (sqlalchemy.MetaData | list[sqlalchemy.MetaData | None] | None)

Return type:

Self | None

ignore_unspecified: bool = False
schemas: Sequence[Schema] = ()
sqlalchemy_declarative_extensions.schema.base.context