Table of Contents

• Title and Copyright Information
• Preface
  • Audience
  • Documentation Accessibility
  • Related Documents
  • Conventions
• Changes in This Release for Oracle Universal Connection Pool Developer's Guide
  • Changes in Oracle Database 23c
    • New Features
• 1 Introduction to UCP
  • 1.1 Overview of Connection Pool
  • 1.2 Benefits of Using a Connection Pool
  • 1.3 Overview of Universal Connection Pool
    • 1.3.1 Conceptual Architecture
    • 1.3.2 Connection Pool Properties
    • 1.3.3 Connection Pool Manager
    • 1.3.4 High Availability and Performance Scenarios
• 2 Getting Started
  • 2.1 Requirements for using UCP
  • 2.2 Basic Connection Steps in UCP
    • 2.2.1 Authentication in UCP
    • 2.2.2 Authentication Using IAM Database Access Tokens in Oracle Cloud Infrastructure
  • 2.3 UCP API Overview
  • 2.4 UCP System Properties
  • 2.5 Basic Connection Example Using UCP
  • 2.6 Minimal Pool configuration
• 3 Getting Database Connections in UCP
  • 3.1 About Borrowing Connections from UCP
    • 3.1.1 Overview of Borrowing Connections from UCP
    • 3.1.2 Using the Pool-Enabled Data Source
    • 3.1.3 Using the Pool-Enabled XA Data Source
    • 3.1.4 Setting Connection Properties
    • 3.1.5 Using JNDI to Borrow a Connection
    • 3.1.6 About Connection Initialization Callback
      • 3.1.6.1 Overview of Connection Initialization Callback
      • 3.1.6.2 Creating an Initialization Callback
      • 3.1.6.3 Registering an Initialization Callback
      • 3.1.6.4 Removing or Unregistering an Initialization Callback
  • 3.2 Setting Connection Pool Properties for UCP
  • 3.3 Overview of Validating Connections in UCP
    • 3.3.1 Validating When Borrowing
    • 3.3.2 Minimizing Connection Validation with setSecondsToTrustIdleConnection() Method
    • 3.3.3 Checking If a Connection Is Valid
  • 3.4 Returning Borrowed Connections to UCP
  • 3.5 Removing Connections from UCP
  • 3.6 UCP Integration with Third-Party Products
• 4 Connection Creation Consumer
  • 4.1 Implementing a Connection Creation Consumer
• 5 Optimizing Universal Connection Pool Behavior
  • 5.1 Optimizing Connection Pools
  • 5.2 About Controlling the Pool Size in UCP
    • 5.2.1 Setting the Initial Pool Size
    • 5.2.2 Setting the Minimum Pool Size
    • 5.2.3 Setting the Maximum Pool Size
  • 5.3 About Optimizing Real-World Performance with Static Connection Pools
  • 5.4 Stale Connections in UCP
    • 5.4.1 What is Connection Reuse?
      • 5.4.1.1 Setting the Maximum Connection Reuse Time
      • 5.4.1.2 Setting the Maximum Connection Reuse Count
    • 5.4.2 Setting the Connection Validation Timeout
    • 5.4.3 Setting the Abandon Connection Timeout
    • 5.4.4 Setting the Time-To-Live Connection Timeout
    • 5.4.5 Setting the Connection Wait Timeout
    • 5.4.6 Setting the Inactive Connection Timeout
    • 5.4.7 Setting the Query Timeout
    • 5.4.8 Setting the Timeout Check Interval
  • 5.5 About Harvesting Connections in UCP
    • 5.5.1 Overview of Harvesting Connections in UCP
    • 5.5.2 Setting a Connection to Harvestable
    • 5.5.3 Setting the Harvest Trigger Count
    • 5.5.4 Setting the Harvest Maximum Count
  • 5.6 About Caching SQL Statements in UCP
    • 5.6.1 Overview of Statement Caching in UCP
    • 5.6.2 Enabling Statement Caching in UCP
  • 5.7 UCP Best Practices
• 6 Labeling Connections in UCP
  • 6.1 Overview of Labeling Connections in UCP
  • 6.2 Implementation of a Labeling Callback in UCP
    • 6.2.1 When to Use a Labeling Callback in UCP
    • 6.2.2 Creating a Labeling Callback in UCP
      • 6.2.2.1 Example of Labeling Callback in UCP
    • 6.2.3 Registering a Labeling Callback in UCP
    • 6.2.4 Removing a Labeling Callback in UCP
  • 6.3 Integration of UCP with DRCP
  • 6.4 Applying Connection Labels in UCP
  • 6.5 Borrowing Labeled Connections from UCP
  • 6.6 Checking Unmatched Labels in UCP
  • 6.7 Removing a Connection Label in UCP
• 7 Controlling Reclaimable Connection Behavior
  • 7.1 AbandonedConnectionTimeoutCallback Interface
  • 7.2 TimeToLiveConnectionTimeoutCallback Interface
