Welcome to python-oracledb’s documentation

The python-oracledb driver is an open source Python module that enables access to Oracle Database with no extra libraries needed. The module is built with Cython for safety and speed. It is lightweight and high-performance. It is stable, well tested, and has comprehensive documentation. The module is maintained by Oracle.

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. Using python-oracledb Containers
  • 2.11. Installing Centralized Configuration Provider Modules for python-oracledb
    • 2.11.1. Install Modules for the OCI Object Storage Centralized Configuration Provider
    • 2.11.2. Install Modules for the Azure App Centralized Configuration Provider
  • 2.12. Installing Cloud Native Authentication Modules for python-oracledb
    • 2.12.1. Install Modules for the OCI Cloud Native Authentication Plugin
    • 2.12.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
  • 3.7. Changing python-oracledb Default Settings
• 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 Centralized Configuration Providers
  • 4.3. Authenticating to Oracle Database
  • 4.4. Centralized Configuration Providers
    • 4.4.1. Using a File Centralized Configuration Provider
    • 4.4.2. Using an OCI Object Storage Centralized Configuration Provider
    • 4.4.3. Using an Azure App Centralized Configuration Provider
    • 4.4.4. Caching Configuration Information
  • 4.5. Using the ConnectParams Builder Class
  • 4.6. Connection Hook Functions
    • 4.6.1. Using Protocol Hook Functions
    • 4.6.2. Using Password Hook Functions
    • 4.6.3. Using Parameter Hook Functions
  • 4.7. LDAP Directory Naming
  • 4.8. Connection Metadata and Application Contexts
  • 4.9. Connection Pooling
    • 4.9.1. Driver Connection Pooling
    • 4.9.2. Using the Connection Pool Cache
    • 4.9.3. Connection Pool Sizing
    • 4.9.4. Pool Connection Health
    • 4.9.5. Connection Pool Reconfiguration
    • 4.9.6. Session Callbacks for Setting Pooled Connection State
    • 4.9.7. Heterogeneous and Homogeneous Connection Pools
    • 4.9.8. Using the PoolParams Builder Class
  • 4.10. Database Resident Connection Pooling (DRCP)
    • 4.10.1. Enabling DRCP in Oracle Database
    • 4.10.2. Coding Applications to use DRCP
    • 4.10.3. Setting DRCP Parameters in Connection Strings
    • 4.10.4. Monitoring DRCP
  • 4.11. Implicit Connection Pooling
  • 4.12. Privileged Connections
  • 4.13. Securely Encrypting Network Traffic to Oracle Database
    • 4.13.1. Native Network Encryption
  • 4.14. Resetting Passwords
  • 4.15. Connecting to Oracle Cloud Autonomous Databases
    • 4.15.1. One-way TLS Connection to Oracle Autonomous Database
    • 4.15.2. Mutual TLS (mTLS) Connection to Oracle Autonomous Database
  • 4.16. Connecting Through a Firewall via a Proxy
  • 4.17. Connecting using Multiple Wallets
  • 4.18. Connecting to Oracle Globally Distributed Database
• 5. Authentication Options
  • 5.1. Database Authentication
  • 5.2. Proxy Authentication
  • 5.3. External Authentication
    • 5.3.1. Using an Oracle Wallet for External Authentication
    • 5.3.2. Operating System Authentication
  • 5.4. Token-Based Authentication
    • 5.4.1. OCI IAM Token-Based Authentication
    • 5.4.2. OAuth 2.0 Token-Based Authentication
  • 5.5. Instance Principal Authentication
  • 5.6. Authentication Methods for Centralized Configuration Providers
    • 5.6.1. OCI Object Storage Configuration Provider Authentication Methods
    • 5.6.2. Azure App Configuration Provider Authentication Methods
• 6. Executing SQL
  • 6.1. SQL Queries
    • 6.1.1. Fetch Methods
    • 6.1.2. Closing Cursors
    • 6.1.3. Query Column Metadata
    • 6.1.4. Fetch Data Types
    • 6.1.5. Changing Fetched Data
    • 6.1.6. Fetched Number Precision
    • 6.1.7. Scrollable Cursors
    • 6.1.8. Fetching Oracle Database Objects and Collections
    • 6.1.9. Limiting Rows
    • 6.1.10. Fetching Data in Parallel
    • 6.1.11. Fetching Raw Data
    • 6.1.12. Querying Corrupt Data
  • 6.2. INSERT and UPDATE Statements
    • 6.2.1. Inserting NULLs
