Welcome to python-oracledb’s documentation

The python-oracledb driver is an open source Python module that enables access to Oracle Database. Python-oracledb is the renamed, major version successor to cx_Oracle 8.3. The cx_Oracle driver is obsolete and should not be used for new development.

You can use assistive technology products, such as screen readers, while you work with the python-oracledb documentation. You can also use the keyboard instead of the mouse.

User Guide

• 1. Introduction to the Python Driver for Oracle Database
  • 1.1. Getting Started
  • 1.2. Architecture
    • 1.2.1. python-oracledb Thin Mode Architecture
    • 1.2.2. python-oracledb Thick Mode Architecture
  • 1.3. Feature Highlights of python-oracledb
• 2. Installing python-oracledb
  • 2.1. Quick Start python-oracledb Installation
  • 2.2. Supported Oracle Database Versions
  • 2.3. Installation Requirements
  • 2.4. Installing python-oracledb on Linux
    • 2.4.1. Install python-oracledb
    • 2.4.2. Optionally Install Oracle Client
  • 2.5. Installing python-oracledb on Windows
    • 2.5.1. Install python-oracledb
    • 2.5.2. Optionally Install Oracle Client
  • 2.6. Installing python-oracledb on macOS
    • 2.6.1. Install python-oracledb
    • 2.6.2. Optionally Install Oracle Client
    • 2.6.3. Configure Oracle Instant Client
  • 2.7. Installing python-oracledb without Internet Access
  • 2.8. Installing python-oracledb without the Cryptography Package
  • 2.9. Installing from Source Code
    • 2.9.1. Building a python-oracledb package locally
    • 2.9.2. Building python-oracledb packages using GitHub Actions
  • 2.10. Installing Centralized Configuration Provider Modules for python-oracledb
    • 2.10.1. Install Modules for the OCI Object Storage Centralized Configuration Provider
    • 2.10.2. Install Modules for the Azure App Centralized Configuration Provider
  • 2.11. Installing Cloud Native Authentication Modules for python-oracledb
    • 2.11.1. Install Modules for the OCI Cloud Native Authentication Plugin
    • 2.11.2. Install Modules for the Azure Cloud Native Authentication Plugin
• 3. Initializing python-oracledb
  • 3.1. Enabling python-oracledb Thick mode
    • 3.1.1. Enabling python-oracledb Thick Mode on Windows
    • 3.1.2. Enabling python-oracledb Thick Mode on macOS
    • 3.1.3. Enabling python-oracledb Thick Mode on Linux and Related Platforms
    • 3.1.4. Tracing Oracle Client Library Loading
  • 3.2. Explicitly Enabling python-oracledb Thin Mode
  • 3.3. Optional Oracle Configuration Files
    • 3.3.1. Optional Oracle Net Configuration Files
    • 3.3.2. Optional Oracle Client Configuration File
    • 3.3.3. Using Optional Oracle Configuration Files
  • 3.4. Oracle Environment Variables for python-oracledb
  • 3.5. Other python-oracledb Thick Mode Initialization
  • 3.6. Migrating from python-oracledb Thick Mode to python-oracledb Thin Mode
• 4. Connecting to Oracle Database
  • 4.1. Standalone Connections
    • 4.1.1. Creating a Standalone Connection
    • 4.1.2. Common Connection Errors
  • 4.2. Oracle Net Services Connection Strings
    • 4.2.1. Easy Connect Syntax for Connection Strings
    • 4.2.2. Connect Descriptors
    • 4.2.3. TNS Aliases for Connection Strings
    • 4.2.4. LDAP URL Connection Strings
    • 4.2.5. Centralized Configuration Provider URL Connection Strings
    • 4.2.6. JDBC and Oracle SQL Developer Connection Strings
    • 4.2.7. Oracle Net Connect Descriptor and Easy Connect Keywords
    • 4.2.8. Python-oracledb Parameters Settable in Easy Connect Strings or Central Configuration Providers
  • 4.3. Centralized Configuration Providers
    • 4.3.1. Using a File Centralized Configuration Provider
    • 4.3.2. Using an OCI Object Storage Centralized Configuration Provider
    • 4.3.3. Using an Azure App Centralized Configuration Provider
    • 4.3.4. Caching Configuration Information
  • 4.4. Using the ConnectParams Builder Class
  • 4.5. Connection Hook Functions
    • 4.5.1. Using Protocol Hook Functions
    • 4.5.2. Using Password Hook Functions
    • 4.5.3. Using Parameter Hook Functions
  • 4.6. LDAP Directory Naming
  • 4.7. Connection Metadata and Application Contexts
  • 4.8. Connection Pooling
    • 4.8.1. Creating a Connection Pool
    • 4.8.2. Using the Connection Pool Cache
    • 4.8.3. Connection Pool Sizing
    • 4.8.4. Pool Connection Health
    • 4.8.5. Connection Pool Reconfiguration
    • 4.8.6. Session Callbacks for Setting Pooled Connection State
    • 4.8.7. Heterogeneous and Homogeneous Connection Pools
    • 4.8.8. Using the PoolParams Builder Class
  • 4.9. Database Resident Connection Pooling (DRCP)
    • 4.9.1. Enabling DRCP in Oracle Database
    • 4.9.2. Coding Applications to use DRCP
    • 4.9.3. Monitoring DRCP
  • 4.10. Implicit Connection Pooling
  • 4.11. Connecting Using Proxy Authentication
  • 4.12. Connecting Using External Authentication
    • 4.12.1. Using an Oracle Wallet for External Authentication
    • 4.12.2. Operating System Authentication
  • 4.13. Token-Based Authentication
    • 4.13.1. Connecting Using OAuth 2.0 Token-Based Authentication
    • 4.13.2. Connecting Using OCI IAM Token-Based Authentication
  • 4.14. Privileged Connections
  • 4.15. Securely Encrypting Network Traffic to Oracle Database
    • 4.15.1. Native Network Encryption
  • 4.16. Resetting Passwords
  • 4.17. Connecting to Oracle Cloud Autonomous Databases
    • 4.17.1. One-way TLS Connection to Oracle Autonomous Database
    • 4.17.2. Mutual TLS (mTLS) Connection to Oracle Autonomous Database
  • 4.18. Connecting Through a Firewall via a Proxy
  • 4.19. Connecting using Multiple Wallets
  • 4.20. Connecting to Oracle Globally Distributed Database
