Skip to main content

Connect

Opens a connection to TiDB Cloud and returns a Client ID.

This node is also exposed as an AI Agent tool.

This node has 1 input port and 1 output port.

Common Properties​

Every node shares these.

  • Name — the node's display name on the canvas.
  • Color — the node's colour on the canvas.
  • Delay Before (sec) — wait this long before the node runs.
  • Delay After (sec) — wait this long after the node runs.
  • Continue On Error — carry on instead of failing the flow. Defaults to false.
info

When Continue On Error is true the error is not raised at all, so a Catch node will not see it either.

Outputs​

PropertyFieldDescription
Client IDoutClientIDUnique identifier for this database connection

Options​

PropertyFieldDescription
CredentialsoptCredentialsTiDB Cloud connection credentials

Requirements​

  • TiDB Cloud Connection — TiDB Cloud database connection credentials (MySQL protocol)
    • type — Database Type (hidden, optional)
    • server — Server (text, required). TiDB Cloud hostname or IP address
    • port — Port (text, optional). MySQL protocol port (default: 4000)
    • database — Database (text, optional). Database name (default: test)
    • username — Username (text, required). Database username (for TiDB Cloud Serverless use prefix.root format)
    • password — Password (password, optional). Database password
    • tls_enabled — TLS Enabled (select, optional). Enable TLS for connection (required for TiDB Cloud)

Store these in a Vault and reference the vault item from the node, rather than typing the secret into the property.

Disconnect · Execute Query · Select · Insert · Update · Delete · Toolkit

See also​