• 7. Executing PL/SQL
  • 7.1. PL/SQL Stored Procedures
  • 7.2. PL/SQL Stored Functions
  • 7.3. Anonymous PL/SQL Blocks
  • 7.4. Passing NULL values to PL/SQL
  • 7.5. Creating Stored Procedures and Packages
    • 7.5.1. PL/SQL Compilation Warnings
  • 7.6. Using the %ROWTYPE Attribute
  • 7.7. Using DBMS_OUTPUT
  • 7.8. Implicit Results
  • 7.9. Edition-Based Redefinition (EBR)
• 8. Using Bind Variables
  • 8.1. Binding by Name or Position
    • 8.1.1. Bind by Name
    • 8.1.2. Bind by Position
  • 8.2. Duplicate Bind Variable Placeholders
  • 8.3. Bind Direction
  • 8.4. Binding Null Values
  • 8.5. Binding ROWID Values
  • 8.6. Binding UROWID Values
  • 8.7. DML RETURNING Bind Variables
  • 8.8. LOB Bind Variables
  • 8.9. REF CURSOR Bind Variables
  • 8.10. Binding PL/SQL Collections
  • 8.11. Binding PL/SQL Records
  • 8.12. Binding Spatial Data Types
  • 8.13. Reducing the SQL Version Count
  • 8.14. Changing Bind Data Types using an Input Type Handler
  • 8.15. Binding Multiple Values to a SQL WHERE IN Clause
    • 8.15.1. Binding a Large Number of Items in an IN List
  • 8.16. Binding Column and Table Names
• 9. Batch Statement and Bulk Copy Operations
  • 9.1. Batch Statement Execution
    • 9.1.1. Batch Execution of SQL
    • 9.1.2. Predefining Memory Areas
    • 9.1.3. Batching of Large Datasets
    • 9.1.4. Batch Execution of PL/SQL
    • 9.1.5. Handling Data Errors
    • 9.1.6. Identifying Affected Rows
    • 9.1.7. DML RETURNING
  • 9.2. Bulk Copy Operations
    • 9.2.1. Loading CSV Files into Oracle Database
    • 9.2.2. Creating CSV Files from Oracle Database
    • 9.2.3. Bulk Copying Data between Databases
  • 9.3. Direct Path Loads
    • 9.3.1. Batching of Direct Path Loads
  • 9.4. Memoptimized Rowstore
• 10. Managing Transactions
  • 10.1. Autocommitting
  • 10.2. Explicit Transactions
  • 10.3. Distributed Transactions
  • 10.4. Sessionless Transactions
    • 10.4.1. Starting Sessionless Transactions
    • 10.4.2. Suspending Sessionless Transactions
    • 10.4.3. Resuming Sessionless Transactions
    • 10.4.4. Committing or Rolling Back Sessionless Transactions
    • 10.4.5. Example of Using Sessionless Transactions
    • 10.4.6. Viewing Sessionless Transactions
• 11. Tuning python-oracledb
  • 11.1. Tuning Fetch Performance
    • 11.1.1. Choosing values for arraysize and prefetchrows
    • 11.1.2. Tuning Fetching from REF CURSORS
    • 11.1.3. Tuning Fetching for Data Frames
    • 11.1.4. Parallelizing Data Fetches from a Single Table
  • 11.2. Database Round-trips
    • 11.2.1. Finding the Number of Round-Trips
  • 11.3. Statement Caching
    • 11.3.1. Setting the Statement Cache
    • 11.3.2. Tuning the Statement Cache
    • 11.3.3. Disabling the Statement Cache
  • 11.4. Client Result Caching (CRC)