• 5. Executing SQL
  • 5.1. SQL Queries
    • 5.1.1. Fetch Methods
    • 5.1.2. Closing Cursors
    • 5.1.3. Query Column Metadata
    • 5.1.4. Fetch Data Types
    • 5.1.5. Changing Fetched Data
    • 5.1.6. Fetched Number Precision
    • 5.1.7. Scrollable Cursors
    • 5.1.8. Fetching Oracle Database Objects and Collections
    • 5.1.9. Fetching Data Frames
    • 5.1.10. Limiting Rows
    • 5.1.11. Fetching Data in Parallel
    • 5.1.12. Fetching Raw Data
    • 5.1.13. Querying Corrupt Data
  • 5.2. INSERT and UPDATE Statements
    • 5.2.1. Inserting NULLs
• 6. Executing PL/SQL
  • 6.1. PL/SQL Stored Procedures
  • 6.2. PL/SQL Stored Functions
  • 6.3. Anonymous PL/SQL Blocks
  • 6.4. Passing NULL values to PL/SQL
  • 6.5. Creating Stored Procedures and Packages
    • 6.5.1. PL/SQL Compilation Warnings
  • 6.6. Using the %ROWTYPE Attribute
  • 6.7. Using DBMS_OUTPUT
  • 6.8. Implicit Results
  • 6.9. Edition-Based Redefinition (EBR)
• 7. Using Bind Variables
  • 7.1. Binding by Name or Position
    • 7.1.1. Bind by Name
    • 7.1.2. Bind by Position
  • 7.2. Bind Direction
  • 7.3. Binding Null Values
  • 7.4. Binding ROWID Values
  • 7.5. Binding UROWID Values
  • 7.6. DML RETURNING Bind Variables
  • 7.7. LOB Bind Variables
  • 7.8. REF CURSOR Bind Variables
  • 7.9. Binding PL/SQL Collections
  • 7.10. Binding PL/SQL Records
  • 7.11. Binding Spatial Data Types
  • 7.12. Reducing the SQL Version Count
  • 7.13. Changing Bind Data Types using an Input Type Handler
  • 7.14. Binding Multiple Values to a SQL WHERE IN Clause
    • 7.14.1. Binding a Large Number of Items in an IN List
  • 7.15. Binding Column and Table Names
• 8. Executing Batch Statements and Bulk Loading
  • 8.1. Batch Execution of SQL
    • 8.1.1. Predefining Memory Areas
  • 8.2. Batch Execution of PL/SQL
  • 8.3. Handling Data Errors
  • 8.4. Identifying Affected Rows
  • 8.5. DML RETURNING
  • 8.6. Loading CSV Files into Oracle Database
  • 8.7. Copying Data between Databases
• 9. Managing Transactions
  • 9.1. Autocommitting
  • 9.2. Explicit Transactions
• 10. Tuning python-oracledb
  • 10.1. Tuning Fetch Performance
    • 10.1.1. Choosing values for arraysize and prefetchrows
    • 10.1.2. Tuning Fetching from REF CURSORS
    • 10.1.3. Tuning Fetching for DataFrames
  • 10.2. Database Round-trips
    • 10.2.1. Finding the Number of Round-Trips
  • 10.3. Statement Caching
    • 10.3.1. Setting the Statement Cache
    • 10.3.2. Tuning the Statement Cache
    • 10.3.3. Disabling the Statement Cache
  • 10.4. Client Result Caching (CRC)
• 11. Using CLOB, BLOB, NCLOB, and BFILE Data
  • 11.1. Simple Insertion of LOBs
  • 11.2. Fetching LOBs as Strings and Bytes
  • 11.3. Streaming LOBs (Read)
  • 11.4. Streaming LOBs (Write)
  • 11.5. Temporary LOBs
  • 11.6. Using BFILEs
