sqlalchemy.dialects.postgresql.asyncpg.PGDialect_asyncpg

class documentation

class PGDialect_asyncpg(PGDialect):

View In Hierarchy

Undocumented

Class Method dbapi Undocumented
Class Method get​_pool​_class Undocumented
Method ​_invalidate​_schema​_cache Undocumented
Method create​_connect​_args Build DB-API compatible connection arguments.
Method do​_set​_input​_sizes invoke the cursor.setinputsizes() method with appropriate arguments
Method get​_deferrable Undocumented
Method get​_driver​_connection Returns the connection object as returned by the external driver package.
Method get​_readonly Undocumented
Method is​_disconnect Return True if the given DB-API error indicates an invalid connection
Method on​_connect on_connect for asyncpg
Method set​_deferrable Undocumented
Method set​_isolation​_level Given a DBAPI connection, set its isolation level.
Method set​_readonly Undocumented
Async Method setup​_asyncpg​_json​_codec set up JSON codec for asyncpg.
Async Method setup​_asyncpg​_jsonb​_codec set up JSONB codec for asyncpg.
Class Variable colspecs Undocumented
Class Variable default​_paramstyle Undocumented
Class Variable driver Undocumented
Class Variable is​_async Undocumented
Class Variable supports​_sane​_multi​_rowcount Undocumented
Class Variable supports​_server​_side​_cursors Undocumented
Class Variable supports​_statement​_cache indicates if this dialect supports caching.
Class Variable supports​_unicode​_binds Undocumented
Class Variable supports​_unicode​_statements Undocumented
Class Variable use​_native​_uuid Undocumented
Class Variable use​_setinputsizes Undocumented
Instance Variable ​_invalidate​_schema​_cache​_asof Undocumented
Property ​_dbapi​_version Undocumented
Property ​_isolation​_lookup Undocumented

Inherited from PGDialect:

Method __init__ Undocumented
Method ​_get​_column​_info Undocumented
Method ​_get​_default​_schema​_name Return the string name of the currently selected schema from the given connection.
Method ​_get​_foreign​_table​_names Undocumented
Method ​_get​_server​_version​_info Retrieve the server version info from the given connection.
Method ​_load​_domains Undocumented
Method ​_load​_enums Undocumented
Method ​_pg​_index​_any Undocumented
Method do​_begin​_twophase Begin a two phase transaction on the given connection.
Method do​_commit​_twophase Commit a two phase transaction on the given connection.
Method do​_prepare​_twophase Prepare a two phase transaction on the given connection.
Method do​_recover​_twophase Recover list of uncommitted prepared two phase transaction identifiers on the given connection.
Method do​_rollback​_twophase Rollback a two phase transaction on the given connection.
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​_isolation​_level Given a DBAPI connection, return its isolation level.
Method get​_pk​_constraint Return information about the primary key constraint on table_name`.
Method get​_schema​_names Undocumented
Method get​_sequence​_names Return a list of all sequence names available in the database.
Method get​_table​_comment Return the "comment" for the table identified by table_name.
Method get​_table​_names Return a list of table names for schema.
Method get​_table​_oid Fetch the oid for schema.table_name.
Method get​_unique​_constraints Return information about unique constraints in table_name.
Method get​_view​_definition Return view definition.
Method get​_view​_names Return a list of all view names available in the database.
Method has​_schema Undocumented
Method has​_sequence Check the existence of a particular sequence in the database.
Method has​_table For internal dialect use, check the existence of a particular table in the database.
Method has​_type Undocumented
Method initialize Called during strategized creation of the dialect with a connection.
Class Variable connection​_characteristics Undocumented
Class Variable construct​_arguments Optional set of argument specifiers for various SQLAlchemy constructs, typically schema items.
Class Variable max​_identifier​_length Undocumented
Class Variable name Undocumented
Class Variable postfetch​_lastrowid Undocumented
Class Variable preexecute​_autoincrement​_sequences Undocumented
Class Variable reflection​_options Undocumented
Class Variable sequences​_optional Undocumented
Class Variable supports​_alter Undocumented
Class Variable supports​_comments Undocumented
Class Variable supports​_default​_metavalue dialect supports INSERT... VALUES (DEFAULT) syntax
Class Variable supports​_default​_values dialect supports INSERT... DEFAULT VALUES syntax
Class Variable supports​_empty​_insert dialect supports INSERT () VALUES ()
Class Variable supports​_multivalues​_insert Undocumented
Class Variable supports​_native​_boolean Undocumented
Class Variable supports​_sane​_rowcount Undocumented
Class Variable supports​_sequences Undocumented
Instance Variable ​_backslash​_escapes Undocumented
Instance Variable ​_json​_deserializer Undocumented
Instance Variable ​_json​_serializer Undocumented
Instance Variable ​_supports​_create​_index​_concurrently Undocumented
Instance Variable ​_supports​_drop​_index​_concurrently Undocumented
Instance Variable full​_returning Undocumented
Instance Variable implicit​_returning Undocumented
Instance Variable isolation​_level Undocumented
Instance Variable supports​_identity​_columns Undocumented
Instance Variable supports​_native​_enum Undocumented
Instance Variable supports​_smallserial Undocumented

Inherited from DefaultDialect (via PGDialect):

Class Method load​_provisioning set up the provision.py module for this dialect.
Method connect Establish a connection using this dialect's DBAPI.
Method create​_xid Create a random two-phase transaction ID.
Method denormalize​_name convert the given name to a case insensitive identifier for the backend if it is an all-lowercase name.
Method do​_begin Provide an implementation of connection.begin(), given a DB-API connection.
Method do​_close Provide an implementation of connection.close(), given a DBAPI connection.
Method do​_commit Provide an implementation of connection.commit(), given a DB-API connection.
Method do​_execute Provide an implementation of cursor.execute(statement, parameters).
Method do​_execute​_no​_params Provide an implementation of cursor.execute(statement).
Method do​_executemany Provide an implementation of cursor.executemany(statement, parameters).
Method do​_release​_savepoint Release the named savepoint on a connection.
Method do​_rollback Provide an implementation of connection.rollback(), given a DB-API connection.
Method do​_rollback​_to​_savepoint Rollback a connection to the named savepoint.
Method do​_savepoint Create a savepoint with the given name.
Method get​_default​_isolation​_level Given a DBAPI connection, return its isolation level, or a default isolation level if one cannot be retrieved.
Method has​_index Check the existence of a particular index name in the database.
Method normalize​_name convert the given name to lowercase if it is detected as case insensitive.
Method reset​_isolation​_level Given a DBAPI connection, revert its isolation to the default.
Method type​_descriptor Provide a database-specific .TypeEngine object, given the generic object which comes from the types module.
Class Variable dbapi​_exception​_translation​_map mapping used in the extremely unusual case that a DBAPI's published exceptions don't actually have the __name__ that they are linked towards.
Instance Variable returns​_unicode​_strings Undocumented
Instance Variable type​_compiler Undocumented
Method ​_check​_max​_identifier​_length Perform a connection / server version specific check to determine the max_identifier_length.
Method ​_check​_unicode​_description Undocumented
Method ​_check​_unicode​_returns Undocumented
Method ​_ensure​_has​_table​_connection Undocumented
Method ​_reset​_characteristics Undocumented
Method ​_set​_connection​_characteristics Undocumented
Method do​_ping Undocumented
Method get​_dialect​_pool​_class Undocumented
Method set​_connection​_execution​_options Undocumented
Method set​_engine​_execution​_options Undocumented
Method validate​_identifier Undocumented
Class Variable cte​_follows​_insert Undocumented
Class Variable default​_sequence​_base Undocumented
Class Variable engine​_config​_types Undocumented
Class Variable inline​_comments Undocumented
Class Variable insert​_executemany​_returning Undocumented
Class Variable max​_constraint​_name​_length Undocumented
Class Variable max​_index​_name​_length Undocumented
Class Variable non​_native​_boolean​_check​_constraint Undocumented
Class Variable requires​_name​_normalize Undocumented
Class Variable server​_side​_cursors Undocumented
Class Variable supports​_for​_update​_of Undocumented
Class Variable supports​_is​_distinct​_from Undocumented
Class Variable supports​_native​_decimal Undocumented
Class Variable supports​_schemas Undocumented
Class Variable supports​_simple​_order​_by​_label Undocumented
Class Variable supports​_views Undocumented
Class Variable tuple​_in​_values Undocumented
Instance Variable ​_decoder Undocumented
Instance Variable ​_description​_decoder Undocumented
Instance Variable ​_encoder Undocumented
Instance Variable ​_ischema Undocumented
Instance Variable ​_user​_defined​_max​_identifier​_length Undocumented
Instance Variable case​_sensitive Undocumented
Instance Variable compiler​_linting Undocumented
Instance Variable convert​_unicode Undocumented
Instance Variable default​_isolation​_level Undocumented
Instance Variable default​_schema​_name Undocumented
Instance Variable description​_encoding Undocumented
Instance Variable encoding Undocumented
Instance Variable identifier​_preparer Undocumented
Instance Variable label​_length Undocumented
Instance Variable paramstyle Undocumented
Instance Variable positional Undocumented
Instance Variable server​_version​_info Undocumented
Property ​_dialect​_specific​_select​_one Undocumented
Property ​_supports​_statement​_cache Undocumented
Property ​_type​_memos Undocumented
Property dialect​_description Undocumented
Property supports​_sane​_rowcount​_returning True if this dialect supports sane rowcount even if RETURNING is in use.

Inherited from Dialect (via PGDialect, DefaultDialect):

Class Method engine​_created A convenience hook called before returning the final _engine.Engine.
Class Method get​_dialect​_cls Given a URL, return the .Dialect that will be used.
Method get​_temp​_table​_names Return a list of temporary table names on the given connection, if supported by the underlying backend.
Method get​_temp​_view​_names Return a list of temporary view names on the given connection, if supported by the underlying backend.
Method on​_connect​_url return a callable which sets up a newly created DBAPI connection.
Class Variable ​_has​_events Undocumented
@classmethod
def dbapi(cls):
overrides sqlalchemy.engine.default.DefaultDialect.dbapi

Undocumented

@classmethod
def get_pool_class(cls, url):
overrides sqlalchemy.engine.default.DefaultDialect.get_pool_class

Undocumented

def _invalidate_schema_cache(self):

Undocumented

def create_connect_args(self, url):
overrides sqlalchemy.engine.default.DefaultDialect.create_connect_args

Build DB-API compatible connection arguments.

Given a .URL object, returns a tuple consisting of a (*args, **kwargs) suitable to send directly to the dbapi's connect function. The arguments are sent to the .Dialect.connect method which then runs the DBAPI-level connect() function.

The method typically makes use of the .URL.translate_connect_args method in order to generate a dictionary of options.

The default implementation is:

def create_connect_args(self, url):
    opts = url.translate_connect_args()
    opts.update(url.query)
    return [[], opts]

See Also

.URL.translate_connect_args

Parameters
urla .URL object
Returns
a tuple of (*args, **kwargs) which will be passed to the .Dialect.connect method.
def do_set_input_sizes(self, cursor, list_of_tuples, context):
overrides sqlalchemy.engine.interfaces.Dialect.do_set_input_sizes

invoke the cursor.setinputsizes() method with appropriate arguments

This hook is called if the dialect.use_inputsizes flag is set to True. Parameter data is passed in a list of tuples (paramname, dbtype, sqltype), where paramname is the key of the parameter in the statement, dbtype is the DBAPI datatype and sqltype is the SQLAlchemy type. The order of tuples is in the correct parameter order.

New in version 1.4.
def get_deferrable(self, connection):
overrides sqlalchemy.databases.postgresql.PGDialect.get_deferrable

Undocumented

def get_driver_connection(self, connection):
overrides sqlalchemy.engine.default.DefaultDialect.get_driver_connection

Returns the connection object as returned by the external driver package.

For normal dialects that use a DBAPI compliant driver this call will just return the connection passed as argument. For dialects that instead adapt a non DBAPI compliant driver, like when adapting an asyncio driver, this call will return the connection-like object as returned by the driver.

New in version 1.4.24.
def get_readonly(self, connection):
overrides sqlalchemy.databases.postgresql.PGDialect.get_readonly

Undocumented

def is_disconnect(self, e, connection, cursor):
overrides sqlalchemy.engine.default.DefaultDialect.is_disconnect
Return True if the given DB-API error indicates an invalid connection
def on_connect(self):
overrides sqlalchemy.databases.postgresql.PGDialect.on_connect

on_connect for asyncpg

A major component of this for asyncpg is to set up type decoders at the asyncpg level.

See https://github.com/MagicStack/asyncpg/issues/623 for notes on JSON/JSONB implementation.

def set_deferrable(self, connection, value):
overrides sqlalchemy.databases.postgresql.PGDialect.set_deferrable

Undocumented

def set_isolation_level(self, connection, level):
overrides sqlalchemy.databases.postgresql.PGDialect.set_isolation_level

Given a DBAPI connection, set its isolation level.

Note that this is a dialect-level method which is used as part of the implementation of the _engine.Connection and _engine.Engine isolation level facilities; these APIs should be preferred for most typical use cases.

See Also

_engine.Connection.get_isolation_level - view current level

_engine.Connection.default_isolation_level - view default level

:paramref:`.Connection.execution_options.isolation_level` - set per _engine.Connection isolation level

:paramref:`_sa.create_engine.isolation_level` - set per _engine.Engine isolation level

def set_readonly(self, connection, value):
overrides sqlalchemy.databases.postgresql.PGDialect.set_readonly

Undocumented

async def setup_asyncpg_json_codec(self, conn):

set up JSON codec for asyncpg.

This occurs for all new connections and can be overridden by third party dialects.

New in version 1.4.27.
async def setup_asyncpg_jsonb_codec(self, conn):

set up JSONB codec for asyncpg.

This occurs for all new connections and can be overridden by third party dialects.

New in version 1.4.27.
colspecs =
overrides sqlalchemy.databases.postgresql.PGDialect.colspecs

Undocumented

default_paramstyle: str =
overrides sqlalchemy.databases.postgresql.PGDialect.default_paramstyle

Undocumented

driver: str =

Undocumented

is_async: bool =
overrides sqlalchemy.engine.default.DefaultDialect.is_async

Undocumented

supports_sane_multi_rowcount: bool =
overrides sqlalchemy.engine.default.DefaultDialect.supports_sane_multi_rowcount

Undocumented

supports_server_side_cursors: bool =
overrides sqlalchemy.engine.default.DefaultDialect.supports_server_side_cursors

Undocumented

supports_statement_cache: bool =
overrides sqlalchemy.databases.postgresql.PGDialect.supports_statement_cache

indicates if this dialect supports caching.

All dialects that are compatible with statement caching should set this flag to True directly on each dialect class and subclass that supports it. SQLAlchemy tests that this flag is locally present on each dialect subclass before it will use statement caching. This is to provide safety for legacy or new dialects that are not yet fully tested to be compliant with SQL statement caching.

New in version 1.4.5.

See Also

:ref:`engine_thirdparty_caching`

supports_unicode_binds: bool =
overrides sqlalchemy.engine.default.DefaultDialect.supports_unicode_binds

Undocumented

supports_unicode_statements: bool =
overrides sqlalchemy.engine.default.DefaultDialect.supports_unicode_statements

Undocumented

use_native_uuid: bool =

Undocumented

use_setinputsizes: bool =
overrides sqlalchemy.engine.default.DefaultDialect.use_setinputsizes

Undocumented

_invalidate_schema_cache_asof =

Undocumented

@util.memoized_property
_dbapi_version =

Undocumented

@util.memoized_property
_isolation_lookup =
overrides sqlalchemy.databases.postgresql.PGDialect._isolation_lookup

Undocumented