• 12. Using CLOB, BLOB, NCLOB, and BFILE Data
  • 12.1. Simple Insertion of LOBs
  • 12.2. Fetching LOBs as Strings and Bytes
  • 12.3. Streaming LOBs (Read)
  • 12.4. Streaming LOBs (Write)
  • 12.5. Temporary LOBs
  • 12.6. Using BFILEs
• 13. Using JSON Data
  • 13.1. Using the Oracle Database JSON Type in python-oracledb
  • 13.2. Using JSON stored in BLOB, CLOB or VARCHAR2 columns
    • 13.2.1. Using OSON storage
  • 13.3. IN Bind Type Mapping
  • 13.4. Query and OUT Bind Type Mapping
  • 13.5. SQL/JSON Path Expressions
  • 13.6. Accessing Relational Data as JSON
  • 13.7. JSON-Relational Duality Views
• 14. Using XMLTYPE Data
• 15. Using VECTOR Data
  • 15.1. Using FLOAT32, FLOAT64, and INT8 Vectors
    • 15.1.1. Inserting FLOAT32, FLOAT64, and INT8 Vectors
    • 15.1.2. Fetching FLOAT32, FLOAT64, and INT8 Vectors
  • 15.2. Using BINARY Vectors
    • 15.2.1. Inserting BINARY Vectors
    • 15.2.2. Fetching BINARY Vectors
  • 15.3. Using SPARSE Vectors
    • 15.3.1. Inserting SPARSE Vectors
    • 15.3.2. Fetching Sparse Vectors
  • 15.4. VECTOR Metadata
  • 15.5. Using python-oracledb Thick Mode with Older Versions of Oracle Client Libraries
    • 15.5.1. Inserting Vectors with Older Oracle Client Versions
    • 15.5.2. Fetching Vectors with Older Oracle Client Versions
  • 15.6. Using NumPy
    • 15.6.1. Inserting Vectors with NumPy
    • 15.6.2. Fetching Vectors with NumPy
• 16. Working with Data Frames
  • 16.1. Fetching Data Frames
    • 16.1.1. Data Frame Queries
    • 16.1.2. Data Frame Type Mapping
    • 16.1.3. Converting python-oracledb’s DataFrame to Other Data Frames
    • 16.1.4. Fetching VECTOR columns to Data Frames
  • 16.2. Inserting Data Frames
    • 16.2.1. Inserting Data Frames with executemany()
    • 16.2.2. Inserting Data Frames with Direct Path Loads
  • 16.3. Explicit Conversion to DataFrame or ArrowArray
• 17. Working with Simple Oracle Document Access (SODA)
  • 17.1. SODA Examples
  • 17.2. Using the SODA Metadata Cache
  • 17.3. Committing SODA Work
• 18. Using Oracle Transactional Event Queues and Advanced Queuing
  • 18.1. Creating a Queue
  • 18.2. Enqueuing Messages
  • 18.3. Dequeuing Messages
  • 18.4. Using Object Queues
  • 18.5. Using Recipient Lists
  • 18.6. Changing Queue and Message Options
  • 18.7. Bulk Enqueue and Dequeue
• 19. Working with Continuous Query Notification (CQN)
  • 19.1. Requirements
  • 19.2. Creating a Subscription
  • 19.3. Registering Queries
• 20. Using Two-Phase Commits (TPC)
• 21. Starting and Stopping Oracle Database
  • 21.1. Starting Oracle Database Up
  • 21.2. Shutting Oracle Database Down
• 22. High Availability with python-oracledb
  • 22.1. General HA Recommendations
  • 22.2. Network Configuration
  • 22.3. Fast Application Notification (FAN)
  • 22.4. Application Continuity (AC)
  • 22.5. Transaction Guard
• 23. Concurrent Programming with asyncio and Pipelining
  • 23.1. Concurrent Programming with asyncio
    • 23.1.1. Connecting to Oracle Database Asynchronously
    • 23.1.2. Executing SQL Using Asynchronous Methods
    • 23.1.3. Managing Transactions Using Asynchronous Methods
  • 23.2. Pipelining Database Operations
    • 23.2.1. Using Pipelines
    • 23.2.2. Using OUT Binds with Pipelines
    • 23.2.3. Pipeline Error Handling
    • 23.2.4. Pipeline Cursor Usage
    • 23.2.5. Pipeline Round-trips
