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

V4.1.0Community Edition

  • Document Overview
  • What's New
    • What's new
  • Overview
    • What is ODC?
    • Benefits
    • Architecture
    • Features
    • Limits
  • Quick Start
    • Overview
    • Install ODC
    • Log on to ODC with an account
    • Create a private 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
      • Log on to ODC with an account
      • Change the password
    • ODC homepage
    • Connect to a database
      • Create a private connection
      • Manage private connections
    • Public resource management
      • Overview
      • Quick start
      • Resource permissions
        • Manage public connections
        • Manage resource groups
        • Manage roles
        • Manage users
        • Automatic authorization rules
      • Task process management
      • Manage operation records
      • Data desensitization management
      • System settings
    • Use the workspace
      • Overview
      • SQL window
      • Anonymous block window
      • Command-line window
      • Stored scripts
      • Snippet
    • Use tools
      • Data export and import
        • Overview
        • Export and import formats
        • Batch export and import
        • Single table export and import
      • Data mocking
      • Partitioning plan
      • Database changes
      • Shadow table synchronization
      • SQL plan
    • Recycle bin
    • View operation records
    • Task management
      • Overview
      • Import tasks
      • Export tasks
      • Data mocking tasks
      • Database change tasks
      • Partitioning plan task
      • Permission application tasks
      • Shadow table synchronization tasks
      • SQL plan task
    • Session management
    • Database objects
      • Table objects
        • Create a table
        • 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 program 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
    • Connect to a database
      • Create a private connection
      • Manage connections
    • Use the workspace
      • Overview
      • SQL window
      • Anonymous block window
      • Command-line window
      • Stored scripts
      • Snippet
    • Use tools
      • Data export and import
        • Overview
        • Export and import formats
        • Batch export and import
        • Single table export and import
      • Data mocking
      • Asynchronous execution
      • Shadow table synchronization
    • Recycle bin
    • View operation records
    • Task management
      • Overview
      • Import tasks
      • Export tasks
      • Data mocking tasks
      • Database Change
      • Shadow table synchronization 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 program 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 an ODC image
    • Deploy ODC in high availability mode
      • Deployment process
      • Load and run an ODC image
      • Deploy SSL certificate
      • Deploy the NGINX proxy
      • Configure certificate trust
    • Deployment verification
  • Upgrade Guide
    • Overview
    • Preparations before upgrade
    • Upgrade single-node ODC
      • Upgrade process
      • Stop ODC of the earlier version
      • Load and run an ODC image
    • Upgrade high-availability
      • Upgrade process
      • Stop ODC of the earlier version
      • Load and run an ODC image
      • Upgrade NGINX image
    • Upgrade verification
    • Rollback after upgrade failed
  • FAQ

Download PDF

Document Overview What's newWhat is ODC? Benefits Architecture Features Limits Overview Install ODC Log on to ODC with an account Create a private connection Tips on the SQL Console Create a connection Export data Import data Debug a stored procedure View the performance of an SQL statement Log on to ODC with an account Change the password ODC homepageCreate a private connection Manage private connections Overview Quick start Task process managementManage operation records Data desensitization managementSystem settings Overview SQL windowAnonymous block window Command-line window Stored scripts Snippet Data mocking Partitioning planDatabase changes Shadow table synchronization SQL planRecycle bin View operation records Overview Import tasks Export tasks Data mocking tasks Database change tasks Partitioning plan task Permission application tasks Shadow table synchronization tasks SQL plan taskSession management Help center Install ODC ODC homepage Create a private connection Manage connections Overview SQL windowAnonymous block window Command-line window Stored scripts Snippet Data mocking Asynchronous execution Shadow table synchronizationRecycle bin View operation records Overview Import tasks Export tasks Data mocking tasks Database Change Shadow table synchronization tasksSession management Help center Deployment overview Preparations before deployment Deployment process Load and run an ODC image Deployment process Load and run an ODC image Deploy SSL certificate Deploy the NGINX proxy Configure certificate trust Deployment verificationOverview Preparations before upgrade Upgrade process Stop ODC of the earlier version Load and run an ODC image Upgrade process Stop ODC of the earlier version Load and run an 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
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 Developer Center
  3. V4.1.0
iconOceanBase Developer Center
V 4.1.0Community Edition
  • 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
Community Edition
  • V 4.1.0
  • V 4.0.0
  • V 3.3.2
  • V 3.2.2
Enterprise Edition
  • V 4.1.3
  • V 3.4.0

Manage connections

Last Updated:2023-09-05 07:45:46  Updated
share
What is on this page
Overview
View connections
View connection history
Set a tag
Pin a connection to the top
Edit a connection
Copy a connection
Delete a connection
Other operations

folded

share

Overview

On the homepage of OceanBase Developer Center (ODC), the Private Connection tab displays the information of connections that you created and saved.

All the connections you created are displayed in a list on the Private Connection tab for you to view and manage them.

