OceanBase logo

OceanBase

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

Product Overview
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

OceanBase

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

Product Overview
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 Developer Center

V3.1.0Enterprise Edition

  • What's New
    • Product updates
  • Overview
    • What is ODC?
    • Benefits
    • Architecture
    • Features
    • Limits
  • Quick Start
    • Overview
    • Install ODC
    • Account registration
    • Log on to an account
    • Create a connection
  • Tutorials
    • Tips on the SQL Console
    • Create a connection
    • Export data
    • Import data
    • Debug a stored procedure
    • View the performance of an SQL statement
  • User Guide (Web ODC)
    • Log on to ODC
      • Account registration
      • Log on to an account
      • Change password
    • ODC homepage
    • Personal settings
    • Connect to a database
      • Create a connection
      • Manage connections
    • Use the workspace
      • Overview
      • SQL window
      • Anonymous block window
      • Command-line window
      • Stored scripts
      • Snippets
    • Use tools
      • Data export and import
        • Overview
        • Export and import formats
        • Batch export and import
        • Single table export and import
      • Data mocking
      • Asynchronous execution
    • Recycle bin
    • Task management
      • Overview
      • Import tasks
      • Export tasks
      • Data mocking tasks
      • Asynchronous tasks
    • Session management
    • Database objects
      • Table objects
        • Overview
        • Create a table
        • Table list
        • Manage table attributes
        • Manage table data
      • View objects
        • Overview
        • Create a view
        • Manage views
      • Function objects
        • Overview
        • Create a function
        • Manage functions
      • Stored procedure objects
        • Overview
        • Create a stored procedure
        • Manage stored procedures
      • Sequence objects
        • Overview
        • Create a sequence
        • Manage sequences
      • Package objects
        • Overview
        • Create a package
        • Manage program packages
      • Trigger objects
        • Overview
        • Create a trigger
        • Manage triggers
      • Type objects
        • Overview
        • Create a type
        • Manage types
      • Synonym objects
        • Overview
        • Create a synonym
        • Manage synonyms
    • Help Center
  • User Guide (Client ODC)
    • Install ODC
    • ODC homepage
    • Personal settings
    • Connect to a database
      • Create a connection
      • Manage connections
    • Use the workspace
      • Overview
      • SQL window
      • Anonymous block window
      • Command-line window
      • Stored scripts
      • Snippets
    • Use tools
      • Data export and import
        • Overview
        • Export and import formats
        • Batch export and import
        • Single table export and import
      • Data mocking
      • Asynchronous execution
    • Recycle bin
    • Task management
      • Overview
      • Import tasks
      • Export tasks
      • Data mocking tasks
      • Asynchronous tasks
    • Session management
    • Database objects
      • Table objects
        • Overview
        • Create a table
        • Table list
        • Manage table attributes
        • Manage table data
      • View objects
        • Overview
        • Create a view
        • Manage views
      • Function objects
        • Overview
        • Create a function
        • Manage functions
      • Stored procedure objects
        • Overview
        • Create a stored procedure
        • Manage stored procedures
      • Sequence objects
        • Overview
        • Create a sequence
        • Manage sequences
      • Package objects
        • Overview
        • Create a package
        • Manage program packages
      • Trigger objects
        • Overview
        • Create a trigger
        • Manage triggers
      • Type objects
        • Overview
        • Create a type
        • Manage types
      • Synonym objects
        • Overview
        • Create a synonym
        • Manage synonyms
    • Help center
  • Deployment Guide
    • Deployment overview
    • Preparations before deployment
    • Deploy a single ODC node
      • Deployment process
      • Load and run ODC image
    • Deploy ODC in high availability mode
      • Deployment process
      • Load and run ODC image
      • Deploy SSL certificate
      • Deploy the NGINX proxy
      • Configure certificate trust
    • Deployment verification
  • Upgrade Guide
    • Overview
    • Preparation for upgrade
    • Upgrade single-node ODC
      • Upgrade process
      • Stop ODC of the earlier version
      • Load and run ODC image
    • Upgrade high-availability
      • Upgrade process
      • Stop ODC of the earlier version
      • Load and run ODC image
      • Upgrade NGINX image
    • Upgrade verification
    • Rollback after upgrade failed
  • FAQ

Download PDF

Product updates What is ODC? Benefits Architecture Features Limits Overview Install ODC Account registration Log on to an account Create a connection Tips on the SQL Console Create a connection Export data Import data Debug a stored procedure View the performance of an SQL statement Account registration Log on to an account Change password ODC homepage Personal settings Create a connection Manage connections Overview SQL window Anonymous block window Command-line window Stored scripts Snippets Data mocking Asynchronous execution Recycle bin Overview Import tasks Export tasks Data mocking tasks Asynchronous tasks Session management Help Center Install ODC ODC homepage Personal settings Create a connection Manage connections Overview SQL window Anonymous block window Command-line window Stored scripts Snippets Data mocking Asynchronous execution Recycle bin Overview Import tasks Export tasks Data mocking tasks Asynchronous tasks Session management Help center Deployment overview Preparations before deployment Deployment process Load and run ODC image Deployment process Load and run ODC image Deploy SSL certificate Deploy the NGINX proxy Configure certificate trust Deployment verification Overview Preparation for upgrade Upgrade process Stop ODC of the earlier version Load and run ODC image Upgrade process Stop ODC of the earlier version Load and run ODC image Upgrade NGINX image Upgrade verification Rollback after upgrade failed FAQ
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogWhite PaperLive DemosTraining & CertificationTicket
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 Developer Center
  3. V3.1.0