• 12. Using JSON Data
  • 12.1. Using the Oracle Database JSON Type in python-oracledb
  • 12.2. Using JSON stored in BLOB, CLOB or VARCHAR2 columns
    • 12.2.1. Using OSON storage
  • 12.3. IN Bind Type Mapping
  • 12.4. Query and OUT Bind Type Mapping
  • 12.5. SQL/JSON Path Expressions
  • 12.6. Accessing Relational Data as JSON
  • 12.7. JSON-Relational Duality Views
• 13. Using XMLTYPE Data
• 14. Using VECTOR Data
  • 14.1. Using FLOAT32, FLOAT64, and INT8 Vectors
    • 14.1.1. Inserting FLOAT32, FLOAT64, and INT8 Vectors
    • 14.1.2. Fetching FLOAT32, FLOAT64, and INT8 Vectors
  • 14.2. Using BINARY Vectors
    • 14.2.1. Inserting BINARY Vectors
    • 14.2.2. Fetching BINARY Vectors
  • 14.3. Using SPARSE Vectors
    • 14.3.1. Inserting SPARSE Vectors
    • 14.3.2. Fetching Sparse Vectors
  • 14.4. Using python-oracledb Thick Mode with Older Versions of Oracle Client Libraries
    • 14.4.1. Inserting Vectors with Older Oracle Client Versions
    • 14.4.2. Fetching Vectors with Older Oracle Client Versions
  • 14.5. Using NumPy
    • 14.5.1. Inserting Vectors with NumPy
    • 14.5.2. Fetching Vectors with NumPy
• 15. Working with Simple Oracle Document Access (SODA)
  • 15.1. SODA Examples
  • 15.2. Using the SODA Metadata Cache
  • 15.3. Committing SODA Work
• 16. Using Oracle Transactional Event Queues and Advanced Queuing
  • 16.1. Creating a Queue
  • 16.2. Enqueuing Messages
  • 16.3. Dequeuing Messages
  • 16.4. Using Object Queues
  • 16.5. Using Recipient Lists
  • 16.6. Changing Queue and Message Options
  • 16.7. Bulk Enqueue and Dequeue
• 17. Working with Continuous Query Notification (CQN)
  • 17.1. Requirements
  • 17.2. Creating a Subscription
  • 17.3. Registering Queries
• 18. Using Two-Phase Commits (TPC)
• 19. Starting and Stopping Oracle Database
  • 19.1. Starting Oracle Database Up
  • 19.2. Shutting Oracle Database Down
• 20. Using High Availability with python-oracledb
  • 20.1. General HA Recommendations
  • 20.2. Network Configuration
  • 20.3. Fast Application Notification (FAN)
  • 20.4. Application Continuity (AC)
  • 20.5. Transaction Guard
• 21. Character Sets and Globalization
  • 21.1. Character Sets
    • 21.1.1. Database Character Set
    • 21.1.2. Database National Character Set
    • 21.1.3. Setting the Client Character Set
  • 21.2. Time Zone Files
    • 21.2.1. Finding the Time Zone Files in Use
    • 21.2.2. Changing the Oracle Client Time Zone File
  • 21.3. Setting the Client Locale
    • 21.3.1. Thick Mode Oracle Database National Language Support (NLS)
    • 21.3.2. Thin Mode Locale-aware Number and Date Conversions
    • 21.3.3. Inserting NVARCHAR2 and NCHAR Data
• 22. Concurrent Programming with asyncio and Pipelining
  • 22.1. Concurrent Programming with asyncio
    • 22.1.1. Connecting to Oracle Database Asynchronously
    • 22.1.2. Executing SQL Using Asynchronous Methods
    • 22.1.3. Managing Transactions Using Asynchronous Methods
  • 22.2. Pipelining Database Operations
    • 22.2.1. Using Pipelines
    • 22.2.2. Using OUT Binds with Pipelines
    • 22.2.3. Pipeline Error Handling
    • 22.2.4. Pipeline Cursor Usage
    • 22.2.5. Pipeline Round-trips
• 23. Catching Exceptions
  • 23.1. Error Handling in Thin and Thick Modes
• 24. Tracing python-oracledb
  • 24.1. Application Tracing
    • 24.1.1. Oracle Database End-to-End Tracing
    • 24.1.2. Debugging PL/SQL with the Java Debug Wire Protocol
    • 24.1.3. Low Level SQL Tracing
    • 24.1.4. Using Connection Identifiers
  • 24.2. Finding the python-oracledb Mode
  • 24.3. Database Views
    • 24.3.1. V$SESSION_CONNECT_INFO
    • 24.3.2. V$SESSION
  • 24.4. Low Level Python-oracledb Driver Tracing
• 25. Extending python-oracledb
  • 25.1. Subclassing Connections
  • 25.2. Python-oracledb Plugins
    • 25.2.1. Building Custom Plugins
  • 25.3. Connection Hooks
    • 25.3.1. Connection Protocol Hooks
    • 25.3.2. Connection Password Hooks
    • 25.3.3. Connection Parameter Hooks
