OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

A unified distributed database ready for your transactional, analytical, and AI workloads.

DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Connector/J

V2.2.7

  • What's New
  • What is OceanBase Connector J?
    • Overview of OceanBase Connector/J
    • Compatibility requirements
  • Instructions
    • Install and load the OceanBase Connector/J driver
    • Connect Python applications to OceanBase Database
    • Basic operations
      • Import packages
      • Create a database connection
      • Create a Statement object
      • Run queries and retrieve ResultSet objects
      • Process ResultSet objects
      • Close ResultSet and Statement objects
      • Manage tables and data
      • Commit changes
      • Close a database connection
      • Example
    • Handle SQL exceptions
    • Use CallableStatements to call stored procedures
    • Java data streams
      • Overview of Java data streams
      • LONG and LONG RAW data types
      • LOB data types
    • Use LOBs
      • Overview of LOB data types
      • LOB data interface
      • LOB locator API
      • CHAR, VARCHAR, and RAW data types
    • Data sources and URL
      • Data source overview
      • Data source characteristics and properties
      • Create and connect to a data source instance
      • Database URL
    • Result set
      • Overview of result sets
      • Limits
      • FetchSize
      • refreshRow
      • useCursorFetch
    • Statement caching
      • Overview of statement caching
      • Use statement caching
      • Reuse statement objects
    • Failover and load balancing modes
    • Batch processing
    • Security features
    • SQL NetworkCostInfo
    • Troubleshooting
    • Common APIs
      • Overview of common APIs
      • java.sql.Connection
      • java.sql.CallableStatement
      • java.sql.DatabaseMetaData
      • java.sql.Driver
      • java.sql.PreparedStatement
      • java.sql.ParameterMetaData
      • java.sql.ResultSet
      • java.sql.ResultSetMetaData
      • java.sql.Statement
      • javax.sql.ConnectionPoolDataSource
      • javax.naming.Context
      • javax.sql.PooledConnection
    • Reference
      • Supported SQL and PL data types
  • Features specific to the Oracle mode
    • Binary Protocol (Prepared Statements)
      • COM_STMT_PREPARE_EXECUTE
      • COM_STMT_SEND_PIECE_DATA
    • Call PL stored procedures
    • Result set performance
    • Use ARRAY and STRUCT classes
    • Distributed transactions
      • Overview of distributed transactions
      • XA components
      • Distributed transaction examples
    • Error messages in Oracle mode
    • Data types supported in Oracle mode

Download PDF

What's New Overview of OceanBase Connector/J Compatibility requirements Install and load the OceanBase Connector/J driver Connect Python applications to OceanBase Database Import packages Create a database connection Create a Statement object Run queries and retrieve ResultSet objects Process ResultSet objects Close ResultSet and Statement objects Manage tables and data Commit changes Close a database connection Example Handle SQL exceptions Use CallableStatements to call stored procedures Overview of Java data streams LONG and LONG RAW data types LOB data types Overview of LOB data types LOB data interface LOB locator API CHAR, VARCHAR, and RAW data types Data source overview Data source characteristics and properties Create and connect to a data source instance Database URL Overview of result sets Limits FetchSize refreshRow useCursorFetch Overview of statement caching Use statement caching Reuse statement objects Failover and load balancing modesBatch processing Security features SQL NetworkCostInfo Troubleshooting Overview of common APIs java.sql.Connection java.sql.CallableStatement java.sql.DatabaseMetaData java.sql.Driver java.sql.PreparedStatement java.sql.ParameterMetaData java.sql.ResultSet java.sql.ResultSetMetaData java.sql.Statement javax.sql.ConnectionPoolDataSource javax.naming.Context javax.sql.PooledConnection Supported SQL and PL data types COM_STMT_PREPARE_EXECUTE COM_STMT_SEND_PIECE_DATA Call PL stored procedures Result set performance Use ARRAY and STRUCT classes Overview of distributed transactions XA components Distributed transaction examples Error messages in Oracle mode Data types supported in Oracle mode
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Connector/J
  3. V2.2.7
