tb connection¶
Manage your data connections. Global options apply to this command. See Global options.
Connections are configured through .connection files. See Connection files.
Subcommands¶
The following subcommands are available:
| Subcommand | Description |
|---|---|
| create TYPE | Create a new connection. Supported values are: kafka, gcs, s3, and dynamodb. |
| ls | Lists all connections in the project. |
tb connection create kafka¶
Creates a Kafka connection.
| Option | Description |
|---|---|
| --connection-name TEXT | The name of the connection to identify it in Tinybird. |
| --bootstrap-servers TEXT | Kafka bootstrap server in the form mykafka.mycloud.com:9092. |
| --key TEXT | Key or user. |
| --secret TEXT | Secret or password. |
| --auto-offset-reset TEXT | Offset reset. Can be latest or earliest. Default: latest. |
| --schema-registry-url TEXT | Avro Confluent Schema Registry URL. |
| --sasl-mechanism TEXT | Authentication method for connection-based protocols. Default: PLAIN. |
| --security-protocol TEXT | Security protocol for connection-based protocols. Default: SASL_SSL. |
| --ssl-ca-pem TEXT | Path or content of the CA certificate file in PEM format. |
| --oauthbearer-aws-external-id TEXT | Pre-shared external ID for the AWS assume-role call. Only for OAUTHBEARER with AWS. |
tb connection ls¶
Lists connections.
| Option | Description |
|---|---|
| --service TEXT | Filter by service. |
Environment support¶
| Environment | Supported | Description |
|---|---|---|
--local | ✓ Yes (default) | Manages connections in Tinybird Local. |
--cloud | ✓ Yes | Manages connections in Tinybird Cloud. |
--branch=BRANCH_NAME | ✓ Yes | Manages connections in a branch. |