Data Synchronization SQL Manual

This document introduces SQL commands for managing the data synchronization functionality of TDengine, including Xnode nodes, synchronization tasks, Job shards, and Agent nodes.

Xnode Management

Xnodes are the basic execution units of the data synchronization service, responsible for specific data transmission tasks.

Create Xnode

Syntax

CREATE XNODE 'url'
CREATE XNODE 'url' USER name PASS 'password'

Parameter Description

url: The address of the Xnode, in the format host:port with port to taosx GRPC service (6055 by default)
Username and password need to be specified when creating for the first time, used for xnoded to connect to taosd

Example

taos> CREATE XNODE "h1:6055";
Create OK, 0 row(s) affected (0.050798s)

taos> CREATE XNODE 'x1:6055' USER root PASS 'taosdata';
Create OK, 0 row(s) affected (0.050798s)

View Xnodes

Syntax

SHOW XNODES

Example

taos> SHOW XNODES;

Output result:

id | url     | status | create_time                 | update_time             |
===============================================================================
1  | h1:6050 | online | 2025-12-14 01:01:34.655     | 2025-12-14 01:01:34.655 |
Query OK, 1 row(s) in set (0.005518s)

Drain Xnode

Reassign existing tasks of a node to other nodes for execution.

Syntax

DRAIN XNODE id

Parameter Description

id: The ID of the Xnode

Example

taos> DRAIN XNODE 4;
Query OK, 0 row(s) affected (0.014246s)

Delete Xnode

Syntax

DROP XNODE [FORCE] id | 'url'

Parameter Description

id: The ID of the Xnode
url: The address of the Xnode
FORCE: Force delete Xnode

Example

taos> DROP XNODE 1;
Drop OK, 0 row(s) affected (0.038173s)

taos> DROP XNODE "h2:6050";
Drop OK, 0 row(s) affected (0.038593s)

Task Management

Tasks define the source, destination, and data parsing rules for data synchronization.

Create Task

Syntax

CREATE XNODE TASK 'name'
  FROM { 'from_dns' | DATABASE 'dbname' | TOPIC 'topic' }
  TO { 'to_dns' | DATABASE 'dbname' }
  [ WITH task_options ]

task_options:
  [ PARSER 'parser' ]
  [ STATUS 'status' ]
  [ VIA viaId ]
  [ XNODE_ID xnodeId ]
  [ REASON 'reason' ]
  [ LABELS 'labels' ]

Syntax note: All task_options can be used simultaneously, separated by spaces, order independent

Parameter Description

Parameter	Description
name	Task name
from_dns	Source connection string (e.g., `mqtt://...`)
dbname	Database name
topic	Topic name
to_dns	Destination connection string (e.g., `taos://...`)
parser	Data parsing configuration (JSON format)
status	Task status
xnodeId	The xnode node ID where the task resides
viaId	The agent ID where the task resides
reason	Reason for recent task execution failure
labels	Task labels, stored as a JSON string

Example

taos> CREATE XNODE TASK "t4" FROM 'kafka://localhost:9092?topics=abc&group=abcgroup' TO 'taos+ws://localhost:6041/test' WITH parser '{"model":{"name":"cc_abc","using":"cc","tags":["g"],"columns":["ts","b"]},"mutate":[{"map":{"ts":{"cast":"ts","as":"TIMESTAMP(ms)"},"b":{"cast":"a","as":"VARCHAR"},"g":{"value":"1","as":"INT"}}}]}';
Create OK, 0 row(s) affected (0.038959s)

View Tasks

Syntax

SHOW XNODE TASKS

Example

taos> SHOW XNODE TASKS;

Output result:

taos> SHOW XNODE TASKS \G;
*************************** 1.row ***************************
         id: 3
       name: t4
       from: kafka://localhost:9092?topics=abc&group=abcgroup
         to: taos+ws://localhost:6041/test
     parser: {"model":{"name":"cc_abc","using":"cc","tags":["g"],"columns":["ts","b"]},"mutate":[{"map":{"ts":{"cast":"ts","as":"TIMESTAMP(ms)"},"b":{"cast":"a","as":"VARCHAR"},"g":{"value":"1","as":"INT"}}}]}
        via: NULL
   xnode_id: NULL
     status: NULL
     reason: NULL
 created_by: root
     labels: NULL
create_time: 2026-01-13 07:56:18.076
update_time: 2026-01-13 07:56:18.076
Query OK, 2 row(s) in set (0.019692s)

Start Task

Syntax

START XNODE TASK id | 'name'

Example

taos> START XNODE TASK 1;
DB error: Xnode url response http code not 200 error [0x8000800C] (0.002160s)

Stop Task

Syntax

STOP XNODE TASK id | 'name'

Example

taos> STOP XNODE TASK 1;
DB error: Xnode url response http code not 200 error [0x8000800C] (0.002047s)

Modify Task

Syntax

ALTER XNODE TASK { id | 'name' }
  [ FROM { 'from_dns' | DATABASE 'dbname' | TOPIC 'topic' } ]
  [ TO { 'to_dns' | DATABASE 'dbname' } ]
  [ WITH alter_options ]

alter_options:
  [ PARSER 'parser' ]
  [ NAME 'name' ]
  [ STATUS 'status' ]
  [ VIA viaId ]
  [ XNODE_ID xnodeId ]
  [ REASON 'reason' ]
  [ LABELS 'labels' ]

Syntax note: The meaning of task_options is the same as when creating a task

Example