• 26. Troubleshooting Errors
  • 26.1. Installation Errors
    • 26.1.1. “Not a supported wheel on this platform” Error
    • 26.1.2. Network Connection Error
    • 26.1.3. Upgrade to Latest Version Failed Without Any Errors
    • 26.1.4. “No module named pip” Error
    • 26.1.5. “fatal error: dpi.h: No such file or directory” Error
  • 26.2. Warning Messages
    • 26.2.1. Deprecated Python Version Warning
  • 26.3. Error Messages
    • 26.3.1. DPI Error Messages
    • 26.3.2. DPY Error Messages
    • 26.3.3. ORA Error Messages
• 27. Appendix A: Oracle Database Features Supported by python-oracledb
  • 27.1. Supported Oracle Database Data Types
• 28. Appendix B: Differences between python-oracledb Thin and Thick Modes
  • 28.1. Connection Handling Differences between Thin and Thick Modes
    • 28.1.1. Connections to a Local Database
    • 28.1.2. Oracle Net Services and Client Configuration Files
    • 28.1.3. Token Based Authentication
    • 28.1.4. Transport Layer Security (TLS) Support
    • 28.1.5. Native Network Encryption and Checksumming
  • 28.2. Connection Pooling Differences between Thin and Thick Modes
  • 28.3. Supported Database Data Types in Thin and Thick Modes
  • 28.4. Query Metadata in Thin and Thick Modes
  • 28.5. Implicit Results in Thin and Thick Modes
  • 28.6. Statement Caching in Thin and Thick Modes
  • 28.7. Error Handling in Thin and Thick Modes
  • 28.8. Globalization in Thin and Thick Modes
  • 28.9. Tracing in Thin and Thick Modes
• 29. Appendix C: The python-oracledb and cx_Oracle Drivers
  • 29.1. Differences between the python-oracledb and cx_Oracle Drivers
    • 29.1.1. Mode differences from cx_Oracle
    • 29.1.2. Oracle Client Library Loading Differences from cx_Oracle
    • 29.1.3. Connection Differences from cx_Oracle
    • 29.1.4. Pooling Differences from cx_Oracle
    • 29.1.5. Cursor Object Differences from cx_Oracle
    • 29.1.6. Fetching IS JSON Column Differences from cx_Oracle
    • 29.1.7. Advanced Queuing (AQ) Differences from cx_Oracle
    • 29.1.8. Error Handling Differences from cx_Oracle
  • 29.2. Upgrading from cx_Oracle 8.3 to python-oracledb
    • 29.2.1. Things to Know Before the Upgrade
    • 29.2.2. Steps to Upgrade to python-oracledb
    • 29.2.3. Code to Aid the Upgrade to python-oracledb
    • 29.2.4. Python Frameworks, SQL Generators, and ORMs

API Manual

• 1. API: python-oracledb Module
  • 1.1. Oracledb Methods
    • Binary()
    • clientversion()
    • connect()
    • connect_async()
    • ConnectParams()
    • create_pipeline()
    • create_pool()
    • create_pool_async()
    • Cursor()
    • Date()
    • DateFromTicks()
    • enable_thin_mode()
    • get_pool()
    • init_oracle_client()
    • is_thin_mode()
    • makedsn()
    • PoolParams()
    • SparseVector()
    • register_params_hook()
    • register_password_type()
    • register_protocol()
    • Time()
    • TimeFromTicks()
    • Timestamp()
    • TimestampFromTicks()
    • unregister_params_hook()
  • 1.2. Oracledb IntervalYM Class
  • 1.3. Oracledb JsonId Class
  • 1.4. Oracledb __future__ Object
  • 1.5. Oracledb Constants
    • 1.5.1. General
    • 1.5.2. Advanced Queuing: Delivery Modes
    • 1.5.3. Advanced Queuing: Dequeue Modes
    • 1.5.4. Advanced Queuing: Dequeue Navigation Modes
    • 1.5.5. Advanced Queuing: Dequeue Visibility Modes
    • 1.5.6. Advanced Queuing: Dequeue Wait Modes
    • 1.5.7. Advanced Queuing: Enqueue Visibility Modes
    • 1.5.8. Advanced Queuing: Message States
    • 1.5.9. Advanced Queuing: Other Constants
    • 1.5.10. Connection Authorization Modes
    • 1.5.11. Pipeline Operation Types
    • 1.5.12. Database Shutdown Modes
    • 1.5.13. Event Types
    • 1.5.14. Operation Codes
    • 1.5.15. Connection Pool Get Modes
    • 1.5.16. Connection Pool Purity Constants
    • 1.5.17. Subscription Grouping Classes
    • 1.5.18. Subscription Grouping Types
    • 1.5.19. Subscription Namespaces
    • 1.5.20. Subscription Protocols
    • 1.5.21. Subscription Quality of Service
    • 1.5.22. DB API Types
    • 1.5.23. Database Types
    • 1.5.24. Database Type Synonyms
    • 1.5.25. Other Types
    • 1.5.26. Two-Phase Commit (TPC) Constants
    • 1.5.27. Vector Format Constants
  • 1.6. Oracledb Exceptions
    • Warning
    • Error
    • InterfaceError
    • DatabaseError
    • DataError
    • OperationalError
    • IntegrityError
    • InternalError
    • ProgrammingError
    • NotSupportedError
  • 1.7. Oracledb _Error Objects
    • _Error.code
    • _Error.offset
    • _Error.full_code
    • _Error.message
    • _Error.context
    • _Error.isrecoverable
  • 1.8. Oracledb Plugins
    • 1.8.1. Oracle Cloud Infrastructure (OCI) Object Storage Configuration Provider Plugin
    • 1.8.2. Azure App Configuration Provider Plugin
    • 1.8.3. Oracle Cloud Infrastructure (OCI) Cloud Native Authentication Plugin
    • 1.8.4. Azure Cloud Native Authentication Plugin
