OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Connector/J

V2.4.17
  • What is OceanBase Connector J?
    • Overview of OceanBase Connector/J
    • Compatibility requirements
  • Install Driver
    • Install and load OceanBase Connector/J
  • Instructions
    • Quick start
      • Import packages
      • Establish 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
      • Examples
    • Data sources and URL
      • Data source overview
      • Database URL
      • clientInfoProvider
    • Java data streams
      • Overview of Java data streams
      • LONG and LONG RAW data types
      • Use LOBs
        • Overview of LOB data types
        • LOB data interface
        • LOB locator interface
      • CHAR, VARCHAR, and RAW data types
    • Statement caching
      • Overview of statement caching
      • Use statement caching
      • Reuse statement objects
    • Call a stored procedure
    • Handle SQL exceptions
    • Result set
      • Overview of result sets
      • Limitations
      • FetchSize
      • refreshRow
      • useCursorFetch
    • Batch processing
    • Failover and Load-Balancing
      • Failover and load balancing modes
      • LoadBalance strategies
      • Load balancing strategy configuration methods
    • Rich client
    • Logging
    • Network overheads
    • Show Trace
    • Security features
    • Troubleshooting
  • Reference
    • Features specific to the Oracle mode
      • Binary Protocol (Prepared Statements)
        • COM_STMT_PREPARE_EXECUTE
        • COM_STMT_SEND_PIECE_DATA
      • Call PL stored procedures
      • Scrollability of a result set
      • Use ARRAY and STRUCT classes
      • Distributed transactions
        • Overview
        • XA components
        • Distributed transaction examples
      • Obtain remarks
      • Data types supported in Oracle mode
      • Error messages in Oracle mode
    • Supported SQL and PL data types
    • Common APIs
      • Overview
      • 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
      • com.oceanbase.jdbc.ObPrepareStatement
  • Release Notes
    • V2.4
      • OceanBase Connector/J V2.4.17
      • OceanBase Connector/J V2.4.16
      • OceanBase Connector/J V2.4.15
      • OceanBase Connector/J V2.4.14
      • OceanBase Connector/J V2.4.13
      • OceanBase Connector/J V2.4.12
      • OceanBase Connector/J V2.4.11
      • OceanBase Connector/J V2.4.8
      • OceanBase Connector/J V2.4.5
      • OceanBase Connector/J V2.4.4
      • OceanBase Connector/J V2.4.3
      • OceanBase Connector/J V2.4.2
      • OceanBase Connector/J V2.4.1
      • OceanBase Connector/J V2.4.0
    • V2.2
      • OceanBase Connector/J V2.2.11
      • OceanBase Connector/J V2.2.10
      • OceanBase Connector/J V2.2.7
      • OceanBase Connector/J V2.2.6
      • OceanBase Connector/J V2.2.3
      • OceanBase Connector/J V2.2.0

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Connector/J
  3. V2.4.17

java.sql.CallableStatement

Last Updated:2026-09-04 08:24:26

Description
Methods

java.sql.CallableStatement is an interface for executing stored procedures.

Description

The JDBC API provides SQL escape syntax for stored procedures. This allows stored procedures to be called in a standard way for all relational database management systems (RDBMSs). One form of the escape syntax contains a result parameter, while the other does not. The result parameter must be registered as an OUT parameter when it is used. Other parameters can be used for input, output, or both. The parameters are referenced in sequence by number. The number of the first parameter is 1.

{?= call <procedure-name>[(<arg1>,<arg2>, ...)]}  
{call <procedure-name>[(<arg1>,<arg2>, ...)]}

The values of IN parameters are set by using set methods inherited from PreparedStatement. The type of all OUT parameters must be registered before the stored procedure is executed. The parameter values are retrieved by using get methods provided by this class.

A CallableStatement object can return one or more ResultSet objects. You can use methods inherited from Statement to process multiple ResultSet objects.

For maximum portability, a call's ResultSet objects and update counts need to be processed before the output parameter values are obtained.

Methods