iconOceanBase Developer Center
V 3.1.0Enterprise Edition
Databases
  • OceanBase Database
  • OceanBase Cloud
  • OceanBase Tugraph
  • Interactive Tutorials
  • OceanBase Best Practices
Tools
  • OceanBase Cloud Platform
  • OceanBase Migration Service
  • OceanBase Developer Center
  • OceanBase Migration Assessment
  • OceanBase Admin Tool
  • OceanBase Loader and Dumper
  • OceanBase Deployer
  • Kubernetes operator for OceanBase
  • OceanBase Diagnostic Tool
  • OceanBase Binlog Service
Connectors and Middleware
  • OceanBase Database Proxy
  • Embedded SQL in C for OceanBase
  • OceanBase Call Interface
  • OceanBase Connector/C
  • OceanBase Connector/J
  • OceanBase Connector/ODBC
  • OceanBase Connector/NET
  • V 4.4.3
  • V 4.4.2
  • V 4.4.1
  • V 4.4.0
  • V 4.3.4
  • V 4.3.3
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.4
  • V 4.2.3
  • V 4.2.2
  • V 4.2.1
  • V 4.2.0
  • V 4.1.3 and earlier

Create a connection

Last Updated:2023-06-25 03:26:34  Updated
Share
What is on this page
Share

After you log on to OceanBase Developer Center (ODC) and enter the ODC homepage, you can click Create Connection in the upper-right corner of the Connections tab to configure a new connection. When you exit ODC and enter it again, you can view the saved connections in the connection list.

Image 601

Notice

  • The root@sys user privileges are required to view partition information. This also requires that you set a root@sys user in Advanced Configuration during connection creation.

  • OceanBase connections are designed to share sessions. Whether you actively commit or roll back a transaction, or trigger a transaction commit or rollback by creating, modifying, or deleting a database object or by executing a DDL statement, the transaction commit or rollback takes effect in all windows. When you enter an OceanBase connection for the first time, a related reminder is displayed.

  • In manual-commit mode, make sure to set ob_trx_idle_timeout to a value greater than the timeout value of SQL queries. Otherwise, if two SQL statements in one transaction are executed at an interval longer than the value of ob_trx_idle_timeout, the connection will be terminated. However, if ob_trx_idle_timeout is set to an excessively large value, the session cannot be released in time, resulting in unnecessary memory consumption. Therefore, you need to set this parameter to a proper value.

Procedure :

  1. Log on to ODC and click Create Connection .

  2. Specify the following parameters on the Create Connection tab. If you have an OceanBase connection string, which is in the format of mysql -h <host name> -P <port number> -u <database username@tenant name> # <cluster name> -D <default database> -p ' <database password> ', you can obtain the information from the string or you can use the Intelligent DNS Resolution tool on the tab to automatically specify these parameters.

    Parameter
    Description
    Region Select Public Cloud if your database instance is deployed on Alibaba Cloud, or select Independent Deployment/Apsara Stack if your database instance is deployed in your own environment.
    Connection Mode Select MySQL or Oracle .
    Connection Name Specify the name of the connection.
    Set tag Click the Set Tag button after Connection Name to set a tag for the current connection. You can set and manage tags in the list that appears. * Set Tag: Select a tag from the drop-down list. Create tags first if the list is empty. * Manage tags: Click Create Tag at the bottom of the list or the settings icon above the list to go to the Tags page, where you can edit or delete created tags. You can also click the Create Tag button to set a name or color for the new tag.
    Endpoint * Host Name : the host name, which you can find on the tenant information page. * Port : the port number, which you can find on the tenant information page. * Cluster : the name of the cluster in which the database you want to connect to is located. * Tenant : the name of the tenant under which the database you want to connect to is located.
    Default Database When you connect to a database under a MySQL tenant, you must specify the default database for the connection. You do not need to specify this parameter when you connect to a database under an Oracle tenant.
    Database Username An account under the tenant. In MySQL mode, this account must have the privilege to access the default database.
    Database Password The password of the account under the tenant. You can click the Test Connection button after the password box to test whether you can connect to the target database. An error will be returned if the configuration information such as the username, password, or network settings are invalid. You can only connect to a database under the current tenant. Otherwise, a test failure error will be returned.
    Intelligent DNS Resolution You can paste a connection string to the field. ODC automatically identifies the string and fills in the corresponding fields on the page.
    SQL Query Timeout Value You can specify a timeout value for SQL queries. A query whose execution time exceeds the timeout value is automatically terminated. The default timeout value is 60 seconds.
    Query SYS Tenant View When Tenant under Endpoint is set to sys, this option is automatically filled. * Account : an account having the privilege to check the views under the sys tenant. * Password : the password of the account. After you specify the account and password, you can click the Test Connection button next to the password box to verify whether the account information is valid.
    Feature You can select the features that the connection supports. By default, all features are selected. After you deselect a feature, the feature is disabled on the corresponding connection management page. The current version only allows you to disable or enable the Mock Data feature.
  3. Click Save to save the current configuration in the ODC connection list. Next time you log on to ODC, you can directly select the connection from the list. The connection configuration does not necessarily need to pass the connection test when you save the configuration.

  4. Click the Copy Connection String button to copy the connection information being edited on the current page as a connection string if necessary. This allows you to obtain the connection information with ease.

  5. Click the Cancel button if you do not need to save the current connection configuration. A pop-up dialog box will appear, asking you to confirm whether to exit the current connection creation page.

Previous topic

Personal settings
Last

Next topic

Manage connections
Next