python-oracledb API reference

89 public APIs from python-oracledb (oracle/python-oracledb) — 5 classes, 7 functions, 77 methods. Signatures extracted by static analysis of the actual source.

Repository: oracle/python-oracledb

Kind	Count
Classes	5
Functions	7
Methods	77

API list

methodsrc.oracledb.aq.AsyncQueue.enqmany(messages:list['MessageProperties']) -> None

Enqueues multiple messages into the queue.

methodsrc.oracledb.aq.AsyncQueue.enqone(message:'MessageProperties') -> None

Enqueues a single message into the queue.

methodsrc.oracledb.aq.Queue.deqMany(max_num_messages:int) -> list['MessageProperties']

Deprecated: use deqmany() instead.

methodsrc.oracledb.aq.Queue.deqOne() -> MessageProperties | None

Deprecated: use deqone() instead.

methodsrc.oracledb.aq.Queue.enqMany(messages:list['MessageProperties']) -> None

Deprecated: use enqmany() instead.

methodsrc.oracledb.aq.Queue.enqOne(message:'MessageProperties') -> None

Deprecated: use enqone() instead.

methodsrc.oracledb.aq.Queue.enqmany(messages:list['MessageProperties']) -> None

Enqueues multiple messages into the queue.

methodsrc.oracledb.aq.Queue.enqone(message:'MessageProperties') -> None

Enqueues a single message into the queue.

method

src.oracledb.connection.AsyncConnection.begin_sessionless_transaction(transaction_id:str | bytes | None=None, timeout:int=60, defer_round_trip:bool=False) -> bytes

Begins a new sessionless transaction.

method

src.oracledb.connection.AsyncConnection.callproc(name:str, parameters:list | tuple | None=None, keyword_parameters:dict | None=None) -> list

Calls a PL/SQL procedure with the given name.

methodsrc.oracledb.connection.AsyncConnection.close() -> None

Closes the connection.

methodsrc.oracledb.connection.AsyncConnection.commit() -> None

Commits any pending transaction to the database.

methodsrc.oracledb.connection.AsyncConnection.execute(statement:str, parameters:list | tuple | dict | None=None) -> None

Executes a statement against the database.

methodsrc.oracledb.connection.AsyncConnection.gettype(name:str) -> DbObjectType

Returns a type object given its name.

methodsrc.oracledb.connection.AsyncConnection.rollback() -> None

Rolls back any pending transaction.

methodsrc.oracledb.connection.AsyncConnection.tpc_commit(xid:Xid | None=None, one_phase:bool=False) -> None

Commits a global transaction.

methodsrc.oracledb.connection.AsyncConnection.tpc_end(xid:Xid | None=None, flags:int=oracledb.TPC_END_NORMAL) -> None

Ends or suspends work on a global transaction.

methodsrc.oracledb.connection.AsyncConnection.tpc_prepare(xid:Xid | None=None) -> bool

Prepares a two-phase transaction for commit.

methodsrc.oracledb.connection.AsyncConnection.tpc_rollback(xid:Xid | None=None) -> None

Rolls back a global transaction.

methodsrc.oracledb.connection.BaseConnection.cancel() -> None

Breaks a long-running statement.

methodsrc.oracledb.connection.Connection.begin(format_id:int=-1, transaction_id:str='', branch_id:str='') -> None

Explicitly begins a new transaction.

method

src.oracledb.connection.Connection.begin_sessionless_transaction(transaction_id:str | bytes | None=None, timeout:int=60, defer_round_trip:bool=False) -> bytes

Begins a new sessionless transaction.

methodsrc.oracledb.connection.Connection.callTimeout() -> int

Deprecated.

methodsrc.oracledb.connection.Connection.commit() -> None

Commits any pending transactions to the database.

methodsrc.oracledb.connection.Connection.gettype(name:str) -> DbObjectType

Returns a type object given its name.

methodsrc.oracledb.connection.Connection.maxBytesPerCharacter() -> int

Deprecated.

methodsrc.oracledb.connection.Connection.ping() -> None

Pings the database to verify if the connection is valid.

methodsrc.oracledb.connection.Connection.rollback() -> None

Rolls back any pending transactions.

methodsrc.oracledb.connection.Connection.shutdown(mode:int=0) -> None

Shuts down the database.

methodsrc.oracledb.connection.Connection.startup(force:bool=False, restrict:bool=False, pfile:str | None=None) -> None

Starts up the database.

methodsrc.oracledb.connection.Connection.tpc_commit(xid:Xid | None=None, one_phase:bool=False) -> None

Commits a global transaction.

methodsrc.oracledb.connection.Connection.tpc_end(xid:Xid | None=None, flags:int=oracledb.TPC_END_NORMAL) -> None

Ends or suspends work on a global transaction.

methodsrc.oracledb.connection.Connection.tpc_prepare(xid:Xid | None=None) -> bool

Prepares a two-phase transaction for commit.

funcsrc.oracledb.constructors.Binary(value:Any) -> bytes

Constructs an object holding a binary (long) string value.

funcsrc.oracledb.constructors.Date(year:int, month:int, day:int) -> datetime.date

Constructs an object holding a date value.

func

src.oracledb.constructors.Timestamp(year:int, month:int, day:int, hour:int=0, minute:int=0, second:int=0) -> datetime.datetime

Constructs an object holding a time stamp value.

method

src.oracledb.cursor.AsyncCursor.callproc(name:str, parameters:list | tuple | None=None, keyword_parameters:dict | None=None) -> list

Calls a PL/SQL procedure with the given name.

methodsrc.oracledb.dataframe.DataFrame.num_columns() -> int

Returns the number of columns in the data frame.

methodsrc.oracledb.dataframe.DataFrame.num_rows() -> int

Returns the number of rows in the data frame.

classsrc.oracledb.driver_mode.DriverModeManager

Manages the mode the driver is using.

classsrc.oracledb.exceptions.ProgrammingError

Exception raised for programming errors.

classsrc.oracledb.exceptions.Warning

Exception raised for warnings.

classsrc.oracledb.fetch_info.FetchInfo

Identifies metadata of columns that are being fetched.

methodsrc.oracledb.pipeline.Pipeline.add_commit() -> PipelineOp

Adds an operation that performs a commit.

func

src.oracledb.plugins.aws_config_provider.config_awss3_hook(protocol:str, protocol_arg:str, connect_params:oracledb.ConnectParams) -> None

Hook for handling parameters stored in AWS S3.

method

src.oracledb.pool.AsyncConnectionPool.release(connection:'connection_module.AsyncConnection', tag:str | None=None) -> None

Releases the connection back to the pool now.

methodsrc.oracledb.pool_params.PoolParams.copy() -> 'PoolParams'

Creates a copy of the parameters and returns it.

methodsrc.oracledb.pool_params.PoolParams.getmode() -> oracledb.PoolGetMode

How pool.acquire() will behave.

funcsrc.oracledb.secret_values.clear_all_secrets(*thread_local:bool=False) -> None

Clears all secrets stored in the cache.

funcsrc.oracledb.secret_values.get_secret(key:Any, *thread_local:bool=False) -> SecretValue | None

Returns a secret stored in the cache.

classsrc.oracledb.sparse_vector.SparseVector

Provides information about sparse vectors.

methodsrc.oracledb.sparse_vector.SparseVector.values() -> array.array

Returns the non-zero values stored in the vector.

methodsrc.oracledb.subscr.Message.consumerName() -> str | None

Deprecated.

methodsrc.oracledb.subscr.Message.queueName() -> str | None

Deprecated.

methodsrc.oracledb.subscr.Subscription.ipAddress() -> str

Deprecated.

funcsrc.oracledb.utils.normalize_sessionless_transaction_id(value:bytes | str | None=None) -> bytes

Normalize and validate the transaction_id.

methodsrc.oracledb.var.Var.actualElements() -> int

Deprecated.

methodsrc.oracledb.var.Var.bufferSize() -> int

Deprecated.

methodsrc.oracledb.var.Var.getvalue(pos:int=0) -> Any

Returns the value at the given position in the variable.

methodsrc.oracledb.var.Var.numElements() -> int

Deprecated.

methodsrc.oracledb.var.Var.setvalue(pos:int, value:Any) -> None

Sets the value at the given position in the variable.

methodsrc.oracledb.var.Var.size() -> int

This read-only attribute returns the size of the variable.

method

utils.templates.connection.AsyncConnection.begin_sessionless_transaction(transaction_id:str | bytes | None=None, timeout:int=60, defer_round_trip:bool=False) -> bytes

Begins a new sessionless transaction.

method

utils.templates.connection.AsyncConnection.callproc(name:str, parameters:list | tuple | None=None, keyword_parameters:dict | None=None) -> list

Calls a PL/SQL procedure with the given name.

methodutils.templates.connection.AsyncConnection.close() -> None

Closes the connection.

methodutils.templates.connection.AsyncConnection.commit() -> None

Commits any pending transaction to the database.

methodutils.templates.connection.AsyncConnection.execute(statement:str, parameters:list | tuple | dict | None=None) -> None

Executes a statement against the database.

methodutils.templates.connection.AsyncConnection.gettype(name:str) -> DbObjectType

Returns a type object given its name.

methodutils.templates.connection.AsyncConnection.rollback() -> None

Rolls back any pending transaction.

methodutils.templates.connection.AsyncConnection.tpc_commit(xid:Xid | None=None, one_phase:bool=False) -> None

Commits a global transaction.

methodutils.templates.connection.AsyncConnection.tpc_end(xid:Xid | None=None, flags:int=oracledb.TPC_END_NORMAL) -> None

Ends or suspends work on a global transaction.

methodutils.templates.connection.AsyncConnection.tpc_prepare(xid:Xid | None=None) -> bool

Prepares a two-phase transaction for commit.

methodutils.templates.connection.AsyncConnection.tpc_rollback(xid:Xid | None=None) -> None

Rolls back a global transaction.

methodutils.templates.connection.BaseConnection.cancel() -> None

Breaks a long-running statement.

methodutils.templates.connection.Connection.begin(format_id:int=-1, transaction_id:str='', branch_id:str='') -> None

Explicitly begins a new transaction.

method

utils.templates.connection.Connection.begin_sessionless_transaction(transaction_id:str | bytes | None=None, timeout:int=60, defer_round_trip:bool=False) -> bytes

Begins a new sessionless transaction.

methodutils.templates.connection.Connection.callTimeout() -> int

Deprecated.

methodutils.templates.connection.Connection.commit() -> None

Commits any pending transactions to the database.

methodutils.templates.connection.Connection.gettype(name:str) -> DbObjectType

Returns a type object given its name.

methodutils.templates.connection.Connection.maxBytesPerCharacter() -> int

Deprecated.

methodutils.templates.connection.Connection.rollback() -> None

Rolls back any pending transactions.

methodutils.templates.connection.Connection.shutdown(mode:int=0) -> None

Shuts down the database.

methodutils.templates.connection.Connection.startup(force:bool=False, restrict:bool=False, pfile:str | None=None) -> None

Starts up the database.

methodutils.templates.connection.Connection.tpc_commit(xid:Xid | None=None, one_phase:bool=False) -> None

Commits a global transaction.

methodutils.templates.connection.Connection.tpc_end(xid:Xid | None=None, flags:int=oracledb.TPC_END_NORMAL) -> None

Ends or suspends work on a global transaction.

methodutils.templates.connection.Connection.tpc_prepare(xid:Xid | None=None) -> bool

Prepares a two-phase transaction for commit.

method

utils.templates.pool.AsyncConnectionPool.release(connection:'connection_module.AsyncConnection', tag:str | None=None) -> None

Releases the connection back to the pool now.

methodutils.templates.pool_params.PoolParams.copy() -> 'PoolParams'

Creates a copy of the parameters and returns it.

methodutils.templates.pool_params.PoolParams.set()

All parameters are optional.

About this data

These signatures were extracted from the public source of oracle/python-oracledb 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