iconOceanBase Connector/J
V 2.2.7
  • V 2.4.17
  • V 2.4.16
  • V 2.4.15
  • V 2.4.14
  • V 2.4.5
  • V 2.4.4
  • V 2.4.3
  • V 2.4.2
  • V 2.4.1
  • V 2.4.0
  • V 2.2.11
  • V 2.2.10
  • V 2.2.7
  • V 2.2.6
  • V 2.2.3
  • V 2.2.0

Data source characteristics and properties

Last Updated:2026-04-09 07:31:40  Updated
share
What is on this page
DataSource interface
DataSource properties

folded

share

By using the data source feature in combination with Java Naming and Directory Interface (JNDI), you do not need to register the JDBC driver class name specified by the vendor, and you can use logical names for URLs and other properties. This ensures that the code used to open database connections can be migrated to other environments.

DataSource interface

JDBC data sources are instances that implement the standard javax.sql.DataSource interface class, for example:

public interface DataSource
{
   Connection getConnection() throws SQLException;
   Connection getConnection(String username, String password)
      throws SQLException;
   ...
}

OceanBase Database uses the OceanBaseDataSource class in the ocanbase.jdbc.pool software package to implement this interface. The overloaded getConnection method returns a connection to the database.

To use other values, you can use the corresponding Setter method to set related properties. You can input alternate usernames and passwords to the getConnection method, which has higher priority over property settings.

DataSource properties

Same as the DataSource interface class, the OceanBaseDataSource class provides a set of properties that specify the database to connect to. These properties follow the JavaBeans design pattern.

The following table describes the standard properties in OceanBaseDataSource in accordance with the Sun Microsystems specification.

Name Type Description
databaseName String The name of the specified database on the server.
dataSourceName String The name of the underlying data source class. For connection pools, this is the data source class of underlying pooled connections. For distributed transactions, this is an underlying XA data source class.
description String The description of the data source.
networkProtocol String The network protocol for communication with the server.
password String The password of the logon user.
portNumber int The port number on which the server listens for requests.
serverName String The name of the database server.
user String The logon user name.

The following table describes the extended properties in OceanBaseDataSource.

Name Type Description
connectionCacheName String The name of the cache. The cache name cannot be changed after the cache is created.
connection­Cache­Properties java.util.Properties The properties of the implicit connection cache.
connectionCachingEnabled Boolean Specifies whether to to use the implicit connection cache.
connectionProperties java.util.Properties The properties of the connection.
driverType String The JDBC driver type.
fastConnectionFailoverEnabled Boolean Specifies whether to use fast connection failover.
implicitCachingEnabled Boolean Specifies whether to enable the implicit connection cache.
loginTimeout int The maximum amount of time (in seconds) that the data source will wait when it attempts to connect to the database.
logWriter java.io.PrintWriter The log writer for the data source.
maxStatements int The maximum number of statements in the application cache.
serviceName String The database service name of the data source.
tnsEntry String The TNS entry name. The Transparent Network Substrate (TNS) entry name corresponds to the TNS entry specified in the tnsnames.ora configuration file.
url String The URL of the database connection string. You can use this property to replace the tnsEntry and driverType properties and the standard portNumber, networkProtocol, serverName, and databaseName properties.
ONSConfiguration String The Oracle Notification Service (ONS) configuration string used for remote subscription of FAN/ONS events.

You can use the setConnectionProperties method to set the properties of the connection and use the setConnectionCacheProperties method to set the properties of the connection cache. In addition, getConnectionCacheName() returns the cache name only when the ConnectionCacheName property is set for the data source after the cache is enabled for the data source.

Previous topic

Data source overview
Last

Next topic

Create and connect to a data source instance
Next
What is on this page
DataSource interface
DataSource properties