• 2. API: Defaults Object
  • 2.1. Defaults Attributes
    • defaults.arraysize
    • defaults.config_dir
    • defaults.driver_name
    • defaults.fetch_decimals
    • defaults.fetch_lobs
    • defaults.machine
    • defaults.osuser
    • defaults.prefetchrows
    • defaults.program
    • defaults.stmtcachesize
    • defaults.terminal
    • defaults.thick_mode_dsn_passthrough
• 3. API: Connection Objects
  • 3.1. Connection Methods
    • Connection.__enter__()
    • Connection.__exit__()
    • Connection.begin()
    • Connection.cancel()
    • Connection.changepassword()
    • Connection.close()
    • Connection.commit()
    • Connection.createlob()
    • Connection.cursor()
    • Connection.decode_oson()
    • Connection.encode_oson()
    • Connection.fetch_df_all()
    • Connection.fetch_df_batches()
    • Connection.getSodaDatabase()
    • Connection.gettype()
    • Connection.is_healthy()
    • Connection.msgproperties()
    • Connection.ping()
    • Connection.prepare()
    • Connection.queue()
    • Connection.rollback()
    • Connection.shutdown()
    • Connection.startup()
    • Connection.subscribe()
    • Connection.tpc_begin()
    • Connection.tpc_commit()
    • Connection.tpc_end()
    • Connection.tpc_forget()
    • Connection.tpc_prepare()
    • Connection.tpc_recover()
    • Connection.tpc_rollback()
    • Connection.unsubscribe()
    • Connection.xid()
  • 3.2. Connection Attributes
    • Connection.action
    • Connection.autocommit
    • Connection.call_timeout
    • Connection.client_identifier
    • Connection.clientinfo
    • Connection.current_schema
    • Connection.db_domain
    • Connection.db_name
    • Connection.dbop
    • Connection.dsn
    • Connection.econtext_id
    • Connection.edition
    • Connection.external_name
    • Connection.handle
    • Connection.inputtypehandler
    • Connection.instance_name
    • Connection.internal_name
    • Connection.ltxid
    • Connection.max_identifier_length
    • Connection.max_open_cursors
    • Connection.module
    • Connection.outputtypehandler
    • Connection.proxy_user
    • Connection.sdu
    • Connection.serial_num
    • Connection.service_name
    • Connection.session_id
    • Connection.stmtcachesize
    • Connection.tag
    • Connection.thin
    • Connection.transaction_in_progress
    • Connection.username
    • Connection.version
    • Connection.warning
• 4. API: ConnectParams Objects
  • 4.1. ConnectParams Methods
    • ConnectParams.copy()
    • ConnectParams.get_connect_string()
    • ConnectParams.get_network_service_names()
    • ConnectParams.parse_connect_string()
    • ConnectParams.parse_dsn_with_credentials()
    • ConnectParams.set()
    • ConnectParams.set_from_config()
  • 4.2. ConnectParams Attributes
    • ConnectParams.appcontext
    • ConnectParams.cclass
    • ConnectParams.config_dir
    • ConnectParams.connection_id_prefix
    • ConnectParams.debug_jdwp
    • ConnectParams.disable_oob
    • ConnectParams.driver_name
    • ConnectParams.edition
    • ConnectParams.events
    • ConnectParams.expire_time
    • ConnectParams.externalauth
    • ConnectParams.extra_auth_params
    • ConnectParams.host
    • ConnectParams.https_proxy
    • ConnectParams.https_proxy_port
    • ConnectParams.instance_name
    • ConnectParams.machine
    • ConnectParams.matchanytag
    • ConnectParams.mode
    • ConnectParams.osuser
    • ConnectParams.pool_boundary
    • ConnectParams.port
    • ConnectParams.program
    • ConnectParams.protocol
    • ConnectParams.proxy_user
    • ConnectParams.purity
    • ConnectParams.retry_count
    • ConnectParams.retry_delay
    • ConnectParams.sdu
    • ConnectParams.server_type
    • ConnectParams.service_name
    • ConnectParams.shardingkey
    • ConnectParams.sid
    • ConnectParams.ssl_context
    • ConnectParams.ssl_server_cert_dn
    • ConnectParams.ssl_server_dn_match
    • ConnectParams.ssl_version
    • ConnectParams.stmtcachesize
    • ConnectParams.supershardingkey
    • ConnectParams.tag
    • ConnectParams.tcp_connect_timeout
    • ConnectParams.use_sni
    • ConnectParams.terminal
    • ConnectParams.thick_mode_dsn_passthrough
    • ConnectParams.use_tcp_fast_open
    • ConnectParams.user
    • ConnectParams.wallet_location