Image 905

View connections

On the Private Connection tab, you can perform the following operations:

  • Click the refresh icon to manually refresh the list.

  • Click All Modes to select the MySQL or Oracle mode.

  • Search for connections by using the search box.

  • Adjust the column width of the connection list.

The following table describes columns in the list of private connections.

Column Description
Connection Name The name of the connection and the host, port, cluster, and tenant information. You can click the name of a connection to go to the corresponding connection management page. The icon before the connection name indicates the status of the connection. Blue indicates valid, red indicates invalid, and gray indicates that the database password is not saved.
Cluster The cluster information. You can click the filter icon Filter to filter the cluster information. If you select Empty , you can filter connections that do not belong to any clusters.
Tenant The tenant information. You can click the filter icon Filter to filter the tenant information. If you select Empty , you can filter connections that do not belong to any tenants.
Tag The tag of the connection. You can create a tag and assign it to a connection. You can assign only one tag to each connection.
Operation Time The time when the connection was edited, or the time when the connection was created if the connection has not been edited.
Actions The actions you can take. Valid values: Open , Edit , Copy , and Delete .

View connection history

In the upper-right corner of the list, click History . The Historical Opened Windows panel appears.

Client - History

The panel shows a list that has the following columns.

Column Description
Connection Name The name of the connection you accessed.
Database/Schema Name The name of the database or schema that you accessed by using the connection.
Recently Opened At The time when you last accessed the connection.
SQL/PL Window The workspace window that you created when you accessed the connection. Move the pointer to a window name, and the script that you edited in the window is displayed.
Actions You can click Open to resume the connection in a new window. The corresponding workspace window and its content are also resumed.

Note

By default, the historical records in the panel are saved for 48 hours. You can quickly restore the content in an unsaved SQL window based on records in the panel.

Set a tag

ODC allows you to create a tag and assign it to a connection. You can assign only one tag to each connection.

  • Tag creation: You can create a tag by using the following two methods:

    • Click Set Tag next to the Connection Name field in the Create Connection panel.

    • Move the pointer in the tag column of the row where the target connection is located in the connection list, click Set Tag and click Create Tag in the drop-down list. On the Tags page, specify the name and color of the tag, and click the tick icon to complete the creation.

  • Tag setting: Select the target tag from the drop-down list that displays all the tags that you created, and modify related parameters to finish the setting.

  • Tag management: Click the settings icon in the upper-right corner of the drop-down list to go to the Tags page, where you can edit or delete created tags.

Pin a connection to the top

By default, the connections in the connection list are sorted by creation time, with the most recently created connection on top. The list does not support custom sorting, but you can pin frequently used connections to the top.

You can click the flag Homepage - Pin Connection Name to Top next to the name of a connection to pin the connection to the top. This turns the flag yellow. You can click the flag again to unpin the connection from the top.

Edit a connection

Click Edit in the Actions column of the target connection. The Edit Connection panel appears, which has the same structure as the Create Connection panel and displays the configuration information of the current connection. You can edit the information displayed in the Edit Connection panel.

Before you change Database Password , you must first click Change Password next to the password box. To abort the current change, click Cancel next to the password box, and the input in the password box is restored to its original value.

Copy a connection

Click Copy in the Actions column of the target connection. The Create Connection panel appears. The copied information is automatically filled in the panel. This allows you to quickly create a connection by modifying existing information.

The copy feature allows you to easily create database connections having similar information.

Delete a connection

To delete a connection, click Delete in the Actions column of the target connection.

For example, when the connected database no longer exists or you do not need to access the connected database, you can directly delete the corresponding connection.

Other operations

  • In addition to the management actions that the Private Connection tab provides, after you go to the management page of a database connection, the homepage menu icon Homepage menu in the top navigation bar further provides the following buttons:

    • Open Connection in New Window : After you click a connection in the connection list that appears, ODC opens the connection in a new window.

    • Connections : Click this button to open the ODC homepage in a new window. On the ODC homepage, you can view and manage the configuration information of all connections.

    • Reload : Click this button to reload the current page.

    • Exit Connection : Click this button to exit the current connection and go to the ODC homepage.

      Image 031

  • On the database connection page, the @{database name} information is included in the window name of Client ODC. Image 032

  • Information such as the connection name, schema (in Oracle mode), and database name (in MySQL mode) appears in the top navigation bar of the workspace.

    • Move your pointer over the connection name in the top navigation bar. In the tooltip that appears, you can see information in the following fields: Connection Mode , Host/Port, Cluster/Tenant , and Database Username .

    • Click the drop-down arrow next to the displayed schema name or database name. In the drop-down list that appears, click a schema or database name to go to the target schema or database.

      Manage private connections - Other operations

Previous topic

Create a private connection
Last

Next topic

Overview
Next
What is on this page
Overview
View connections
View connection history
Set a tag
Pin a connection to the top
Edit a connection
Copy a connection
Delete a connection
Other operations