taos> ALTER XNODE TASK 3 FROM 'pulsar://zgc...' TO 'testdb' WITH xnode_id 33 via 333 reason 'zgc_test';
Query OK, 0 row(s) affected (0.036077s)

Delete Task

Syntax

DROP XNODE TASK id | 'name'

Example

taos> DROP XNODE TASK 3;
Drop OK, 0 row(s) affected (0.038191s)

Job Management

Job is the execution shard of a Task, supporting both manual and automatic load balancing.

View Jobs

Syntax

SHOW XNODE JOBS

Example

taos> SHOW XNODE JOBS\G;
*************************** 1.row ***************************
       id: 1
  task_id: 3
   config: config_json
      via: -1
 xnode_id: 11
   status: running
   reason: NULL
create_time: 2025-12-14 02:52:31.281
update_time: 2025-12-14 02:52:31.281
Query OK, 1 row(s) in set (0.004714s)

Manual Rebalance

Syntax

REBALANCE XNODE JOB jid WITH XNODE_ID xnodeId;

Syntax note: Manual rebalance currently only supports the xnode_id parameter, which must include xnode id information.

Example

taos> REBALANCE XNODE JOB 1 WITH xnode_id 1;
Query OK, 0 row(s) affected (0.011808s)

Automatic Rebalance

Syntax

REBALANCE XNODE JOBS [ WHERE job_conditions ]

Syntax note: WHERE job_conditions is optional, used to filter job data that meets the conditions. Functions are not supported, all fields that appear in the SHOW XNODE JOBS command are supported. Without a WHERE condition statement, it means all jobs will undergo automatic load balancing.

Example

taos> REBALANCE XNODE JOBS WHERE id>1;
Query OK, 0 row(s) affected (0.014246s)

taos> REBALANCE XNODE JOBS WHERE task_id=1 and (xnode_id=3 or xnode_id=4);
Query OK, 0 row(s) affected (0.007237s)

taos> REBALANCE XNODE JOBS;
Query OK, 0 row(s) affected (0.023245s)

Agent Management

The Agent node serves as the data collection and forwarding unit in the data synchronization service, responsible for collecting data and forwarding it to Xnode nodes.

Create Agent

Syntax

CREATE XNODE AGENT 'name' [WITH agent_options]

agent_options:
  [STATUS 'status']

Parameters

name: Name of the Agent node
status: Specifies the initial status using the WITHclause

Example

taos> create xnode agent 'a1';
Create OK, 0 row(s) affected (0.013910s)

taos> create xnode agent 'a2' with status 'running';
Create OK, 0 row(s) affected (0.013414s)

Query Agent

Syntax

SHOW XNODE AGENTS

Example

taos> show xnode agents\G;
*************************** 1.row ***************************
         id: 1
       name: a1
      token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjgxODI3MDEzNjQsInN1YiI6MX0.FP5rfzQplBrJrbV7Dj_R8fCpiN5uLaADegcnqExwepg
     status: NULL
create_time: 2026-01-12 09:51:41.364
update_time: 2026-01-12 09:51:41.364

Update Agent

Syntax

ALTER XNODE AGENT agent_id WITH alter_options

alter_options {
  STATUS 'status'
  | NAME 'name'
}

Parameters

name: New name for the Agent node
status: New status using the WITHclause

Example

taos> alter xnode agent 1 with name 'test1';
Query OK, 0 row(s) affected (0.008387s)

taos> alter xnode agent 'a2' with name 'test2' status 'online';
Query OK, 0 row(s) affected (0.008685s)

Delete Agent

Syntax

DROP XNODE AGENT agent_id

Parameters

agent_id: ID of the Agent node

Example

taos> drop xnode agent 1;
Drop OK, 0 row(s) affected (0.012281s)

Xnode Management​

Create Xnode​

Syntax​

Parameter Description​

Example​

View Xnodes​

Syntax​

Example​

Drain Xnode​

Syntax​

Parameter Description​

Example​

Delete Xnode​

Syntax​

Parameter Description​

Example​

Task Management​

Create Task​

Syntax​

Parameter Description​

Example​

View Tasks​

Syntax​

Example​

Start Task​

Syntax​

Example​

Stop Task​

Syntax​

Example​

Modify Task​

Syntax​

Example​

Delete Task​

Syntax​

Example​

Job Management​

View Jobs​

Syntax​

Example​

Manual Rebalance​

Syntax​

Example​

Automatic Rebalance​

Syntax​

Example​

Agent Management​

Create Agent​

Syntax​

Parameters​

Example​

Query Agent​

Syntax​

Example​

Update Agent​

Syntax​

Parameters​

Example​

Delete Agent​

Syntax​

Parameters​

Example​

Support and Feedback

Xnode Management

Create Xnode

Syntax

Parameter Description

Example

View Xnodes

Syntax

Example

Drain Xnode

Syntax

Parameter Description

Example

Delete Xnode

Syntax

Parameter Description

Example

Task Management

Create Task

Syntax

Parameter Description

Example

View Tasks

Syntax

Example

Start Task

Syntax

Example

Stop Task

Syntax

Example

Modify Task

Syntax

Example

Delete Task

Syntax

Example

Job Management

View Jobs

Syntax

Example

Manual Rebalance

Syntax

Example

Automatic Rebalance

Syntax

Example

Agent Management

Create Agent

Syntax

Parameters

Example

Query Agent

Syntax

Example

Update Agent

Syntax

Parameters

Example

Delete Agent

Syntax

Parameters

Example