Method
Return type
Supported in Oracle mode
Supported in MySQL mode
registerOutParameter(int parameterIndex, int sqlType ) void Yes Yes
registerOutParameter(int parameterIndex, int sqlType, int scale) void Yes Yes
wasNull() Boolean Yes Yes
getString(int parameterIndex) String Yes Yes
getString(String parameterName) String Yes Yes
getBoolean(int parameterIndex) Boolean Yes Yes
getBoolean(String parameterName) Boolean Yes Yes
getByte(int parameterName) byte Yes Yes
getByte(String parameterName) byte Yes Yes
getShort(int parameterIndex) short Yes Yes
getShort(String parameterName) short Yes Yes
getInt(int parameterIndex) int Yes Yes
getInt(String parameterName) int Yes Yes
getLong(int parameterIndex) long Yes Yes
getLong(String parameterName) long Yes Yes
getFloat(int parameterIndex) float Yes Yes
getFloat(String parameterName) float Yes Yes
getDouble(int parameterIndex) double Yes Yes
getDouble(String parameterName) double Yes Yes
getBigDecimal(int parameterIndex) BigDecimal Yes Yes
getBigDecimal(String parameterName) BigDecimal Yes Yes
getBytes(int parameterIndex) byte[] Yes Yes
getBytes(String parameterName) byte[] Yes Yes
getDate(int parameterIndex) Date Yes Yes
getDate(String parameterName) Date Yes Yes
getTime(int parameterIndex) Time Yes Yes
getTime(String parameterName) Time Yes Yes
getTimestamp(int parameterIndex) Timestamp Yes Yes
getTimestamp(String parameterName) Timestamp Yes Yes
getObject(int parameterIndex) Object Yes Yes
getObject(String parameterName) Object Yes Yes
getRef(int parameterIndex) Ref Yes Yes
getRef(String parameterName) Ref Yes Yes
getBlob(int parameterIndex) Blob Yes Yes
getBlob(String parameterName) Blob Yes Yes
getClob(int parameterIndex) Clob Yes Yes
getClob(String parameterName) Clob Yes Yes
getArray(int parameterIndex) Array Yes Yes
getArray(String parameterName) Array Yes Yes
getRowId(int parameterIndex) RowId No No
getRowId(String parameterName) RowId No No
setRowId(String parameterName,RowId x) void No No
setNString(String parameterName,String value) void Yes Yes
setNString(int parameterIndex) void Yes Yes
setNCharacterStream(String parameterName,Reader reader, longlength) void Yes Yes
setNCharacterStream(String parameterName,Reader value) void Yes Yes
setNClob(String parameterName,NClob value) void Yes Yes
setNClob(String parameterName,Reader reader, longlength) void Yes Yes
setNClob(String parameterName,Reader reader) void Yes Yes
setClob(String parameterName,Reader reader, longlength) void Yes Yes
setClob(String parameterName,Reader reader, longlength) void Yes Yes
setClob(String parameterName,Clob x) void Yes Yes
setBlob(String parameterName,InputStream inputStream, long length) void Yes Yes
setBlob(String parameterName,Blob x) void Yes Yes
setBlob(String parameterName,InputStream inputStream) void Yes Yes
getNClob(int parameterIndex) NClob Yes Yes
getNClob(String parameterName) NClob Yes Yes
setSQLXML(String parameterName,SQLXML xmlObject) void Yes Yes
getSQLXML(int parameterIndex) SQLXML No No
getSQLXML(String parameterName) SQLXML No No
getURL(int parameterIndex) URL Yes Yes
getURL(String parameterName) URL Yes Yes
getNString(int parameterIndex) String Yes Yes
getNString(String parameterName) String Yes Yes
getCharacterStream(int parameterIndex) Reader Yes Yes
getCharacterStream(String parameterName) Reader Yes Yes
getNCharacterStream(int parameterIndex) Reader Yes Yes
getNCharacterStream(String parameterName) Reader Yes Yes

Previous topic

java.sql.Connection
Last

Next topic

java.sql.DatabaseMetaData
Next
on this page
Description
Methods