N8n-nodes-tidb-cloud NPM

n8n-nodes-tidb-cloud

This is an n8n community node. It lets you use TiDB Cloud in your n8n workflows.

TiDB Cloud is a MySQL-compatible, fully-managed Database-as-a-Service (DBaaS) that brings everything great about TiDB to your cloud and lets you focus on your applications, not the complexities of your database.

n8n is a fair-code licensed workflow automation platform.

Installation

Follow the installation guide in the n8n community nodes documentation.

Credentials

Prerequisites

Create a TiDB Cloud account.

Using API Key

Access your TiDB Cloud dashboard.
Click Organization > Organization Settings in the upper-right corner.
Click the API Keys tab.
Click the Create API Key button to create a new API Key.
Save the created API key for later use in n8n.

For more information, see TiDB Cloud API Overview.

Support Operation

TiDB Cloud Node acts as a regular node, and only supports the following five operations.

Create Serverless Cluster: Create a TiDB Cloud Serverless Tier cluster.
Execute SQL: Execute an SQL statement in TiDB.
Delete：Delete rows in TiDB.
Insert: Insert rows in TiDB.
Update: Update rows in TiDB.

Usage

Here is an example usage, click here to find more information.

Fields Description

Different operations require different fields to be filled in. The following shows the respective field descriptions according to the operation.

Create Serverless Cluster

Credential for TiDB Cloud API: Only supports TiDB Cloud API key authentication. Refer to Get TiDB Cloud API Key.
Project: The TiDB Cloud project name.
Operation: The operation of this node. Refer to Support Operation.
Cluster: The TiDB Cloud cluster name. Enter one name for your new cluster.
Region: The region name. Choose a region where your cluster will be deployed. Usually, choose the region closest to your application deployment.
Password: The root password. Set a password for your new cluster.

Execute SQL

Credential for TiDB Cloud API: Only supports TiDB Cloud API key authentication. Refer to Get TiDB Cloud API Key.
Project: The TiDB Cloud project name.
Operation: The operation of this node. Refer to Support Operation.
Cluster: The TiDB Cloud cluster name.
Password: The password of TiDB Cloud cluster.
User: The username of your TiDB Cloud cluster.
Database: The database name.
SQL: The SQL statement to execute.

Delete

Credential for TiDB Cloud API: Only supports TiDB Cloud API key authentication. Refer to Get TiDB Cloud API Key.
Project: The TiDB Cloud project name.
Operation: The operation of this node. Refer to Support Operation.
Cluster: The TiDB Cloud cluster name. In the Create Serverless Cluster operation, you need to enter one name for your new cluster . While in other operations, you should choose one existing cluster.
Password: The password of TiDB Cloud cluster.
User: The username of your TiDB Cloud cluster.
Database: The database name.
Table: The table name. You can use From list mode to choose one or Name mode to type table name manually.
Delete Key: The Name of the item's property which decides which rows in the database should be deleted. Item is the data sent from one node to another. A node performs its action on each item of incoming data. For more information about item in n8n, see n8n documentation.

Insert

Credential for TiDB Cloud API: Only supports TiDB Cloud API key authentication. Refer to Get TiDB Cloud API Key.
Project: The TiDB Cloud project name.
Operation: The operation of this node. Refer to Support Operation.
Cluster: The TiDB Cloud cluster name. In the Create Serverless Cluster operation, you need to enter one name for your new cluster . While in other operations, you should choose one existing cluster.
Password: The password of TiDB Cloud cluster.
User: The username of your TiDB Cloud cluster.
Database: The database name.
Table: The table name. You can use From list mode to choose one or Name mode to type table name manually.
Columns: The comma-separated list of the input item's property which should used as columns for the new rows. Item is the data sent from one node to another. A node performs its action on each item of incoming data. For more information about item in n8n, see n8n documentation.

Update

Credential for TiDB Cloud API: Only supports TiDB Cloud API key authentication. Refer to Get TiDB Cloud API Key.
Project: The TiDB Cloud project name.
Operation: The operation of this node. Refer to Support Operation.
Cluster: The TiDB Cloud cluster name. In the Create Serverless Cluster operation, you need to enter one name for your new cluster. While in other operations, you should choose one existing cluster.
Password: The password of TiDB Cloud cluster.
User: The username of your TiDB Cloud cluster.
Database: The database name.
Table: The table name. You can use From list mode to choose one or Name mode to type table manually.
Update Key: The name of the item's property which decides which rows in the database should be updated. Item is the data sent from one node to another. A node performs its action on each item of incoming data. For more information about item in n8n, see n8n documentation.
Columns: The comma-separated list of the input item which should used as columns for the rows to update.

Limitations

Normally only one SQL statement is allowed in the Execute SQL operation. If you want to execute more than one statement in a single operation, you need to manually enable tidb_multi_statement_mode.
The Delete and Update operation need to specify one field as a key. For example, the Delete Key is set to id, which is equivalent to executing delete from table where id = ${item.id}. Currently, it only supports specifying one key.
The Insert and Update operation need to specify the comma-separated list in the Columns field, and the field name must be the same as the input item's property.