• 5. API: ConnectionPool Objects
  • 5.1. ConnectionPool Methods
    • ConnectionPool.acquire()
    • ConnectionPool.close()
    • ConnectionPool.drop()
    • ConnectionPool.reconfigure()
    • ConnectionPool.release()
  • 5.2. ConnectionPool Attributes
    • ConnectionPool.busy
    • ConnectionPool.dsn
    • ConnectionPool.getmode
    • ConnectionPool.homogeneous
    • ConnectionPool.increment
    • ConnectionPool.max
    • ConnectionPool.max_lifetime_session
    • ConnectionPool.max_sessions_per_shard
    • ConnectionPool.min
    • ConnectionPool.name
    • ConnectionPool.opened
    • ConnectionPool.ping_interval
    • ConnectionPool.soda_metadata_cache
    • ConnectionPool.stmtcachesize
    • ConnectionPool.thin
    • ConnectionPool.timeout
    • ConnectionPool.username
    • ConnectionPool.wait_timeout
• 6. API: PoolParams Objects
  • 6.1. PoolParams Methods
    • PoolParams.copy()
    • PoolParams.get_connect_string()
    • PoolParams.parse_connect_string()
    • PoolParams.set()
  • 6.2. PoolParams Attributes
    • PoolParams.connectiontype
    • PoolParams.getmode
    • PoolParams.homogeneous
    • PoolParams.increment
    • PoolParams.min
    • PoolParams.max
    • PoolParams.max_lifetime_session
    • PoolParams.max_sessions_per_shard
    • PoolParams.ping_interval
    • PoolParams.ping_timeout
    • PoolParams.session_callback
    • PoolParams.soda_metadata_cache
    • PoolParams.timeout
    • PoolParams.wait_timeout
• 7. API: Cursor Objects
  • 7.1. Cursor Methods
    • Cursor.__enter__()
    • Cursor.__exit__()
    • Cursor.__iter__()
    • Cursor.arrayvar()
    • Cursor.bindnames()
    • Cursor.callfunc()
    • Cursor.callproc()
    • Cursor.close()
    • Cursor.execute()
    • Cursor.executemany()
    • Cursor.fetchall()
    • Cursor.fetchmany()
    • Cursor.fetchone()
    • Cursor.getarraydmlrowcounts()
    • Cursor.getbatcherrors()
    • Cursor.getimplicitresults()
    • Cursor.parse()
    • Cursor.prepare()
    • Cursor.scroll()
    • Cursor.setinputsizes()
    • Cursor.setoutputsize()
    • Cursor.var()
  • 7.2. Cursor Attributes
    • Cursor.arraysize
    • Cursor.bindvars
    • Cursor.connection
    • Cursor.description
    • Cursor.fetchvars
    • Cursor.inputtypehandler
    • Cursor.lastrowid
    • Cursor.outputtypehandler
    • Cursor.prefetchrows
    • Cursor.rowcount
    • Cursor.rowfactory
    • Cursor.scrollable
    • Cursor.statement
    • Cursor.warning
• 8. API: Data Frames
  • 8.1. OracleDataFrame Objects
    • 8.1.1. OracleDataFrame Methods
    • 8.1.2. OracleDataFrame Attributes
  • 8.2. OracleArrowArray Objects
  • 8.3. OracleColumn Objects
    • 8.3.1. OracleColumn Methods
    • 8.3.2. OracleColumn Attributes
  • 8.4. OracleColumnBuffer Objects
    • 8.4.1. OracleColumnBuffer Attributes
• 9. API: FetchInfo Objects
  • 9.1. FetchInfo Attributes
    • FetchInfo.annotations
    • FetchInfo.display_size
    • FetchInfo.domain_name
    • FetchInfo.domain_schema
    • FetchInfo.internal_size
    • FetchInfo.is_json
    • FetchInfo.is_oson
    • FetchInfo.name
    • FetchInfo.null_ok
    • FetchInfo.precision
    • FetchInfo.scale
    • FetchInfo.type
    • FetchInfo.type_code
    • FetchInfo.vector_dimensions
    • FetchInfo.vector_format
    • FetchInfo.vector_is_sparse
• 10. API: Variable Objects
  • 10.1. Variable Methods
    • Variable.getvalue()
    • Variable.setvalue()
  • 10.2. Variable Attributes
    • Variable.actual_elements
    • Variable.buffer_size
    • Variable.convert_nulls
    • Variable.inconverter
    • Variable.num_elements
    • Variable.outconverter
    • Variable.size
    • Variable.type
    • Variable.values
• 11. API: Subscription Objects
  • 11.1. Subscription Methods
    • Subscription.registerquery()
  • 11.2. Subscription Attributes
    • Subscription.callback
    • Subscription.connection
    • Subscription.id
    • Subscription.ip_address
    • Subscription.name
    • Subscription.namespace
    • Subscription.operations
    • Subscription.port
    • Subscription.protocol
    • Subscription.qos
    • Subscription.timeout
    • 11.2.1. Message Objects
    • 11.2.2. MessageTable Objects
    • 11.2.3. MessageRow Objects
    • 11.2.4. MessageQuery Objects
• 12. API: LOB Objects
  • 12.1. LOB Methods
    • LOB.close()
    • LOB.fileexists()
    • LOB.getchunksize()
    • LOB.getfilename()
    • LOB.isopen()
    • LOB.open()
    • LOB.read()
    • LOB.setfilename()
    • LOB.size()
    • LOB.trim()
    • LOB.write()
  • 12.2. LOB Attributes
    • LOB.type
• 13. API: DbObjectType Objects
  • 13.1. DbObjectType Methods
    • DbObjectType()
    • DbObjectType.newobject()
  • 13.2. DbObjectType Attributes
    • DbObjectType.attributes
    • DbObjectType.element_type
    • DbObjectType.iscollection
    • DbObjectType.name
    • DbObjectType.package_name
    • DbObjectType.schema
  • 13.3. DbObject Objects
    • 13.3.1. DbObject Methods
    • 13.3.2. DbObject Attributes
  • 13.4. DbObjectAttribute Objects
    • DbObjectAttribute.max_size
    • DbObjectAttribute.name
    • DbObjectAttribute.precision
    • DbObjectAttribute.scale
    • DbObjectAttribute.type
• 14. API: SparseVector Objects
  • 14.1. SparseVector Attributes
    • SparseVector.indices
    • SparseVector.num_dimensions
    • SparseVector.values
• 15. API: Advanced Queuing (AQ)
  • 15.1. Queue Objects
    • 15.1.1. Queue Methods
    • 15.1.2. Queue Attributes
  • 15.2. Dequeue Options
    • DeqOptions.condition
    • DeqOptions.consumername
    • DeqOptions.correlation
    • DeqOptions.deliverymode
    • DeqOptions.mode
    • DeqOptions.msgid
    • DeqOptions.navigation
    • DeqOptions.transformation
    • DeqOptions.visibility
    • DeqOptions.wait
  • 15.3. Enqueue Options
    • EnqOptions.deliverymode
    • EnqOptions.transformation
    • EnqOptions.visibility
  • 15.4. Message Properties
    • MessageProperties.attempts
    • MessageProperties.correlation
    • MessageProperties.delay
    • MessageProperties.deliverymode
    • MessageProperties.enqtime
    • MessageProperties.exceptionq
    • MessageProperties.expiration
    • MessageProperties.msgid
    • MessageProperties.payload
    • MessageProperties.priority
    • MessageProperties.state
    • MessageProperties.recipients
• 16. API: SODA
  • 16.1. SODA Requirements
  • 16.2. SodaDatabase Objects
    • 16.2.1. SodaDatabase Methods
  • 16.3. SodaCollection Objects
    • 16.3.1. SodaCollection Methods
    • 16.3.2. SodaCollection Attributes
  • 16.4. SodaDoc Objects
    • 16.4.1. SodaDoc Methods
    • 16.4.2. SodaDoc Attributes
  • 16.5. SodaDocCursor Objects
    • 16.5.1. SodaDocCursor Methods
  • 16.6. SodaOperation Objects
    • 16.6.1. SodaOperation Methods
• 17. API: AsyncConnection Objects
  • 17.1. AsyncConnection Methods
    • AsyncConnection.__aenter__()
    • AsyncConnection.__aexit__()
    • AsyncConnection.callfunc()
    • AsyncConnection.callproc()
    • AsyncConnection.cancel()
    • AsyncConnection.changepassword()
    • AsyncConnection.close()
    • AsyncConnection.commit()
    • AsyncConnection.createlob()
    • AsyncConnection.cursor()
    • AsyncConnection.decode_oson()
    • AsyncConnection.encode_oson()
    • AsyncConnection.execute()
    • AsyncConnection.executemany()
    • AsyncConnection.fetch_df_all()
    • AsyncConnection.fetch_df_batches()
    • AsyncConnection.fetchall()
    • AsyncConnection.fetchmany()
    • AsyncConnection.fetchone()
    • AsyncConnection.gettype()
    • AsyncConnection.is_healthy()
    • AsyncConnection.msgproperties()
    • AsyncConnection.ping()
    • AsyncConnection.queue()
    • AsyncConnection.rollback()
    • AsyncConnection.run_pipeline()
    • AsyncConnection.tpc_begin()
    • AsyncConnection.tpc_commit()
    • AsyncConnection.tpc_end()
    • AsyncConnection.tpc_forget()
    • AsyncConnection.tpc_prepare()
    • AsyncConnection.tpc_recover()
    • AsyncConnection.tpc_rollback()
  • 17.2. AsyncConnection Attributes
    • AsyncConnection.action
    • AsyncConnection.autocommit
    • AsyncConnection.call_timeout
    • AsyncConnection.client_identifier
    • AsyncConnection.clientinfo
    • AsyncConnection.current_schema
    • AsyncConnection.db_domain
    • AsyncConnection.db_name
    • AsyncConnection.dbop
    • AsyncConnection.dsn
    • AsyncConnection.econtext_id
    • AsyncConnection.edition
    • AsyncConnection.external_name
    • AsyncConnection.inputtypehandler
    • AsyncConnection.instance_name
    • AsyncConnection.internal_name
    • AsyncConnection.ltxid
    • AsyncConnection.max_identifier_length
    • AsyncConnection.max_open_cursors
    • AsyncConnection.module
    • AsyncConnection.outputtypehandler
    • AsyncConnection.sdu
    • AsyncConnection.serial_num
    • AsyncConnection.service_name
    • AsyncConnection.session_id
    • AsyncConnection.stmtcachesize
    • AsyncConnection.thin
    • AsyncConnection.transaction_in_progress
    • AsyncConnection.username
    • AsyncConnection.version