• 24. Character Sets and Globalization
  • 24.1. Character Sets
    • 24.1.1. Database Character Set
    • 24.1.2. Database National Character Set
    • 24.1.3. Setting the Client Character Set
  • 24.2. Time Zone Files
    • 24.2.1. Finding the Time Zone Files in Use
    • 24.2.2. Changing the Oracle Database Time Zone File
    • 24.2.3. Changing the Oracle Client Time Zone File
  • 24.3. Setting the Client Locale
    • 24.3.1. Thick Mode Oracle Database National Language Support (NLS)
    • 24.3.2. Thin Mode Locale-aware Number and Date Conversions
    • 24.3.3. Inserting NVARCHAR2 and NCHAR Data
• 25. Catching Exceptions
  • 25.1. Error Handling in Thin and Thick Modes
• 26. Tracing python-oracledb
  • 26.1. Application Tracing
    • 26.1.1. Oracle Database End-to-End Tracing
    • 26.1.2. Debugging PL/SQL with the Java Debug Wire Protocol
    • 26.1.3. Low Level SQL Tracing
    • 26.1.4. Using Connection Identifiers
    • 26.1.5. Tracing Bind Values
    • 26.1.6. Database Views for Tracing python-oracledb
  • 26.2. Using python-oracledb with OpenTelemetry
    • 26.2.1. Example of Using python-oracledb with OpenTelemetry
    • 26.2.2. OpenTelemetry and extended python-oracledb functionality
  • 26.3. Finding the python-oracledb Mode
  • 26.4. Low Level Python-oracledb Driver Tracing
• 27. Extending python-oracledb
  • 27.1. Subclassing Connections
  • 27.2. Python-oracledb Plugins
    • 27.2.1. Building Custom Plugins
  • 27.3. Connection Hooks
    • 27.3.1. Connection Protocol Hooks
    • 27.3.2. Connection Password Hooks
    • 27.3.3. Connection Parameter Hooks
• 28. Troubleshooting Errors
  • 28.1. Installation Errors
    • 28.1.1. “Not a supported wheel on this platform” Error
    • 28.1.2. Network Connection Error
    • 28.1.3. Upgrade to Latest Version Failed Without Any Errors
    • 28.1.4. “No module named pip” Error
    • 28.1.5. “fatal error: dpi.h: No such file or directory” Error
  • 28.2. Warning Messages
    • 28.2.1. Deprecated Python Version Warning
  • 28.3. Error Messages
    • 28.3.1. DPI Error Messages
    • 28.3.2. DPY Error Messages
    • 28.3.3. ORA Error Messages
• 29. Appendix A: Oracle Database Features Supported by python-oracledb
  • 29.1. Supported Oracle Database Data Types
• 30. Appendix B: Differences between python-oracledb Thin and Thick Modes
  • 30.1. Connection Handling Differences between Thin and Thick Modes
    • 30.1.1. Connections to a Local Database
    • 30.1.2. Oracle Net Services and Client Configuration Files
    • 30.1.3. Token Based Authentication
    • 30.1.4. Transport Layer Security (TLS) Support
    • 30.1.5. Native Network Encryption and Checksumming
  • 30.2. Connection Pooling Differences between Thin and Thick Modes
  • 30.3. Supported Database Data Types in Thin and Thick Modes
  • 30.4. Query Metadata in Thin and Thick Modes
  • 30.5. Implicit Results in Thin and Thick Modes
  • 30.6. Statement Caching in Thin and Thick Modes
  • 30.7. Duplicate SQL Bind Variable Placeholders in Thin and Thick Modes
  • 30.8. Error Handling in Thin and Thick Modes
  • 30.9. Globalization in Thin and Thick Modes
  • 30.10. Tracing in Thin and Thick Modes
• 31. Appendix C: The python-oracledb and cx_Oracle Drivers
  • 31.1. Upgrading from cx_Oracle 8.3 to python-oracledb
    • 31.1.1. Steps to Upgrade to python-oracledb
    • 31.1.2. Modernizing Code
    • 31.1.3. Code to Aid the Upgrade to python-oracledb
