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 Database

KV - V4.3.5

  • OBKV overview
  • Architecture
  • OBKV-Table
    • Introduction to OBKV-Table
      • Overview
      • OBKV-Table operation types
      • Core features of OBKV-Table
      • Differences between replace and insert_or_update
      • Supported value types
      • OBKV-Table data models
    • Use the OBKV-Table Java client
      • Java development guide for OBKV-Table
      • Prepare for development with OBKV-Table
      • Use the OBKV-Table Java client to connect to a cluster
      • Set client parameters
      • Supported client interfaces
      • Use the OBKV-Table Java client
    • Use the OBKV-Table GO client
      • Use the OBKV-Table Go client to connect to a cluster
      • Overview of the Go client
      • Individual API operations
      • Batch operations
      • About queries
      • Aggregation API
      • Filters
    • FAQ
  • OBKV-HBase
    • Overview
    • OBKV-HBase core features
    • Compatibility with HBase
    • Deployment
    • Application development with OBKV-HBase
      • Overview of OBKV-HBase application development
      • Data model
      • Data model design
      • Connect to a cluster using the OBKV-HBase client
      • Migrate HBase business code to OBKV-HBase
      • Data operation examples
      • Delete expired data
    • OBKV-HBase migration guide
    • OBKV-HBase management
      • Overview
      • High availability
      • Security and permissions
      • Monitoring metrics
    • Performance test
    • OBKV-HBase integrations
      • Flink
        • Synchronize data to OBKV-HBase by using Flink
    • Views
    • FAQ

Download PDF

OBKV overview Architecture Overview OBKV-Table operation types Core features of OBKV-Table Differences between replace and insert_or_update Supported value types OBKV-Table data models Java development guide for OBKV-Table Prepare for development with OBKV-Table Use the OBKV-Table Java client to connect to a cluster Set client parameters Supported client interfaces Use the OBKV-Table Java client Use the OBKV-Table Go client to connect to a cluster Overview of the Go client Individual API operations Batch operations About queries Aggregation API Filters FAQ Overview OBKV-HBase core features Compatibility with HBase Deployment Overview of OBKV-HBase application development Data model Data model design Connect to a cluster using the OBKV-HBase client Migrate HBase business code to OBKV-HBase Data operation examples Delete expired data OBKV-HBase migration guide Overview High availability Security and permissions Monitoring metrics Performance test Views FAQ
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 Database
  3. KV
  4. V4.3.5
iconOceanBase Database
KV - V 4.3.5
SQL
KV
  • V 4.3.5

Set client parameters

Last Updated:2025-09-08 11:49:23  Updated
share
What is on this page
Sample code
Parameters

folded

share

Sample code

ObTableClient client = new ObTableClient();
client.setFullUserName("your user name");
client.setPassword("your passwd");
client.setParamURL("your OCP url");
obTableClient.setSysUserName("your sys user name");
obTableClient.setSysPassword("your sys password");

// Set parameters for ObTableClient. For example,
// set the bolt.netty.buffer.low.watermark parameter to 64*1024 and the bolt.netty.buffer.high.watermark parameter to 128*1024.
client.addProperty(Property.NETTY_BUFFER_LOW_WATERMARK.getKey(), Integer.toString(64*1024));
client.addProperty(Property.NETTY_BUFFER_HIGH_WATERMARK.getKey(), Integer.toString(128*1024));

client.init();
// Perform insert/update/query/delete operation
...

Notice

You must set parameters before you call the client.init() function.

Parameters

The following table shows the parameters that you can configure. Important ones are displayed in boldface. For a specific parameter, if you are using the client of a different version, refer to the member variables of the Property class.

Category Parameter Default value Description Client version
RPC rpc.connect.timeout 500 The timeout period for creating an RPC connection. 1.0.0
RPC rpc.connect.try.times 3 The number of attempts to create an RPC connection. 1.0.0
RPC rpc.execute.timeout 3000 The socket timeout period for executing the RPC request. 1.0.0
RPC rpc.login.timeout 1000 The timeout period of the RPC login request. 1.0.0
RPC rpc.login.try.times 3 The number of attempts of the RPC login request. 1.0.0
RPC rpc.operation.timeout 10000 The timeout period for executing an internal RPC request in OceanBase Database. 1.0.0
META metadata.refresh.interval 60000 The time interval of metadata refresh. 1.0.0
META metadata.refresh.lock.timeout 8000 The lock timeout period after which the metadata is refreshed. 1.0.0
RS_LIST rs.list.acquire.connect.timeout 200 The timeout period for creating the connection to retrieve the RS list. 1.0.0
RS_LIST rs.list.acquire.read.timeout 1000 The RS list read timeout period for retrieving the RS list. 1.0.0
RS_LIST rs.list.acquire.try.times 3 The number of attempts to retrieve the RS list. 1.0.0
RS_LIST rs.list.acquire.retry.interval 100 The time interval between attempts to retrieve the RS list. 1.0.0
TableEntry table.entry.acquire.connect.timeout 500 The timeout period for creating a connection after which the table address is refreshed. 1.0.0
TableEntry table.entry.acquire.socket.timeout 3000 The socket timeout period after which the table address is refreshed. 1.0.0
TableEntry table.entry.refresh.interval.base 100 The basic time interval for refreshing the table address. 1.0.0
TableEntry table.entry.refresh.interval.ceiling 1600 The maximum time interval for refreshing the table address. 1.0.0
TableEntry table.entry.refresh.interval.wait false Specifies whether to wait for the specified interval when refreshing the table address. 1.0.0
TableEntry table.entry.refresh.lock.timeout 4000 The lock timeout period after which the table address is refreshed. 1.0.0
TableEntry table.entry.refresh.try.times 3 The number of attempts to refresh the table address. 1.0.0
TableEntry table.entry.refresh.continuous.failure.ceiling 10 The threshold of failed table address refreshes before refreshing the metadata. 1.0.0
SERVER server.address.priority.timeout 1800000 The period before the server address priority expires. 1.0.0
SERVER server.connection.pool.size 1 The maximum number of connections per server. 1.2.4
RUNTIME runtime.continuous.failure.ceiling 100 The threshold of consecutive runtime failures before refreshing the table address. 1.0.0
RUNTIME runtime.retry.times 1 The number of retries when a retriable error occurs during the runtime. 1.0.0
RUNTIME runtime.retry.interval 1 The time interval between retries when a runtime error occurs. 1.0.0
RUNTIME runtime.max.wait 3000 The timeout period for the execution of a single request. The request execution is retried within the timeout period. 1.0.0
RUNTIME runtime.batch.max.wait 3000 The timeout period for the batch execution of multiple requests. 1.0.0
Netty bolt.netty.buffer.low.watermark 512K The lower limit of resource usage for Netty write buffer. 1.2.5
Netty bolt.netty.buffer.high.watermark 1M The upper limit of resource usage for Netty write buffer. 1.2.5
Netty bolt.netty.blocking.wait.interval 1ms The wait time after the Netty write buffer is full. 1.2.5

Previous topic

Use the OBKV-Table Java client to connect to a cluster
Last

Next topic

Supported client interfaces
Next
What is on this page
Sample code
Parameters