• 18. API: AsyncConnectionPool Objects
  • 18.1. AsyncConnectionPool Methods
    • AsyncConnectionPool.acquire()
    • AsyncConnectionPool.close()
    • AsyncConnectionPool.drop()
    • AsyncConnectionPool.release()
  • 18.2. AsyncConnectionPool Attributes
    • AsyncConnectionPool.busy
    • AsyncConnectionPool.dsn
    • AsyncConnectionPool.getmode
    • AsyncConnectionPool.homogeneous
    • AsyncConnectionPool.increment
    • AsyncConnectionPool.max
    • AsyncConnectionPool.max_lifetime_session
    • AsyncConnectionPool.max_sessions_per_shard
    • AsyncConnectionPool.min
    • AsyncConnectionPool.name
    • AsyncConnectionPool.opened
    • AsyncConnectionPool.ping_interval
    • AsyncConnectionPool.soda_metadata_cache
    • AsyncConnectionPool.stmtcachesize
    • AsyncConnectionPool.thin
    • AsyncConnectionPool.timeout
    • AsyncConnectionPool.username
    • AsyncConnectionPool.wait_timeout
• 19. API: AsyncCursor Objects
  • 19.1. AsyncCursor Methods
    • AsyncCursor.__aiter__()
    • AsyncCursor.__enter__()
    • AsyncCursor.__exit__()
    • AsyncCursor.arrayvar()
    • AsyncCursor.bindnames()
    • AsyncCursor.callfunc()
    • AsyncCursor.callproc()
    • AsyncCursor.close()
    • AsyncCursor.execute()
    • AsyncCursor.executemany()
    • AsyncCursor.fetchall()
    • AsyncCursor.fetchmany()
    • AsyncCursor.fetchone()
    • AsyncCursor.getarraydmlrowcounts()
    • AsyncCursor.getbatcherrors()
    • AsyncCursor.getimplicitresults()
    • AsyncCursor.parse()
    • AsyncCursor.prepare()
    • AsyncCursor.setinputsizes()
    • AsyncCursor.scroll()
    • AsyncCursor.setoutputsize()
    • AsyncCursor.var()
  • 19.2. AsyncCursor Attributes
    • AsyncCursor.arraysize
    • AsyncCursor.bindvars
    • AsyncCursor.description
    • AsyncCursor.fetchvars
    • AsyncCursor.inputtypehandler
    • AsyncCursor.lastrowid
    • AsyncCursor.outputtypehandler
    • AsyncCursor.prefetchrows
    • AsyncCursor.rowcount
    • AsyncCursor.rowfactory
    • AsyncCursor.scrollable
• 20. API: AsyncLOB Objects
  • 20.1. AsyncLOB Methods
    • AsyncLOB.close()
    • AsyncLOB.fileexists()
    • AsyncLOB.getchunksize()
    • AsyncLOB.getfilename()
    • AsyncLOB.isopen()
    • AsyncLOB.open()
    • AsyncLOB.read()
    • AsyncLOB.setfilename()
    • AsyncLOB.size()
    • AsyncLOB.trim()
    • AsyncLOB.write()
  • 20.2. AsyncLOB Attributes
    • AsyncLOB.type
• 21. API: Async Advanced Queuing (AQ)
  • 21.1. AsyncQueue Objects
    • 21.1.1. AsyncQueue Methods
    • 21.1.2. AsyncQueue Attributes
  • 21.2. Dequeue Options
  • 21.3. Enqueue Options
  • 21.4. Message Properties
• 22. API: Pipeline Objects
  • 22.1. Pipeline Objects
    • 22.1.1. Pipeline Methods
    • 22.1.2. Pipeline Attributes
  • 22.2. PipelineOp Objects
    • 22.2.1. PipelineOp Attributes
  • 22.3. PipelineOpResult Objects
    • 22.3.1. PipelineOpResult Attributes
• 23. Deprecated and Desupported Features

• python-oracledb Release Notes
• License

Indices and tables

• Index

• Module Index

• Search Page