Skip to content
One platform. From customer conversation to completed work.Take a closer look
All connections
Cloud & Infrastructure · CONNECTION

TiDB Cloud + NodeHub

Manage TiDB Cloud Starter and Essential instances: branches, exports, imports, regions and instance settings.

Explore 19 workflow actions for TiDB Cloud, including account permissions and operation limits.

9 read actions10 write actions
WORKFLOW ACTIONS

What you can configure.

Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.

Cancel export

Write

Cancel a running export task.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

Cancel import

Write

Cancel a running import task.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create branch

Write

Create a branch of an instance, or of a parent branch, from now or a point in time.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create export

Write

Export an instance's data (all or chosen tables) as SQL, CSV or Parquet, to a local download or to S3 by IAM role.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

Create import

Write

Import CSV, SQL, Parquet or Aurora snapshot files into an instance from S3 by IAM role.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete branch

Write

Delete a branch.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete export

Write

Delete an export task.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

Delete instance

Write

Delete an instance and its data.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

Get branch

Read

Read a branch's state, parent and endpoints.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

Get export

Read

Read an export task's state, options and target.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

Get import

Read

Read an import task's state and progress.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

Get instance

Read

Read an instance's state, region, endpoints, backup policy and labels.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

List branches

Read

List an instance's branches.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

List exports

Read

List an instance's export tasks.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

List imports

Read

List an instance's import tasks.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

List instances

Read

List the organization's TiDB Cloud Starter and Essential instances, filtered and paged.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

List regions

Read

List the regions available to the organization.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

Reset branch

Write

Reset a branch to its parent's latest data.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

Update instance

Write

Rename an instance or change its labels, automated backup policy or public endpoint, naming the fields in updateMask.

Permissions and limits

Account permissions

  • A TiDB Cloud organization API key with access to the project

A repeated request may repeat the external action. Review the previous result before retrying a write.

SETUP

Start with a controlled test.

01Connect the intended account

Use the account and permissions required for your process. Review the connection check before configuring a workflow action.

02Review inputs and access

Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.

03Confirm the result

Inspect step outputs and confirm the result in TiDB Cloud. A saved workflow is not a completed provider action.

Follow the workflow quickstart
EXPLORE YOUR STACK

More in Cloud & Infrastructure.

TiDB Cloud integration | NodeHub