sdkagent

sqlalchemy API reference

400 public APIs from sqlalchemy (sqlalchemy/sqlalchemy) — 196 classes, 25 functions, 179 methods. Signatures extracted by static analysis of the actual source.

Repository: sqlalchemy/sqlalchemy

KindCount
Classes196
Functions25
Methods179

API list

classlib.sqlalchemy.dialects.mssql.base.BIT
MSSQL BIT type.
classlib.sqlalchemy.dialects.mssql.base.DOUBLE_PRECISION
the SQL Server DOUBLE PRECISION datatype.
classlib.sqlalchemy.dialects.mssql.base.REAL
the SQL Server REAL datatype.
classlib.sqlalchemy.dialects.mssql.base.ROWVERSION
Implement the SQL Server ROWVERSION type.
classlib.sqlalchemy.dialects.mssql.base.TIMESTAMP
Implement the SQL Server TIMESTAMP type.
classlib.sqlalchemy.dialects.mssql.base.VARBINARY
The MSSQL VARBINARY type.
classlib.sqlalchemy.dialects.mssql.base.XML
MSSQL XML type.
classlib.sqlalchemy.dialects.mssql.json.JSON
MSSQL JSON type.
classlib.sqlalchemy.dialects.mysql.base.MySQLDialect
Details of the MySQL dialect.
classlib.sqlalchemy.dialects.mysql.dml.Insert
MySQL-specific implementation of INSERT.
methodlib.sqlalchemy.dialects.mysql.dml.Insert.on_duplicate_key_update(*args:_UpdateArg, **kw:Any) -> Self
Specifies the ON DUPLICATE KEY UPDATE clause.
classlib.sqlalchemy.dialects.mysql.enumerated.ENUM
MySQL ENUM type.
classlib.sqlalchemy.dialects.mysql.enumerated.SET
MySQL SET type.
classlib.sqlalchemy.dialects.mysql.expression.match
Produce a ``MATCH (X, Y) AGAINST ('TEXT')`` clause.
classlib.sqlalchemy.dialects.mysql.json.JSON
MySQL JSON type.
classlib.sqlalchemy.dialects.mysql.mariadb.INET4
INET4 column type for MariaDB ..
classlib.sqlalchemy.dialects.mysql.mariadb.INET6
INET6 column type for MariaDB ..
classlib.sqlalchemy.dialects.mysql.types.BIGINT
MySQL BIGINTEGER type.
classlib.sqlalchemy.dialects.mysql.types.BIT
MySQL BIT type.
classlib.sqlalchemy.dialects.mysql.types.CHAR
MySQL CHAR type, for fixed-length character data.
classlib.sqlalchemy.dialects.mysql.types.DATETIME
MySQL DATETIME type.
classlib.sqlalchemy.dialects.mysql.types.DECIMAL
MySQL DECIMAL type.
classlib.sqlalchemy.dialects.mysql.types.DOUBLE
MySQL DOUBLE type.
classlib.sqlalchemy.dialects.mysql.types.FLOAT
MySQL FLOAT type.
classlib.sqlalchemy.dialects.mysql.types.INTEGER
MySQL INTEGER type.
classlib.sqlalchemy.dialects.mysql.types.LONGBLOB
MySQL LONGBLOB type, for binary data up to 2^32 bytes.
classlib.sqlalchemy.dialects.mysql.types.MEDIUMINT
MySQL MEDIUMINTEGER type.
classlib.sqlalchemy.dialects.mysql.types.NCHAR
MySQL NCHAR type.
classlib.sqlalchemy.dialects.mysql.types.NUMERIC
MySQL NUMERIC type.
classlib.sqlalchemy.dialects.mysql.types.NVARCHAR
MySQL NVARCHAR type.
classlib.sqlalchemy.dialects.mysql.types.REAL
MySQL REAL type.
classlib.sqlalchemy.dialects.mysql.types.SMALLINT
MySQL SMALLINTEGER type.
classlib.sqlalchemy.dialects.mysql.types.TIME
MySQL TIME type.
classlib.sqlalchemy.dialects.mysql.types.TIMESTAMP
MySQL TIMESTAMP type.
classlib.sqlalchemy.dialects.mysql.types.TINYBLOB
MySQL TINYBLOB type, for binary data up to 2^8 bytes.
classlib.sqlalchemy.dialects.mysql.types.TINYINT
MySQL TINYINT type.
classlib.sqlalchemy.dialects.mysql.types.VARCHAR
MySQL VARCHAR type, for variable-length character data.
classlib.sqlalchemy.dialects.oracle.json.JSON
Oracle JSON type.
classlib.sqlalchemy.dialects.oracle.types.BINARY_DOUBLE
Implement the Oracle ``BINARY_DOUBLE`` datatype.
classlib.sqlalchemy.dialects.oracle.types.BINARY_FLOAT
Implement the Oracle ``BINARY_FLOAT`` datatype.
classlib.sqlalchemy.dialects.oracle.types.DATE
Provide the Oracle Database DATE type.
classlib.sqlalchemy.dialects.oracle.types.FLOAT
Oracle Database FLOAT.
classlib.sqlalchemy.dialects.oracle.types.ROWID
Oracle Database ROWID type.
classlib.sqlalchemy.dialects.oracle.vector.SparseVector
Lightweight SQLAlchemy-side version of SparseVector.
classlib.sqlalchemy.dialects.oracle.vector.VECTOR
Oracle VECTOR datatype.
classlib.sqlalchemy.dialects.oracle.vector.VectorIndexConfig
Define the configuration for Oracle VECTOR Index.
classlib.sqlalchemy.dialects.postgresql.array.ARRAY
PostgreSQL ARRAY type.
methodlib.sqlalchemy.dialects.postgresql.array.ARRAY.Comparator.contained_by(other:typing_Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.array.ARRAY.Comparator.contains(other:typing_Any, **kwargs:typing_Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.array.ARRAY.Comparator.overlap(other:typing_Any) -> ColumnElement[bool]
Boolean expression.
classlib.sqlalchemy.dialects.postgresql.array.array
A PostgreSQL ARRAY literal.
classlib.sqlalchemy.dialects.postgresql.base.ReflectedDomain
Represents a reflected enum.
classlib.sqlalchemy.dialects.postgresql.base.ReflectedEnum
Represents a reflected enum.
classlib.sqlalchemy.dialects.postgresql.base.ReflectedNamedType
Represents a reflected named type.
classlib.sqlalchemy.dialects.postgresql.bitstring.BitString
Represent a PostgreSQL bit string in python.
methodlib.sqlalchemy.dialects.postgresql.bitstring.BitString.set_bit(index:int, value:bool | int | Literal['0', '1']) -> BitString
Set the bit at index to the given value.
classlib.sqlalchemy.dialects.postgresql.dml.Insert
PostgreSQL-specific implementation of INSERT.
classlib.sqlalchemy.dialects.postgresql.ext.ExcludeConstraint
A table-level EXCLUDE constraint.
classlib.sqlalchemy.dialects.postgresql.ext.phraseto_tsquery
The PostgreSQL ``phraseto_tsquery`` SQL function.
classlib.sqlalchemy.dialects.postgresql.ext.plainto_tsquery
The PostgreSQL ``plainto_tsquery`` SQL function.
classlib.sqlalchemy.dialects.postgresql.ext.to_tsquery
The PostgreSQL ``to_tsquery`` SQL function.
classlib.sqlalchemy.dialects.postgresql.ext.to_tsvector
The PostgreSQL ``to_tsvector`` SQL function.
classlib.sqlalchemy.dialects.postgresql.ext.ts_headline
The PostgreSQL ``ts_headline`` SQL function.
classlib.sqlalchemy.dialects.postgresql.hstore.HSTORE
Represent the PostgreSQL HSTORE type.
classlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator
Define comparison operations for :class:`.HSTORE`.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.array() -> Any
Text array expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.contained_by(other:Any) -> Any
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.contains(other:Any, **kwargs:Any) -> Any
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.defined(key:Any) -> Any
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.delete(key:Any) -> Any
HStore expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.has_all(other:Any) -> Any
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.has_any(other:Any) -> Any
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.has_key(other:Any) -> Any
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.keys() -> Any
Text array expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.matrix() -> Any
Text array expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.slice(array:Any) -> Any
HStore expression.
methodlib.sqlalchemy.dialects.postgresql.hstore.HSTORE.Comparator.vals() -> Any
Text array expression.
classlib.sqlalchemy.dialects.postgresql.json.JSON
Represent the PostgreSQL JSON type.
classlib.sqlalchemy.dialects.postgresql.json.JSONB
Represent the PostgreSQL JSONB type.
methodlib.sqlalchemy.dialects.postgresql.json.JSONB.Comparator.contained_by(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.json.JSONB.Comparator.contains(other:Any, **kwargs:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.json.JSONB.Comparator.delete_path(array:Union[List[str], _pg_array[str]]) -> ColumnElement[_CT_JSON]
JSONB expression.
methodlib.sqlalchemy.dialects.postgresql.json.JSONB.Comparator.has_all(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.json.JSONB.Comparator.has_any(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.json.JSONB.Comparator.has_key(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.json.JSONB.Comparator.path_exists(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.json.JSONB.Comparator.path_match(other:Any) -> ColumnElement[bool]
Boolean expression.
classlib.sqlalchemy.dialects.postgresql.json.JSONPATH
JSON Path Type.
classlib.sqlalchemy.dialects.postgresql.named_types.CreateDomainType
Represent a CREATE DOMAIN statement.
classlib.sqlalchemy.dialects.postgresql.named_types.DOMAIN
Represent the DOMAIN PostgreSQL type.
classlib.sqlalchemy.dialects.postgresql.named_types.DropDomainType
Represent a DROP DOMAIN statement.
classlib.sqlalchemy.dialects.postgresql.named_types.ENUM
PostgreSQL ENUM type.
methodlib.sqlalchemy.dialects.postgresql.named_types.ENUM.drop(bind:_CreateDropBind, checkfirst:bool=True) -> None
Emit ``DROP TYPE`` for this :class:`_postgresql.ENUM`.
classlib.sqlalchemy.dialects.postgresql.named_types.NamedType
Base for named types.
methodlib.sqlalchemy.dialects.postgresql.named_types.NamedType.create(bind:_CreateDropBind, checkfirst:bool=True, **kw:Any) -> None
Emit ``CREATE`` DDL for this type.
methodlib.sqlalchemy.dialects.postgresql.named_types.NamedType.drop(bind:_CreateDropBind, checkfirst:bool=True, **kw:Any) -> None
Emit ``DROP`` DDL for this type.
classlib.sqlalchemy.dialects.postgresql.ranges.AbstractMultiRange
Base for PostgreSQL MULTIRANGE types.
classlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange
Base class for single and multi Range SQL types.
classlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory
Define comparison operations for range types.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.adjacent_to(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.contained_by(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.contains(other:Any, **kw:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.difference(other:Any) -> ColumnElement[bool]
Range expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.intersection(other:Any) -> ColumnElement[Range[_T]]
Range expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.not_extend_left_of(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.not_extend_right_of(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.overlaps(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.strictly_left_of(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.strictly_right_of(other:Any) -> ColumnElement[bool]
Boolean expression.
methodlib.sqlalchemy.dialects.postgresql.ranges.AbstractRange.comparator_factory.union(other:Any) -> ColumnElement[bool]
Range expression.
classlib.sqlalchemy.dialects.postgresql.ranges.AbstractSingleRange
Base for PostgreSQL RANGE types.
classlib.sqlalchemy.dialects.postgresql.ranges.DATEMULTIRANGE
Represent the PostgreSQL DATEMULTIRANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.DATERANGE
Represent the PostgreSQL DATERANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.INT4MULTIRANGE
Represent the PostgreSQL INT4MULTIRANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.INT4RANGE
Represent the PostgreSQL INT4RANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.INT8MULTIRANGE
Represent the PostgreSQL INT8MULTIRANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.INT8RANGE
Represent the PostgreSQL INT8RANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.MultiRange
Represents a multirange sequence.
classlib.sqlalchemy.dialects.postgresql.ranges.NUMMULTIRANGE
Represent the PostgreSQL NUMMULTIRANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.NUMRANGE
Represent the PostgreSQL NUMRANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.Range
Represent a PostgreSQL range.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.adjacent_to(other:Range[_T]) -> bool
Determine whether this range is adjacent to the `other`.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.contained_by(other:Range[_T]) -> bool
Determine whether this range is a contained by `other`.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.contains(value:Union[_T, Range[_T]]) -> bool
Determine whether this range contains `value`.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.difference(other:Range[_T]) -> Range[_T]
Compute the difference between this range and the `other`.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.intersection(other:Range[_T]) -> Range[_T]
Compute the intersection of this range with the `other`.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.is_empty() -> bool
A synonym for the 'empty' attribute.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.isempty() -> bool
A synonym for the 'empty' attribute.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.lower_inc() -> bool
Return True if the lower bound is inclusive.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.overlaps(other:Range[_T]) -> bool
Determine whether this range overlaps with `other`.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.union(other:Range[_T]) -> Range[_T]
Compute the union of this range with the `other`.
methodlib.sqlalchemy.dialects.postgresql.ranges.Range.upper_inc() -> bool
Return True if the upper bound is inclusive.
classlib.sqlalchemy.dialects.postgresql.ranges.TSMULTIRANGE
Represent the PostgreSQL TSRANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.TSRANGE
Represent the PostgreSQL TSRANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.TSTZMULTIRANGE
Represent the PostgreSQL TSTZRANGE type.
classlib.sqlalchemy.dialects.postgresql.ranges.TSTZRANGE
Represent the PostgreSQL TSTZRANGE type.
classlib.sqlalchemy.dialects.postgresql.types.BIT
Represent the PostgreSQL BIT type.
classlib.sqlalchemy.dialects.postgresql.types.CITEXT
Provide the PostgreSQL CITEXT type.
classlib.sqlalchemy.dialects.postgresql.types.INTERVAL
PostgreSQL INTERVAL type.
classlib.sqlalchemy.dialects.postgresql.types.MONEY
Provide the PostgreSQL MONEY type.
classlib.sqlalchemy.dialects.postgresql.types.OID
Provide the PostgreSQL OID type.
classlib.sqlalchemy.dialects.postgresql.types.REGCLASS
Provide the PostgreSQL REGCLASS type.
classlib.sqlalchemy.dialects.postgresql.types.REGCONFIG
Provide the PostgreSQL REGCONFIG type.
classlib.sqlalchemy.dialects.postgresql.types.TIME
PostgreSQL TIME type.
classlib.sqlalchemy.dialects.postgresql.types.TIMESTAMP
Provide the PostgreSQL TIMESTAMP type.
classlib.sqlalchemy.dialects.postgresql.types.TSQUERY
Provide the PostgreSQL TSQUERY type.
classlib.sqlalchemy.dialects.sqlite.base.DATE
Represent a Python date object in SQLite using a string.
classlib.sqlalchemy.dialects.sqlite.base.TIME
Represent a Python time object in SQLite using a string.
classlib.sqlalchemy.dialects.sqlite.dml.Insert
SQLite-specific implementation of INSERT.
classlib.sqlalchemy.dialects.sqlite.json.JSON
SQLite JSON type.
classlib.sqlalchemy.dialects.sqlite.json.JSONB
SQLite JSONB type.
methodlib.sqlalchemy.engine.base.Connection.begin() -> RootTransaction
Begin a transaction prior to autobegin occurring.
methodlib.sqlalchemy.engine.base.Connection.begin_nested() -> NestedTransaction
Begin a nested transaction (i.e.
methodlib.sqlalchemy.engine.base.Connection.close() -> None
Close this :class:`_engine.Connection`.
methodlib.sqlalchemy.engine.base.Connection.closed() -> bool
Return True if this connection is closed.
methodlib.sqlalchemy.engine.base.Connection.commit() -> None
Commit the transaction that is currently in progress.
methodlib.sqlalchemy.engine.base.Connection.in_nested_transaction() -> bool
Return True if a transaction is in progress.
methodlib.sqlalchemy.engine.base.Connection.in_transaction() -> bool
Return True if a transaction is in progress.
methodlib.sqlalchemy.engine.base.Connection.invalidated() -> bool
Return True if this connection was invalidated.
methodlib.sqlalchemy.engine.base.Engine.connect() -> Connection
Return a new :class:`_engine.Connection` object.
methodlib.sqlalchemy.engine.base.Engine.engine() -> Engine
Returns this :class:`.Engine`.
classlib.sqlalchemy.engine.base.ExceptionContextImpl
Implement the :class:`.ExceptionContext` interface.
classlib.sqlalchemy.engine.base.NestedTransaction
Represent a 'nested', or SAVEPOINT transaction.
classlib.sqlalchemy.engine.base.Transaction
Represent a database transaction in progress.
methodlib.sqlalchemy.engine.base.Transaction.close() -> None
Close this :class:`.Transaction`.
methodlib.sqlalchemy.engine.base.Transaction.commit() -> None
Commit this :class:`.Transaction`.
methodlib.sqlalchemy.engine.base.Transaction.rollback() -> None
Roll back this :class:`.Transaction`.
classlib.sqlalchemy.engine.base.TwoPhaseTransaction
Represent a two-phase transaction.
methodlib.sqlalchemy.engine.base.TwoPhaseTransaction.prepare() -> None
Prepare this :class:`.TwoPhaseTransaction`.
classlib.sqlalchemy.engine.characteristics.IsolationLevelCharacteristic
Manage the isolation level on a DBAPI connection
classlib.sqlalchemy.engine.cursor.BufferedRowCursorFetchStrategy
A cursor fetch strategy with row buffering behavior.
classlib.sqlalchemy.engine.cursor.CursorFetchStrategy
Call fetch methods from a DBAPI cursor.
classlib.sqlalchemy.engine.cursor.CursorResult
A Result that is representing state from a DBAPI cursor.
methodlib.sqlalchemy.engine.cursor.CursorResult.close() -> None
Close this :class:`_engine.CursorResult`.
methodlib.sqlalchemy.engine.cursor.CursorResult.lastrowid() -> int
Return the 'lastrowid' accessor on the DBAPI cursor.
methodlib.sqlalchemy.engine.cursor.CursorResult.rowcount() -> int
Return the 'rowcount' for this result.
classlib.sqlalchemy.engine.cursor.CursorResultMetaData
Result metadata for DBAPI cursors.
classlib.sqlalchemy.engine.cursor.NoCursorFetchStrategy
Cursor strategy for a result that has no open cursor.
classlib.sqlalchemy.engine.cursor.ResultFetchStrategy
Define a fetching strategy for a result object.
classlib.sqlalchemy.engine.default.DefaultDialect
Default implementation of Dialect
classlib.sqlalchemy.engine.events.DialectEvents
event interface for execution-replacement functions.
classlib.sqlalchemy.engine.interfaces.DBAPICursor
protocol representing a :pep:`249` database cursor.
methodlib.sqlalchemy.engine.interfaces.DBAPICursor.description() -> _DBAPICursorDescription
The description attribute of the Cursor.
classlib.sqlalchemy.engine.interfaces.DBAPIType
protocol representing a :pep:`249` database type.
methodlib.sqlalchemy.engine.interfaces.Dialect.connect(*cargs:Any, **cparams:Any) -> DBAPIConnection
Establish a connection using this dialect's DBAPI.
methodlib.sqlalchemy.engine.interfaces.Dialect.create_connect_args(url:URL) -> ConnectArgsType
Build DB-API compatible connection arguments.
methodlib.sqlalchemy.engine.interfaces.Dialect.create_xid() -> Any
Create a two-phase transaction ID.
methodlib.sqlalchemy.engine.interfaces.Dialect.dbapi_version() -> util.VersionInfo
the version number of the DBAPI in use.
methodlib.sqlalchemy.engine.interfaces.Dialect.do_begin_twophase(connection:Connection, xid:Any) -> None
Begin a two phase transaction on the given connection.
methodlib.sqlalchemy.engine.interfaces.Dialect.do_release_savepoint(connection:Connection, name:str) -> None
Release the named savepoint on a connection.
methodlib.sqlalchemy.engine.interfaces.Dialect.do_rollback_to_savepoint(connection:Connection, name:str) -> None
Rollback a connection to the named savepoint.
methodlib.sqlalchemy.engine.interfaces.Dialect.do_savepoint(connection:Connection, name:str) -> None
Create a savepoint with the given name.
methodlib.sqlalchemy.engine.interfaces.Dialect.get_dialect_pool_class(url:URL) -> Type[Pool]
return a Pool class to use for a given URL
methodlib.sqlalchemy.engine.interfaces.Dialect.get_table_names(connection:Connection, schema:Optional[str]=None, **kw:Any) -> List[str]
Return a list of table names for ``schema``.
methodlib.sqlalchemy.engine.interfaces.Dialect.get_view_definition(connection:Connection, view_name:str, schema:Optional[str]=None, **kw:Any) -> str
Return plain or materialized view definition.
methodlib.sqlalchemy.engine.interfaces.Dialect.load_provisioning() -> None
set up the provision.py module for this dialect.
methodlib.sqlalchemy.engine.interfaces.Dialect.retrieve_dbapi_version(dbapi:DBAPIModule) -> util.VersionInfo
Return the version of the given DBAPI module.
methodlib.sqlalchemy.engine.interfaces.Dialect.set_engine_execution_options(engine:Engine, opts:CoreExecuteOptionsParameter) -> None
Establish execution options for a given engine.
methodlib.sqlalchemy.engine.interfaces.Dialect.type_descriptor(typeobj:TypeEngine[_T]) -> TypeEngine[_T]
Transform a generic type to a dialect-specific type.
funclib.sqlalchemy.engine.mock.create_mock_engine(url:Union[str, URL], executor:Any, **kw:Any) -> MockConnection
Create a "mock" engine used for echoing DDL.
classlib.sqlalchemy.engine.reflection.Inspector
Performs database schema inspection.
methodlib.sqlalchemy.engine.reflection.Inspector.clear_cache() -> None
Reset the cache for this :class:`.Inspector`.
methodlib.sqlalchemy.engine.reflection.Inspector.get_materialized_view_names(schema:Optional[str]=None, **kw:Any) -> List[str]
Return all materialized view names in `schema`.
methodlib.sqlalchemy.engine.reflection.Inspector.get_schema_names(**kw:Any) -> List[str]
Return all schema names.
methodlib.sqlalchemy.engine.reflection.Inspector.get_sequence_names(schema:Optional[str]=None, **kw:Any) -> List[str]
Return all sequence names in `schema`.
methodlib.sqlalchemy.engine.reflection.Inspector.get_table_names(schema:Optional[str]=None, **kw:Any) -> List[str]
Return all table names within a particular schema.
methodlib.sqlalchemy.engine.reflection.Inspector.get_view_names(schema:Optional[str]=None, **kw:Any) -> List[str]
Return all non-materialized view names in `schema`.
classlib.sqlalchemy.engine.reflection.ReflectionDefaults
provides blank default values for reflection methods.
classlib.sqlalchemy.engine.result.Result
Represent a set of database results.
methodlib.sqlalchemy.engine.result.Result.all() -> Sequence[Row[Unpack[_Ts]]]
Return all rows in a sequence.
methodlib.sqlalchemy.engine.result.Result.close() -> None
Hard close this :class:`_engine.Result`.
methodlib.sqlalchemy.engine.result.Result.columns(*col_expressions:_KeyIndexType) -> Self
Establish the columns that should be returned in each row.
methodlib.sqlalchemy.engine.result.Result.fetchmany(size:Optional[int]=None) -> Sequence[Row[Unpack[_Ts]]]
Fetch many rows.
methodlib.sqlalchemy.engine.result.Result.fetchone() -> Optional[Row[Unpack[_Ts]]]
Fetch one row.
methodlib.sqlalchemy.engine.result.Result.one() -> Row[Unpack[_Ts]]
Return exactly one row or raise an exception.
methodlib.sqlalchemy.engine.result.Result.partitions(size:Optional[int]=None) -> Iterator[Sequence[Row[Unpack[_Ts]]]]
Iterate through sub-lists of rows of the size given.
methodlib.sqlalchemy.engine.result.Result.scalar_one_or_none() -> Optional[_T]
Return exactly one scalar result or ``None``.
classlib.sqlalchemy.engine.result.ResultMetaData
Base for metadata about result rows.
classlib.sqlalchemy.engine.result.SimpleResultMetaData
result metadata for in-memory collections.
classlib.sqlalchemy.engine.row.Row
Represent a single result row.
methodlib.sqlalchemy.engine.row.Row.t() -> Tuple[Unpack[_Ts]]
A synonym for :meth:`.Row._tuple`.
methodlib.sqlalchemy.engine.row.Row.tuple() -> Tuple[Unpack[_Ts]]
Return a 'tuple' form of this :class:`.Row`.
methodlib.sqlalchemy.engine.url.URL.get_backend_name() -> str
Return the backend name.
methodlib.sqlalchemy.engine.url.URL.get_driver_name() -> str
Return the backend name.
methodlib.sqlalchemy.engine.url.URL.render_as_string(hide_password:bool=True) -> str
Render this :class:`_engine.URL` object as a string.
funclib.sqlalchemy.engine.url.make_url(name_or_url:Union[str, URL]) -> URL
Given a string, produce a new URL instance.
funclib.sqlalchemy.engine.util.connection_memoize(key:str) -> Callable[[_C], _C]
Decorator, memoize a function in a connection.info stash.
funclib.sqlalchemy.event.api.listen(target:Any, identifier:str, fn:Callable[..., Any], *args:Any, **kw:Any) -> None
Register a listener function for the given target.
funclib.sqlalchemy.event.api.remove(target:Any, identifier:str, fn:Callable[..., Any]) -> None
Remove an event listener.
classlib.sqlalchemy.exc.ArgumentError
Raised when an invalid or conflicting function argument is supplied.
classlib.sqlalchemy.exc.CompileError
Raised when an error occurs during SQL compilation
classlib.sqlalchemy.exc.DBAPIError
Raised when the execution of a database operation fails.
classlib.sqlalchemy.exc.DataError
Wraps a DB-API DataError.
classlib.sqlalchemy.exc.DatabaseError
Wraps a DB-API DatabaseError.
classlib.sqlalchemy.exc.DisconnectionError
A disconnect is detected on a raw DB-API connection.
classlib.sqlalchemy.exc.HasDescriptionCode
helper which adds 'code' as an attribute and '_code_str' as a method
classlib.sqlalchemy.exc.IdentifierError
Raised when a schema name is beyond the max character limit
classlib.sqlalchemy.exc.IntegrityError
Wraps a DB-API IntegrityError.
classlib.sqlalchemy.exc.InterfaceError
Wraps a DB-API InterfaceError.
classlib.sqlalchemy.exc.InternalError
Wraps a DB-API InternalError.
classlib.sqlalchemy.exc.InvalidRequestError
SQLAlchemy was asked to do something it can't do.
classlib.sqlalchemy.exc.NoResultFound
A database result was required but none was found.
classlib.sqlalchemy.exc.NoSuchColumnError
A nonexistent column is requested from a ``Row``.
classlib.sqlalchemy.exc.NoSuchTableError
Table does not exist or is not visible to a connection.
classlib.sqlalchemy.exc.NotSupportedError
Wraps a DB-API NotSupportedError.
classlib.sqlalchemy.exc.OperationalError
Wraps a DB-API OperationalError.
classlib.sqlalchemy.exc.ProgrammingError
Wraps a DB-API ProgrammingError.
classlib.sqlalchemy.exc.SADeprecationWarning
Issued for usage of deprecated APIs.
classlib.sqlalchemy.exc.SAWarning
Issued at runtime.
classlib.sqlalchemy.exc.SQLAlchemyError
Generic error class.
classlib.sqlalchemy.exc.StatementError
An error occurred during execution of a SQL statement.
classlib.sqlalchemy.exc.UnreflectableTableError
Table exists but can't be reflected for some reason.
funclib.sqlalchemy.ext.asyncio.base.asyncstartablecontext(func:Callable[..., AsyncIterator[_T_co]]) -> Callable[..., GeneratorStartableContext[_T_co]]
@asyncstartablecontext decorator.
classlib.sqlalchemy.ext.asyncio.engine.AsyncConnection
An asyncio proxy for a :class:`_engine.Connection`.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncConnection.close() -> None
Close this :class:`_asyncio.AsyncConnection`.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncConnection.closed() -> Any
Return True if this connection is closed.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncConnection.in_nested_transaction() -> bool
Return True if a transaction is in progress.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncConnection.in_transaction() -> bool
Return True if a transaction is in progress.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncConnection.invalidated() -> Any
Return True if this connection was invalidated.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncConnection.run_sync(fn:Callable[Concatenate[Connection, _P], _T], *arg:_P.args, **kw:_P.kwargs) -> _T
Invoke the given synchronous (i.e.
classlib.sqlalchemy.ext.asyncio.engine.AsyncEngine
An asyncio proxy for a :class:`_engine.Engine`.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncEngine.echo() -> Any
When ``True``, enable log output for this element.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncEngine.engine() -> Any
Returns this :class:`.Engine`.
classlib.sqlalchemy.ext.asyncio.engine.AsyncTransaction
An asyncio proxy for a :class:`_engine.Transaction`.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncTransaction.close() -> None
Close this :class:`.AsyncTransaction`.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncTransaction.commit() -> None
Commit this :class:`.AsyncTransaction`.
methodlib.sqlalchemy.ext.asyncio.engine.AsyncTransaction.rollback() -> None
Roll back this :class:`.AsyncTransaction`.
funclib.sqlalchemy.ext.asyncio.engine.create_async_engine(url:Union[str, URL], **kw:Any) -> AsyncEngine
Create a new async engine instance.
funclib.sqlalchemy.ext.asyncio.engine.create_async_pool_from_url(url:Union[str, URL], **kwargs:Any) -> Pool
Create a new async engine instance.
classlib.sqlalchemy.ext.asyncio.exc.AsyncContextAlreadyStarted
a startable context manager is already started.
classlib.sqlalchemy.ext.asyncio.exc.AsyncContextNotStarted
a startable context manager has not been started.
methodlib.sqlalchemy.ext.asyncio.result.AsyncResult.all() -> Sequence[Row[Unpack[_Ts]]]
Return all rows in a list.
methodlib.sqlalchemy.ext.asyncio.result.AsyncResult.fetchmany(size:Optional[int]=None) -> Sequence[Row[Unpack[_Ts]]]
Fetch many rows.
methodlib.sqlalchemy.ext.asyncio.result.AsyncResult.fetchone() -> Optional[Row[Unpack[_Ts]]]
Fetch one row.
methodlib.sqlalchemy.ext.asyncio.result.AsyncResult.one() -> Row[Unpack[_Ts]]
Return exactly one row or raise an exception.
classlib.sqlalchemy.ext.asyncio.session.AsyncSession
Asyncio version of :class:`_orm.Session`.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.aclose() -> None
A synonym for :meth:`_asyncio.AsyncSession.close`.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.add(instance:object, *_warn:bool=True) -> None
Place an object into this :class:`_orm.Session`.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.commit() -> None
Commit the current transaction in progress.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.delete(instance:object) -> None
Mark an instance as deleted.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.expire(instance:object, attribute_names:Optional[Iterable[str]]=None) -> None
Expire the attributes on an instance.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.expunge(instance:object) -> None
Remove the `instance` from this ``Session``.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.flush(objects:Optional[Sequence[Any]]=None) -> None
Flush all the object changes to the database.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.info() -> Any
A user-modifiable dictionary.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.no_autoflush() -> Any
Return a context manager that disables autoflush.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.rollback() -> None
Rollback the current transaction in progress.
methodlib.sqlalchemy.ext.asyncio.session.AsyncSession.run_sync(fn:Callable[Concatenate[Session, _P], _T], *arg:_P.args, **kw:_P.kwargs) -> _T
Invoke the given synchronous (i.e.
classlib.sqlalchemy.ext.asyncio.session.async_sessionmaker
A configurable :class:`.AsyncSession` factory.
methodlib.sqlalchemy.ext.asyncio.session.async_sessionmaker.configure(**new_kw:Any) -> None
(Re)configure the arguments for this async_sessionmaker.
funclib.sqlalchemy.ext.asyncio.session.close_all_sessions() -> None
Close all :class:`_asyncio.AsyncSession` sessions.
classlib.sqlalchemy.ext.automap.AutomapBase
Base class for an "automap" schema.
funclib.sqlalchemy.ext.automap.automap_base(declarative_base:Optional[Type[Any]]=None, **kw:Any) -> Any
Produce a declarative automap base.
classlib.sqlalchemy.ext.baked.BakedQuery
A builder object for :class:`.query.Query` objects.
methodlib.sqlalchemy.ext.baked.BakedQuery.bakery(size=200, _size_alert=None)
Construct a new bakery.
classlib.sqlalchemy.ext.baked.Bakery
Callable which returns a :class:`.BakedQuery`.
classlib.sqlalchemy.ext.baked.Result
Invokes a :class:`.BakedQuery` against a :class:`.Session`.
methodlib.sqlalchemy.ext.baked.Result.all()
Return all rows.
methodlib.sqlalchemy.ext.baked.Result.count()
return the 'count'.
methodlib.sqlalchemy.ext.baked.Result.first()
Return the first row.
methodlib.sqlalchemy.ext.baked.Result.get(ident)
Retrieve an object based on identity.
classlib.sqlalchemy.ext.declarative.extensions.ConcreteBase
A helper class for 'concrete' declarative mappings.
classlib.sqlalchemy.ext.horizontal_shard.ShardedQuery
Query class used with :class:`.ShardedSession`.
methodlib.sqlalchemy.ext.horizontal_shard.ShardedQuery.set_shard(shard_id:ShardIdentifier) -> Self
Return a new query, limited to a single shard ID.
classlib.sqlalchemy.ext.indexable.index_property
A property generator.
classlib.sqlalchemy.ext.instrumentation.InstrumentationManager
User-defined class instrumentation extension.
funclib.sqlalchemy.ext.mutable.MutableBase.load(state:InstanceState[_O], *args:Any) -> None
Listen for objects loaded or refreshed.
classlib.sqlalchemy.ext.mutable.MutableDict
A dictionary type that implements :class:`.Mutable`.
methodlib.sqlalchemy.ext.mutable.MutableDict.coerce(key:str, value:Any) -> MutableDict[_KT, _VT] | None
Convert plain dictionary to instance of this class.
classlib.sqlalchemy.ext.mutable.MutableList
A list type that implements :class:`.Mutable`.
methodlib.sqlalchemy.ext.mutable.MutableList.coerce(key:str, value:MutableList[_T] | _T) -> Optional[MutableList[_T]]
Convert plain list to instance of this class.
classlib.sqlalchemy.ext.mutable.MutableSet
A set type that implements :class:`.Mutable`.
methodlib.sqlalchemy.ext.mutable.MutableSet.coerce(index:str, value:Any) -> Optional[MutableSet[_T]]
Convert plain set to instance of this class.
funclib.sqlalchemy.ext.orderinglist.count_from_0(index:int, collection:object) -> int
Numbering function: consecutive integers starting at 0.
funclib.sqlalchemy.ext.orderinglist.count_from_1(index:int, collection:object) -> int
Numbering function: consecutive integers starting at 1.
classlib.sqlalchemy.inspection.Inspectable
define a class as inspectable.
funclib.sqlalchemy.orm._orm_constructors.clear_mappers() -> None
Remove all mappers from all classes.
methodlib.sqlalchemy.orm.attributes.History.has_changes() -> bool
Return True if this :class:`.History` has changes.
methodlib.sqlalchemy.orm.attributes.History.non_added() -> Sequence[Any]
Return a collection of unchanged + deleted.
methodlib.sqlalchemy.orm.attributes.History.non_deleted() -> Sequence[Any]
Return a collection of added + unchanged.
methodlib.sqlalchemy.orm.attributes.History.sum() -> Sequence[Any]
Return a collection of added + unchanged + deleted.
funclib.sqlalchemy.orm.attributes.del_attribute(instance:object, key:str) -> None
Delete the value of an attribute, firing history events.
funclib.sqlalchemy.orm.attributes.flag_modified(instance:object, key:str) -> None
Mark an attribute on an instance as 'modified'.
funclib.sqlalchemy.orm.attributes.get_attribute(instance:object, key:str) -> Any
Get the value of an attribute, firing any callables required.
funclib.sqlalchemy.orm.attributes.has_parent(cls:Type[_O], obj:_O, key:str, optimistic:bool=False) -> bool
TODO
funclib.sqlalchemy.orm.attributes.set_committed_value(instance:object, key:str, value:Any) -> None
Set the value of an attribute with no history events.
classlib.sqlalchemy.orm.base.Mapped
Represent an ORM mapped attribute on a mapped class.
funclib.sqlalchemy.orm.base.instance_str(instance:object) -> str
Return a string describing an instance.
funclib.sqlalchemy.orm.base.state_str(state:InstanceState[Any]) -> str
Return a string describing an instance via its InstanceState.
methodlib.sqlalchemy.orm.collections.CollectionAdapter.clear_without_event() -> None
Empty the collection, firing no events.
methodlib.sqlalchemy.orm.collections.CollectionAdapter.data() -> _AdaptedCollectionProtocol
The entity collection being adapted.
methodlib.sqlalchemy.orm.collections.CollectionAdapter.remove_without_event(item:Any) -> None
Remove an entity from the collection, firing no events.
classlib.sqlalchemy.orm.collections.InstrumentedDict
An instrumented version of the built-in dict.
classlib.sqlalchemy.orm.collections.InstrumentedList
An instrumented version of the built-in list.
classlib.sqlalchemy.orm.collections.InstrumentedSet
An instrumented version of the built-in set.
classlib.sqlalchemy.orm.collections.collection
Decorators for entity collection classes.
methodlib.sqlalchemy.orm.collections.collection.adds(arg:int) -> Callable[[_FN], _FN]
Mark the method as adding an entity to the collection.
funclib.sqlalchemy.orm.collections.collection_adapter(collection:Collection[Any]) -> CollectionAdapter
Fetch the :class:`.CollectionAdapter` for a collection.
classlib.sqlalchemy.orm.decl_api.DCTransformDeclarative
metaclass that includes @dataclass_transforms
classlib.sqlalchemy.orm.decl_api.DeclarativeBase
Base class used for declarative class definitions.
funclib.sqlalchemy.orm.decl_api.add_mapped_attribute(target:Type[_O], key:str, attr:MapperProperty[Any]) -> None
Add a new mapped attribute to an ORM mapped class.
funclib.sqlalchemy.orm.decl_api.declarative_mixin(cls:Type[_T]) -> Type[_T]
Mark a class as providing the feature of "declarative mixin".
classlib.sqlalchemy.orm.decl_api.registry
Generalized registry for mapping classes.
methodlib.sqlalchemy.orm.decl_api.registry.dispose(cascade:bool=False) -> None
Dispose of all mappers in this :class:`_orm.registry`.
methodlib.sqlalchemy.orm.decl_api.registry.generate_base(mapper:Optional[Callable[..., Mapper[Any]]]=None, cls:Type[Any]=object, name:str='Base', metaclass:Type[Any]=DeclarativeMeta) -> Any
Generate a declarative base class.
methodlib.sqlalchemy.orm.decl_api.registry.map_declaratively(cls:Type[_O]) -> Mapper[_O]
Map a class declaratively.
methodlib.sqlalchemy.orm.decl_api.registry.map_imperatively(class_:Type[_O], local_table:Optional[FromClause]=None, **kw:Any) -> Mapper[_O]
Map a class imperatively.
classlib.sqlalchemy.orm.decl_base.MappedClassProtocol
A protocol representing a SQLAlchemy mapped class.
classlib.sqlalchemy.orm.events.AttributeEvents
Define events for object attributes.
methodlib.sqlalchemy.orm.events.AttributeEvents.append(target:_O, value:_T, initiator:Event, *key:EventConstants=NO_KEY) -> Optional[_T]
Receive a collection append event.
methodlib.sqlalchemy.orm.events.AttributeEvents.bulk_replace(target:_O, values:Iterable[_T], initiator:Event, *keys:Optional[Iterable[EventConstants]]=None) -> None
Receive a collection 'bulk replace' event.
methodlib.sqlalchemy.orm.events.AttributeEvents.dispose_collection(target:_O, collection:Collection[Any], collection_adapter:CollectionAdapter) -> None
Receive a 'collection dispose' event.
methodlib.sqlalchemy.orm.events.AttributeEvents.init_collection(target:_O, collection:Type[Collection[Any]], collection_adapter:CollectionAdapter) -> None
Receive a 'collection init' event.
methodlib.sqlalchemy.orm.events.AttributeEvents.init_scalar(target:_O, value:_T, dict_:Dict[Any, Any]) -> None
Receive a scalar "init" event.
methodlib.sqlalchemy.orm.events.AttributeEvents.modified(target:_O, initiator:Event) -> None
Receive a 'modified' event.
methodlib.sqlalchemy.orm.events.AttributeEvents.remove(target:_O, value:_T, initiator:Event, *key:EventConstants=NO_KEY) -> None
Receive a collection remove event.
methodlib.sqlalchemy.orm.events.AttributeEvents.set(target:_O, value:_T, oldvalue:_T, initiator:Event) -> None
Receive a scalar set event.
classlib.sqlalchemy.orm.events.InstanceEvents
Define events specific to object lifecycle.
methodlib.sqlalchemy.orm.events.InstanceEvents.init(target:_O, args:Any, kwargs:Any) -> None
Receive an instance when its constructor is called.
classlib.sqlalchemy.orm.events.InstrumentationEvents
Events related to class instrumentation events.
methodlib.sqlalchemy.orm.events.InstrumentationEvents.attribute_instrument(cls:ClassManager[_O], key:_KT, inst:_O) -> None
Called when an attribute is instrumented.
methodlib.sqlalchemy.orm.events.InstrumentationEvents.class_instrument(cls:ClassManager[_O]) -> None
Called after the given class is instrumented.
methodlib.sqlalchemy.orm.events.InstrumentationEvents.class_uninstrument(cls:ClassManager[_O]) -> None
Called before the given class is uninstrumented.
classlib.sqlalchemy.orm.events.MapperEvents
Define events specific to mappings.
classlib.sqlalchemy.orm.events.SessionEvents
Define events specific to :class:`.Session` lifecycle.
methodlib.sqlalchemy.orm.events.SessionEvents.after_attach(session:Session, instance:_O) -> None
Execute after an instance is attached to a session.
methodlib.sqlalchemy.orm.events.SessionEvents.after_commit(session:Session) -> None
Execute after a commit has occurred.
methodlib.sqlalchemy.orm.events.SessionEvents.after_rollback(session:Session) -> None
Execute after a real DBAPI rollback has occurred.
methodlib.sqlalchemy.orm.events.SessionEvents.before_attach(session:Session, instance:_O) -> None
Execute before an instance is attached to a session.
methodlib.sqlalchemy.orm.events.SessionEvents.before_commit(session:Session) -> None
Execute before commit is called.
methodlib.sqlalchemy.orm.events.SessionEvents.before_flush(session:Session, flush_context:UOWTransaction, instances:Optional[Sequence[_O]]) -> None
Execute before flush process has started.
classlib.sqlalchemy.orm.exc.FlushError
A invalid condition was detected during flush().
classlib.sqlalchemy.orm.exc.LoaderStrategyException
A loader strategy for an attribute does not exist.
classlib.sqlalchemy.orm.exc.UnmappedClassError
An mapping operation was requested for an unknown class.
classlib.sqlalchemy.orm.exc.UnmappedColumnError
Mapping operation was requested on an unknown column.
classlib.sqlalchemy.orm.exc.UnmappedError
Base for exceptions that involve expected mappings not present.
classlib.sqlalchemy.orm.exc.UnmappedInstanceError
An mapping operation was requested for an unknown instance.
classlib.sqlalchemy.orm.instrumentation.ClassManager
Tracks state information at the class level.
methodlib.sqlalchemy.orm.instrumentation.ClassManager.has_parent(state:InstanceState[_O], key:str, optimistic:bool=False) -> bool
TODO
classlib.sqlalchemy.orm.instrumentation.InstrumentationFactory
Factory for new ClassManager instances.
classlib.sqlalchemy.orm.interfaces.MapperOption
Describe a modification to a Query
methodlib.sqlalchemy.orm.interfaces.MapperOption.process_query(query:Query[Any]) -> None
Apply a modification to the given :class:`_query.Query`.
classlib.sqlalchemy.orm.interfaces.PropComparator
Defines SQL operations for ORM mapped attributes.
classlib.sqlalchemy.orm.mapped_collection.KeyFuncDict
Base for ORM mapped dictionary classes.
methodlib.sqlalchemy.orm.mapper.Mapper.add_property(key:str, prop:Union[Column[Any], MapperProperty[Any]]) -> None
Add an individual MapperProperty to this mapper.
methodlib.sqlalchemy.orm.mapper.Mapper.c() -> ReadOnlyColumnCollection[str, Column[Any]]
A synonym for :attr:`_orm.Mapper.columns`.
methodlib.sqlalchemy.orm.mapper.Mapper.entity()
Part of the inspection API.
methodlib.sqlalchemy.orm.mapper.Mapper.get_property(key:str, _configure_mappers:bool=False) -> MapperProperty[Any]
return a MapperProperty associated with the given key.
methodlib.sqlalchemy.orm.mapper.Mapper.isa(other:Mapper[Any]) -> bool
Return True if the this mapper inherits from the given mapper.
methodlib.sqlalchemy.orm.mapper.Mapper.mapper() -> Mapper[_O]
Part of the inspection API.
funclib.sqlalchemy.orm.mapper.reconstructor(fn:_Fn) -> _Fn
Decorate a method as the 'reconstructor' hook.
classlib.sqlalchemy.orm.path_registry.PathRegistry
Represent query load paths and registry functions.
classlib.sqlalchemy.orm.path_registry.PathToken
cacheable string token
classlib.sqlalchemy.orm.properties.MappedColumn
Maps a single :class:`_schema.Column` on a class.
classlib.sqlalchemy.orm.query.BulkDelete
BulkUD which handles DELETEs.
classlib.sqlalchemy.orm.query.BulkUD
State used for the orm.Query version of update() / delete().
classlib.sqlalchemy.orm.query.BulkUpdate
BulkUD which handles UPDATEs.
classlib.sqlalchemy.orm.query.Query
ORM-level SQL construction object.
methodlib.sqlalchemy.orm.query.Query.autoflush(setting:bool) -> Self
Return a Query with a specific 'autoflush' setting.
methodlib.sqlalchemy.orm.query.Query.enable_assertions(value:bool) -> Self
Control whether assertions are generated.
methodlib.sqlalchemy.orm.query.Query.enable_eagerloads(value:bool) -> Self
Control whether or not eager joins and subqueries are rendered.

About this data

These signatures were extracted from the public source of sqlalchemy/sqlalchemy using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries