sqlalchemy.dialects.oracle.oracledb.OracleDialect_oracledb

class documentation

class OracleDialect_oracledb(_OracleDialect_cx_oracle): (source)

View In Hierarchy

Undocumented

Class Method import_dbapi Import the DBAPI module that is used by this dialect.
Class Method is_thin_mode Undocumented
Method __init__ Undocumented
Class Variable driver identifying name for the dialect's DBAPI
Class Variable supports_statement_cache indicates if this dialect supports caching.
Instance Variable oracledb_ver Undocumented
Method _load_version Undocumented

Inherited from OracleDialect_cx_oracle:

Method create_connect_args Build DB-API compatible connection arguments.
Method create_xid create a two-phase transaction ID.
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_executemany Provide an implementation of ``cursor.executemany(statement, parameters)``.
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 do_set_input_sizes invoke the cursor.setinputsizes() method with appropriate arguments
Method get_isolation_level Given a DBAPI connection, return its isolation level.
Method get_isolation_level_values return a sequence of string isolation level names that are accepted by this dialect.
Method initialize Called during strategized creation of the dialect with a connection.
Method is_disconnect Return True if the given DB-API error indicates an invalid connection
Method on_connect return a callable which sets up a newly created DBAPI connection.
Method set_isolation_level Given a DBAPI connection, set its isolation level.
Class Variable delete_executemany_returning dialect supports DELETE..RETURNING with executemany.
Class Variable insert_executemany_returning dialect / driver / database supports some means of providing INSERT...RETURNING support when dialect.do_executemany() is used.
Class Variable supports_sane_multi_rowcount Indicate whether the dialect properly implements rowcount for ``UPDATE`` and ``DELETE`` statements when executed via executemany.
Class Variable supports_sane_rowcount Indicate whether the dialect properly implements rowcount for ``UPDATE`` and ``DELETE`` statements.
Class Variable update_executemany_returning dialect supports UPDATE..RETURNING with executemany.
Instance Variable arraysize Undocumented
Instance Variable auto_convert_lobs Undocumented
Instance Variable coerce_to_decimal Undocumented
Instance Variable colspecs A dictionary of TypeEngine classes from sqlalchemy.types mapped to subclasses that are specific to the dialect class. This dictionary is class-level only and is not accessed from the dialect instance itself.
Instance Variable cx_oracle_ver Undocumented
Instance Variable encoding_errors Undocumented
Instance Variable include_set_input_sizes set of DBAPI type objects that should be included in automatic cursor.setinputsizes() calls.
Method _detect_decimal Undocumented
Method _detect_decimal_char Undocumented
Method _generate_connection_outputtype_handler establish the default outputtypehandler established at the connection level.
Method _get_server_version_info Retrieve the server version info from the given connection.
Instance Variable _cursor_var_unicode_kwargs Undocumented
Instance Variable _cx_oracle_threaded Undocumented
Instance Variable _decimal_char Undocumented
Instance Variable _paramval Undocumented
Instance Variable _to_decimal Undocumented

Inherited from OracleDialect (via OracleDialect_cx_oracle):

Method denormalize_schema_name Undocumented
Method do_release_savepoint Release the named savepoint on a connection.
Method get_check_constraints Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_columns Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_default_isolation_level Given a DBAPI connection, return its isolation level, or a default isolation level if one cannot be retrieved.
Method get_foreign_keys Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_indexes Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_materialized_view_names Supported kw arguments are: ``dblink`` to reflect via a db link.
Method get_multi_check_constraints Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_multi_columns Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_multi_foreign_keys Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_multi_indexes Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_multi_pk_constraint Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_multi_table_comment Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_multi_table_options Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_multi_unique_constraints Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_pk_constraint Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_schema_names Supported kw arguments are: ``dblink`` to reflect via a db link.
Method get_sequence_names Supported kw arguments are: ``dblink`` to reflect via a db link.
Method get_table_comment Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_table_names Supported kw arguments are: ``dblink`` to reflect via a db link.
Method get_table_options Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_temp_table_names Supported kw arguments are: ``dblink`` to reflect via a db link.
Method get_unique_constraints Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_view_definition Supported kw arguments are: ``dblink`` to reflect via a db link; ``oracle_resolve_synonyms`` to resolve names to synonyms
Method get_view_names Supported kw arguments are: ``dblink`` to reflect via a db link.
Method has_sequence Supported kw arguments are: ``dblink`` to reflect via a db link.
Method has_table Supported kw arguments are: ``dblink`` to reflect via a db link.
Class Variable construct_arguments Optional set of argument specifiers for various SQLAlchemy constructs, typically schema items.
Class Variable cte_follows_insert target database, when given a CTE with an INSERT statement, needs the CTE to be below the INSERT
Class Variable default_paramstyle Undocumented
Class Variable delete_returning if the dialect supports RETURNING with DELETE
Class Variable div_is_floordiv target database treats the / division operator as "floor division"
Class Variable insert_returning if the dialect supports RETURNING with INSERT
Class Variable max_identifier_length The maximum length of identifier names.
Class Variable name identifying name for the dialect from a DBAPI-neutral point of view (i.e. 'sqlite')
Class Variable postfetch_lastrowid Undocumented
Class Variable reflection_options Sequence of string names indicating keyword arguments that can be established on a :class:`.Table` object which will be passed as "reflection options" when using :paramref:`.Table.autoload_with`.
Class Variable requires_name_normalize Undocumented
Class Variable sequences_optional If True, indicates if the :paramref:`_schema.Sequence.optional` parameter on the :class:`_schema.Sequence` construct should signal to not generate a CREATE SEQUENCE. Applies only to dialects that support sequences...
Class Variable supports_alter ``True`` if the database supports ``ALTER TABLE`` - used only for generating foreign key constraints in certain circumstances
Class Variable supports_comments Indicates the dialect supports comment DDL on tables and columns.
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_sequences Indicates if the dialect supports CREATE SEQUENCE or similar.
Class Variable supports_simple_order_by_label target database supports ORDER BY <labelname>, where <labelname> refers to a label in the columns clause of the SELECT
Class Variable update_returning if the dialect supports RETURNING with UPDATE
Instance Variable enable_offset_fetch Undocumented
Instance Variable exclude_tablespaces Undocumented
Instance Variable optimize_limits Undocumented
Instance Variable supports_identity_columns target database supports IDENTITY
Instance Variable use_ansi Undocumented
Method _all_objects_query Undocumented
Method _check_max_identifier_length Perform a connection / server version specific check to determine the max_identifier_length.
Method _column_query Undocumented
Method _comment_query Undocumented
Method _constraint_query Undocumented
Method _execute_reflection Undocumented
Method _get_all_constraint_rows Undocumented
Method _get_all_objects Undocumented
Method _get_default_schema_name Return the string name of the currently selected schema from the given connection.
Method _get_effective_compat_server_version_info Undocumented
Method _get_indexes_rows Undocumented
Method _get_synonyms Undocumented
Method _handle_synonyms Undocumented
Method _handle_synonyms_decorator Undocumented
Method _index_query Undocumented
Method _list_dblinks Undocumented
Method _parse_identity_options Undocumented
Method _prepare_filter_names Undocumented
Method _run_batches Undocumented
Method _table_options_query Undocumented
Method _value_or_raise Undocumented
Instance Variable _supports_offset_fetch Undocumented
Instance Variable _use_nchar_for_unicode Undocumented
Property _has_table_query Undocumented
Property _is_oracle_8 Undocumented
Property _supports_char_length Undocumented
Property _supports_except_all Undocumented
Property _supports_table_compress_for Undocumented
Property _supports_table_compression Undocumented
Property _supports_update_returning_computed_cols Undocumented

Inherited from DefaultDialect (via OracleDialect_cx_oracle, OracleDialect):

Class Method get_pool_class Undocumented
Class Method load_provisioning set up the provision.py module for this dialect.
Method connect Establish a connection using this dialect's DBAPI.
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_ping ping the DBAPI connection and return True if the connection is usable.
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 do_terminate Provide an implementation of ``connection.close()`` that tries as much as possible to not block, given a DBAPI connection.
Method get_dialect_pool_class return a Pool class to use for a given URL
Method get_driver_connection Returns the connection object as returned by the external driver package.
Method has_index Check the existence of a particular index name in the database.
Method has_schema Check the existence of a particular schema 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 set_connection_execution_options Establish execution options for a given connection.
Method set_engine_execution_options Establish execution options for a given engine.
Method type_descriptor Provide a database-specific :class:`.TypeEngine` object, given the generic object which comes from the types module.
Method validate_identifier Undocumented
Class Variable connection_characteristics Undocumented
Class Variable default_metavalue_token for INSERT... VALUES (DEFAULT) syntax, the token to put in the parenthesis.
Class Variable default_sequence_base the default value that will be rendered as the "START WITH" portion of a CREATE SEQUENCE DDL statement.
Class Variable delete_returning_multifrom if the dialect supports RETURNING with DELETE..FROM
Class Variable engine_config_types a mapping of string keys that can be in an engine config linked to type conversion functions.
Class Variable exclude_set_input_sizes set of DBAPI type objects that should be excluded in automatic cursor.setinputsizes() calls.
Class Variable favor_returning_over_lastrowid for backends that support both a lastrowid and a RETURNING insert strategy, favor RETURNING for simple single-int pk inserts.
Class Variable has_terminate Whether or not this dialect has a separate "terminate" implementation that does not block or require awaiting.
Class Variable inline_comments Indicates the dialect supports comment DDL that's inline with the definition of a Table or Column. If False, this implies that ALTER must be used to set table and column comments.
Class Variable insert_null_pk_still_autoincrements Undocumented
Class Variable insertmanyvalues_max_parameters Alternate to insertmanyvalues_page_size, will additionally limit page size based on number of parameters total in the statement.
Class Variable is_async Whether or not this dialect is intended for asyncio use.
Class Variable isolation_level 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 preexecute_autoincrement_sequences True if 'implicit' primary key functions must be executed separately in order to get their value, if RETURNING is not used.
Class Variable server_side_cursors deprecated; indicates if the dialect should attempt to use server side cursors by default
Class Variable supports_constraint_comments Indicates if the dialect supports comment DDL on constraints.
Class Variable supports_for_update_of Undocumented
Class Variable supports_is_distinct_from Undocumented
Class Variable supports_multivalues_insert Target database supports INSERT...VALUES with multiple value sets, i.e. INSERT INTO table (cols) VALUES (...), (...), (...), ...
Class Variable supports_native_decimal indicates if Decimal objects are handled and returned for precision numeric types, or if floats are returned
Class Variable supports_native_enum Indicates if the dialect supports a native ENUM construct. This will prevent :class:`_types.Enum` from generating a CHECK constraint when that type is used in "native" mode.
Class Variable supports_native_uuid indicates if Python UUID() objects are handled natively by the driver for SQL UUID datatypes.
Class Variable supports_schemas Undocumented
Class Variable supports_server_side_cursors indicates if the dialect supports server side cursors
Class Variable supports_views Undocumented
Class Variable tuple_in_values target database supports tuple IN, i.e. (x, y) IN ((q, p), (r, z))
Class Variable update_returning_multifrom if the dialect supports RETURNING with UPDATE..FROM
Class Variable use_insertmanyvalues_wo_returning if True, and use_insertmanyvalues is also True, INSERT statements that don't include RETURNING will also use "insertmanyvalues".
Instance Variable bind_typing Undocumented
Instance Variable compiler_linting Undocumented
Instance Variable dbapi A reference to the DBAPI module object itself.
Instance Variable default_isolation_level the isolation that is implicitly present on new connections
Instance Variable default_schema_name the name of the default schema. This value is only available for supporting dialects, and is typically populated during the initial connection to the database.
Instance Variable identifier_preparer This element will refer to an instance of :class:`.IdentifierPreparer` once a :class:`.DefaultDialect` has been constructed.
Instance Variable insertmanyvalues_page_size Number of rows to render into an individual INSERT..VALUES() statement for :attr:`.ExecuteStyle.INSERTMANYVALUES` executions.
Instance Variable label_length optional user-defined max length for SQL labels
Instance Variable paramstyle the paramstyle to be used (some DB-APIs support multiple paramstyles).
Instance Variable positional True if the paramstyle for this Dialect is positional.
Instance Variable server_version_info a tuple containing a version number for the DB backend in use.
Instance Variable supports_native_boolean Indicates if the dialect supports a native boolean construct. This will prevent :class:`_types.Boolean` from generating a CHECK constraint when that type is used.
Instance Variable type_compiler legacy; this is a TypeCompiler class at the class level, a TypeCompiler instance at the instance level.
Instance Variable type_compiler_instance instance of a :class:`.Compiled` class used to compile SQL type objects
Instance Variable use_insertmanyvalues if True, indicates "insertmanyvalues" functionality should be used to allow for ``insert_executemany_returning`` behavior, if possible.
Property dialect_description Undocumented
Property full_returning Undocumented
Property loaded_dbapi same as .dbapi, but is never None; will raise an error if no DBAPI was set up.
Property supports_sane_rowcount_returning True if this dialect supports sane rowcount even if RETURNING is in use.
Method _assert_and_set_isolation_level Undocumented
Method _builtin_onconnect Undocumented
Method _default_multi_reflect Undocumented
Method _deliver_insertmanyvalues_batches convert executemany parameters for an INSERT into an iterator of statement/single execute values, used by the insertmanyvalues feature.
Method _do_ping_w_event Undocumented
Method _ensure_has_table_connection Undocumented
Method _gen_allowed_isolation_levels Undocumented
Method _overrides_default Undocumented
Method _reset_characteristics Undocumented
Method _set_connection_characteristics Undocumented
Class Variable _legacy_binary_type_literal_encoding Undocumented
Instance Variable _ischema Undocumented
Instance Variable _on_connect_isolation_level Undocumented
Instance Variable _user_defined_max_identifier_length Undocumented
Property _bind_typing_render_casts Undocumented
Property _dialect_specific_select_one Undocumented
Property _supports_statement_cache internal evaluation for supports_statement_cache
Property _type_memos Undocumented

Inherited from Dialect (via OracleDialect_cx_oracle, OracleDialect, DefaultDialect):

Class Method engine_created A convenience hook called before returning the final :class:`_engine.Engine`.
Class Method get_async_dialect_cls Given a URL, return the :class:`.Dialect` that will be used by an async engine.
Class Method get_dialect_cls Given a URL, return the :class:`.Dialect` that will be used.
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 ddl_compiler a :class:`.Compiled` class used to compile DDL statements
Class Variable dispatch Undocumented
Class Variable execute_sequence_format either the 'tuple' or 'list' type, depending on what cursor.execute() accepts for the second argument (they vary).
Class Variable execution_ctx_cls a :class:`.ExecutionContext` class used to handle statement execution
Class Variable preparer a :class:`.IdentifierPreparer` class used to quote identifiers.
Class Variable statement_compiler a :class:`.Compiled` class used to compile SQL statements
Class Variable type_compiler_cls a :class:`.Compiled` class used to compile SQL type objects
Class Variable _has_events Undocumented
@classmethod
def import_dbapi(cls): (source)
overrides sqlalchemy.dialects.oracle.cx_oracle.OracleDialect_cx_oracle.import_dbapi

Import the DBAPI module that is used by this dialect. The Python module object returned here will be assigned as an instance variable to a constructed dialect under the name ``.dbapi``. .. versionchanged:: 2.0 The :meth:`.Dialect.import_dbapi` class method is renamed from the previous method ``.Dialect.dbapi()``, which would be replaced at dialect instantiation time by the DBAPI module itself, thus using the same name in two different ways. If a ``.Dialect.dbapi()`` classmethod is present on a third-party dialect, it will be used and a deprecation warning will be emitted.

@classmethod
def is_thin_mode(cls, connection): (source)

Undocumented

def __init__(self, auto_convert_lobs=True, coerce_to_decimal=True, arraysize=50, encoding_errors=None, thick_mode=None, **kwargs): (source)
overrides sqlalchemy.dialects.oracle.cx_oracle.OracleDialect_cx_oracle.__init__

Undocumented

driver: str = (source)
overrides sqlalchemy.dialects.oracle.cx_oracle.OracleDialect_cx_oracle.driver

identifying name for the dialect's DBAPI

supports_statement_cache: bool = (source)
overrides sqlalchemy.dialects.oracle.cx_oracle.OracleDialect_cx_oracle.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. .. versionadded:: 1.4.5 .. seealso:: :ref:`engine_thirdparty_caching`

oracledb_ver = (source)

Undocumented

def _load_version(self, dbapi_module): (source)
overrides sqlalchemy.dialects.oracle.cx_oracle.OracleDialect_cx_oracle._load_version

Undocumented