• 32. Appendix D: Python Frameworks, SQL Generators, and ORMs
  • 32.1. Using python-oracledb with Data Frame Libraries
  • 32.2. Connecting with Flask
  • 32.3. Connecting with SQLAlchemy
    • 32.3.1. Connecting with SQLAlchemy 2
    • 32.3.2. Connecting with SQLAlchemy 1.4
  • 32.4. Connecting with Django
    • 32.4.1. Standalone Connections
    • 32.4.2. Pooled Connections
  • 32.5. Older Versions of Python Frameworks, SQL Generators, and ORMs

API Manual

• 1. API: python-oracledb Module
  • 1.1. Oracledb Methods
    • Binary()
    • clientversion()
    • connect()
    • connect_async()
    • create_pipeline()
    • create_pool()
    • create_pool_async()
    • Date()
    • DateFromTicks()
    • enable_thin_mode()
    • from_arrow()
    • get_pool()
    • init_oracle_client()
    • is_thin_mode()
    • makedsn()
    • register_params_hook()
    • register_password_type()
    • register_protocol()
    • Time()
    • TimeFromTicks()
    • Timestamp()
    • TimestampFromTicks()
    • unregister_params_hook()
  • 1.2. Oracledb Attributes
    • apilevel
    • defaults
    • paramstyle
    • threadsafety
    • __version__
  • 1.3. Oracledb Constants
    • 1.3.1. Advanced Queuing: Delivery Modes
    • 1.3.2. Advanced Queuing: Dequeue Modes
    • 1.3.3. Advanced Queuing: Dequeue Navigation Modes
    • 1.3.4. Advanced Queuing: Dequeue Visibility Modes
    • 1.3.5. Advanced Queuing: Dequeue Wait Modes
    • 1.3.6. Advanced Queuing: Enqueue Visibility Modes
    • 1.3.7. Advanced Queuing: Message States
    • 1.3.8. Advanced Queuing: Other Constants
    • 1.3.9. Connection Authorization Modes
    • 1.3.10. Pipeline Operation Types
    • 1.3.11. Database Shutdown Modes
    • 1.3.12. Event Types
    • 1.3.13. Operation Codes
    • 1.3.14. Connection Pool Get Modes
    • 1.3.15. Connection Pool Purity Constants
    • 1.3.16. Subscription Grouping Classes
    • 1.3.17. Subscription Grouping Types
    • 1.3.18. Subscription Namespaces
    • 1.3.19. Subscription Protocols
    • 1.3.20. Subscription Quality of Service
    • 1.3.21. DB API Types
    • 1.3.22. Database Types
    • 1.3.23. Database Type Synonyms
    • 1.3.24. Two-Phase Commit (TPC) Constants
    • 1.3.25. Vector Format Constants
  • 1.4. Oracledb Exceptions
    • Warning
    • Error
    • DataError
    • DatabaseError
    • IntegrityError
    • InterfaceError
    • InternalError
    • NotSupportedError
    • OperationalError
    • ProgrammingError
  • 1.5. Oracledb _Error Objects
    • _Error.code
    • _Error.offset
    • _Error.full_code
    • _Error.message
    • _Error.context
    • _Error.isrecoverable
  • 1.6. Oracledb __future__ Object
  • 1.7. Oracledb Plugins
    • 1.7.1. Oracle Cloud Infrastructure (OCI) Object Storage Configuration Provider Plugin
    • 1.7.2. Azure App Configuration Provider Plugin
    • 1.7.3. Oracle Cloud Infrastructure (OCI) Cloud Native Authentication Plugin
    • 1.7.4. Azure Cloud Native Authentication Plugin
  • 1.8. Oracledb IntervalYM Class
  • 1.9. Oracledb JsonId Class