• 8 Using the Connection Pool Manager
  • 8.1 Overview of Using the UCP Manager
    • 8.1.1 About Connection Pool Manager
    • 8.1.2 Creating a Connection Pool Manager for UCP
    • 8.1.3 Life Cycle States of a Connection
      • 8.1.3.1 Creating a Connection Pool
      • 8.1.3.2 Starting a Connection Pool
      • 8.1.3.3 Stopping a Connection Pool
      • 8.1.3.4 Destroying a Connection Pool
    • 8.1.4 Maintenance of Universal Connection Pool
      • 8.1.4.1 Refreshing a Connection Pool
      • 8.1.4.2 Recycling a Connection Pool
      • 8.1.4.3 Purging a Connection Pool
  • 8.2 Overview of JMX-Based Management in UCP
    • 8.2.1 UniversalConnectionPoolManagerMBean
    • 8.2.2 UniversalConnectionPoolMBean
• 9 Shared Pool Support for Multitenant Data Sources
  • 9.1 Overview of Shared Pool Support
  • 9.2 Prerequisites for Supporting Shared Pool
  • 9.3 Configuring the Shared Pool
  • 9.4 UCP APIs for Shared Pool Support
  • 9.5 Sample XML Configuration File for Shared Pool
• 10 Using Oracle RAC Features
  • 10.1 Overview of Oracle RAC Features
  • 10.2 About Fast Connection Failover
    • 10.2.1 Overview of Fast Connection Failover
    • 10.2.2 What is Fast Connection Failover?
      • 10.2.2.1 What the Application Sees
      • 10.2.2.2 How FCF Works
    • 10.2.3 Fast Connection Failover Prerequisites
    • 10.2.4 Example of Fast Connection Failover Configuration
    • 10.2.5 Enabling Fast Connection Failover
    • 10.2.6 What is ONS?
      • 10.2.6.1 Overview of ONS Configuration File
      • 10.2.6.2 Remote Configuration of ONS
      • 10.2.6.3 Configuration of Client-Side ONS Daemon
    • 10.2.7 Configuring the Connection URL
  • 10.3 About Run-Time Connection Load Balancing
    • 10.3.1 Overview of Run-Time Connection Load Balancing
    • 10.3.2 Setting Up Run-Time Connection Load Balancing
  • 10.4 About Connection Affinity
    • 10.4.1 Overview of Connection Affinity
      • 10.4.1.1 Transaction-Based Affinity
      • 10.4.1.2 Web Session Affinity
      • 10.4.1.3 Oracle RAC Data Affinity
    • 10.4.2 Setting Up Connection Affinity
      • 10.4.2.1 Creating a Connection Affinity Callback
      • 10.4.2.2 Registering a Connection Affinity Callback
      • 10.4.2.3 Removing a Connection Affinity Callback
      • 10.4.2.4 Strict Affinity Mode
  • 10.5 Global Data Services
    • 10.5.1 Overview of Global Data Services
    • 10.5.2 Configuring an Application for Using GDS
• 11 UCP Asynchronous Extension
  • 11.1 Overview of UCP Asynchronous Extension
  • 11.2 Example: UCP Asynchronous Extension
  • 11.3 Asynchronous Connection Labeling
  • 11.4 Example: Asynchronous Connection Labeling
• 12 Ensuring Application Continuity
  • 12.1 Overview of Ensuring Application Continuity with UCP
  • 12.2 Configuring the Data Source for Application Continuity
  • 12.3 Using Connection Labeling for Application Continuity
  • 12.4 Using Connection Initialization Callback for Application Continuity
• 13 Shared Pool for Sharded Databases
  • 13.1 Overview of UCP Shared Pool for Database Sharding
  • 13.2 About Handling Connection Requests for a Sharded Database
    • 13.2.1 About Building the Sharding Key
    • 13.2.2 How to Checkout Connections from a Pool with a Sharding Key
    • 13.2.3 About Checking Out Connections without Providing the Sharding Keys
    • 13.2.4 About Connecting to the Shard Catalog or Co-ordinator for Multi Shard Queries
    • 13.2.5 About Configuring the Number of Connections Per Shard
    • 13.2.6 Pool Connection Selection Algorithm During Connection Checkout
    • 13.2.7 Failover or Resharding Event Handling in UCP
  • 13.3 Sharding Data Source for Transparent Access to Sharded Databases
  • 13.4 UCP APIs for Database Sharding Support
  • 13.5 UCP Sharding Example
  • 13.6 Middle-Tier Routing Using UCP
    • 13.6.1 UCP APIs for Middle-Tier Routing Support
    • 13.6.2 Middle-Tier Routing with UCP Example
  • 13.7 Sharding with JTA/XA Transaction in WebLogic Server
• 14 Diagnosing a Connection Pool
  • 14.1 Pool Statistics
  • 14.2 Dynamic Monitoring Service Metrics
  • 14.3 Overview of Logging and Tracing in UCP
    • 14.3.1 Logging and Tracing Settings
    • 14.3.2 Diagnosability System Properties and Command Line
    • 14.3.3 Logging Configuration File
    • 14.3.4 Tracing the Error Codes to Watch
    • 14.3.5 MBeans for UCP Diagnosability
  • 14.4 About Viewing Oracle RAC Statistics
    • 14.4.1 Fast Connection Failover Statistics
    • 14.4.2 Run-Time Connection Load Balance Statistics
    • 14.4.3 Connection Affinity Statistics
  • 14.5 Exceptions and Error Codes
• A Error Codes Reference
  • A.1 General Structure of UCP Error Messages
  • A.2 Connection Pool Layer Error Messages
  • A.3 JDBC Data Sources and Dynamic Proxies Error Messages
• B UCP Exception Error Codes
• Index