• 2. API: Defaults Object
  • 2.1. Defaults Class
    • Defaults
  • 2.2. 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 Class
    • Connection
  • 3.2. Connection Methods
    • Connection.__enter__()
    • Connection.__exit__()
    • Connection.begin()
    • Connection.begin_sessionless_transaction()
    • Connection.cancel()
    • Connection.changepassword()
    • Connection.close()
    • Connection.commit()
    • Connection.createlob()
    • Connection.cursor()
    • Connection.decode_oson()
    • Connection.direct_path_load()
    • 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.resume_sessionless_transaction()
    • Connection.rollback()
    • Connection.shutdown()
    • Connection.startup()
    • Connection.subscribe()
    • Connection.suspend_sessionless_transaction()
    • 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.3. 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 Class
    • ConnectParams
  • 4.2. 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.3. 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.pool_name
    • 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.terminal
    • ConnectParams.use_sni
    • ConnectParams.thick_mode_dsn_passthrough
    • ConnectParams.use_tcp_fast_open
    • ConnectParams.user
    • ConnectParams.wallet_location
• 5. API: ConnectionPool Objects
  • 5.1. ConnectionPool Class
    • ConnectionPool
  • 5.2. ConnectionPool Methods
    • ConnectionPool.acquire()
    • ConnectionPool.close()
    • ConnectionPool.drop()
    • ConnectionPool.reconfigure()
    • ConnectionPool.release()
  • 5.3. 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 Class
    • PoolParams
  • 6.2. PoolParams Methods
    • PoolParams.copy()
    • PoolParams.get_connect_string()
    • PoolParams.parse_connect_string()
    • PoolParams.set()
  • 6.3. 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 Class
    • Cursor
  • 7.2. 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.3. 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: DataFrame Objects
  • 8.1. DataFrame Class
    • DataFrame
    • 8.1.1. DataFrame Methods
  • 8.2. ArrowArray Objects
    • ArrowArray
• 9. API: FetchInfo Objects
  • 9.1. FetchInfo Class
    • FetchInfo
  • 9.2. 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 Class
    • Var
  • 10.2. Variable Methods
    • Var.getvalue()
    • Var.setvalue()
  • 10.3. Variable Attributes
    • Var.actual_elements
    • Var.buffer_size
    • Var.convert_nulls
    • Var.inconverter
    • Var.num_elements
    • Var.outconverter
    • Var.size
    • Var.type
    • Var.values
• 11. API: Subscription Objects
  • 11.1. Subscription Class
    • Subscription
    • 11.1.1. Subscription Methods
    • 11.1.2. Subscription Attributes
  • 11.2. Message Class
    • Message
    • 11.2.1. Message Attributes
  • 11.3. MessageTable Class
    • MessageTable
    • MessageTable.name
    • MessageTable.operation
    • MessageTable.rows
  • 11.4. MessageRow Class
    • MessageRow
    • 11.4.1. MessageRow Attributes
  • 11.5. MessageQuery Class
    • MessageQuery
    • MessageQuery.id
    • MessageQuery.operation
    • MessageQuery.tables
• 12. API: LOB Objects
  • 12.1. LOB Class
    • LOB
  • 12.2. 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.3. LOB Attributes
    • LOB.type
• 13. API: DbObjectType Objects
  • 13.1. DbObjectType Class
    • DbObjectType
    • 13.1.1. DbObjectType Methods
    • 13.1.2. DbObjectType Attributes
  • 13.2. DbObject Class
    • DbObject
    • 13.2.1. DbObject Methods
    • 13.2.2. DbObject Attributes
  • 13.3. DbObjectAttribute Class
    • DbObjectAttr
    • 13.3.1. DbObjectAttr Attributes
• 14. API: SparseVector Objects
  • 14.1. SparseVector Class
    • SparseVector
  • 14.2. SparseVector Attributes
    • SparseVector.indices
    • SparseVector.num_dimensions
    • SparseVector.values
• 15. API: Advanced Queuing (AQ)
  • 15.1. Queue Class
    • Queue
    • 15.1.1. Queue Methods
    • 15.1.2. Queue Attributes
  • 15.2. DeqOptions Class
    • DeqOptions
    • 15.2.1. DeqOptions Attributes
  • 15.3. EnqOptions Class
    • EnqOptions
    • 15.3.1. EnqOptions Attributes
  • 15.4. MessageProperties Class
    • MessageProperties
    • 15.4.1. MessageProperties Attributes
• 16. API: SODA
  • 16.1. SODA Requirements
  • 16.2. SodaDatabase Class
    • SodaDatabase
    • 16.2.1. SodaDatabase Methods
  • 16.3. SodaCollection Class
    • SodaCollection
    • 16.3.1. SodaCollection Methods
    • 16.3.2. SodaCollection Attributes
  • 16.4. SodaDocument Class
    • SodaDocument
    • 16.4.1. SodaDocument Methods
    • 16.4.2. SodaDocument Attributes
  • 16.5. SodaDocCursor Class
    • SodaDocCursor
    • 16.5.1. SodaDocCursor Methods
  • 16.6. SodaOperation Class
    • SodaOperation
    • 16.6.1. SodaOperation Methods
• 17. API: AsyncConnection Objects
  • 17.1. AsyncConnection Class
    • AsyncConnection
  • 17.2. AsyncConnection Methods
    • AsyncConnection.__aenter__()
    • AsyncConnection.__aexit__()
    • AsyncConnection.begin_sessionless_transaction()
    • AsyncConnection.callfunc()
    • AsyncConnection.callproc()
    • AsyncConnection.cancel()
    • AsyncConnection.changepassword()
    • AsyncConnection.close()
    • AsyncConnection.commit()
    • AsyncConnection.createlob()
    • AsyncConnection.cursor()
    • AsyncConnection.decode_oson()
    • AsyncConnection.direct_path_load()
    • AsyncConnection.encode_oson()
    • AsyncConnection.execute()
    • AsyncConnection.executemany()
    • AsyncConnection.fetchall()
    • AsyncConnection.fetch_df_all()
    • AsyncConnection.fetch_df_batches()
    • AsyncConnection.fetchmany()
    • AsyncConnection.fetchone()
    • AsyncConnection.gettype()
    • AsyncConnection.is_healthy()
    • AsyncConnection.msgproperties()
    • AsyncConnection.ping()
    • AsyncConnection.queue()
    • AsyncConnection.resume_sessionless_transaction()
    • AsyncConnection.rollback()
    • AsyncConnection.run_pipeline()
    • AsyncConnection.suspend_sessionless_transaction()
    • AsyncConnection.tpc_begin()
    • AsyncConnection.tpc_commit()
    • AsyncConnection.tpc_end()
    • AsyncConnection.tpc_forget()
    • AsyncConnection.tpc_prepare()
    • AsyncConnection.tpc_recover()
    • AsyncConnection.tpc_rollback()
    • AsyncConnection.xid()
  • 17.3. 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 Class
    • AsyncConnectionPool
  • 18.2. AsyncConnectionPool Methods
    • AsyncConnectionPool.acquire()
    • AsyncConnectionPool.close()
    • AsyncConnectionPool.drop()
    • AsyncConnectionPool.release()
  • 18.3. 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 Class
    • AsyncCursor
  • 19.2. AsyncCursor Methods
    • AsyncCursor.__aiter__()
    • AsyncCursor.__aenter__()
    • AsyncCursor.__aexit__()
    • 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.3. AsyncCursor Attributes
    • AsyncCursor.arraysize
    • AsyncCursor.bindvars
    • AsyncCursor.connection
    • 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 Class
    • AsyncLOB
  • 20.2. 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.3. AsyncLOB Attributes
    • AsyncLOB.type
• 21. API: Async Advanced Queuing (AQ)
  • 21.1. AsyncQueue Class
    • AsyncQueue
    • 21.1.1. AsyncQueue Methods
    • 21.1.2. AsyncQueue Attributes
  • 21.2. DeqOptions Class
  • 21.3. EnqOptions Class
  • 21.4. MessageProperties Class
• 22. API: Pipeline Objects
  • 22.1. Pipeline Class
    • Pipeline
    • 22.1.1. Pipeline Methods
    • 22.1.2. Pipeline Attributes
  • 22.2. PipelineOp Class
    • PipelineOp
    • 22.2.1. PipelineOp Attributes
  • 22.3. PipelineOpResult Objects
    • PipelineOpResult
    • 22.3.1. PipelineOpResult Attributes
• 23. Deprecated and Desupported Features

• python-oracledb Release Notes
• License

Indices and tables

• Index

• Module Index

• Search Page