Managing Data Source Configs
Data source configs store the credentials and connection details for external systems. Users create data connections that reference these configs to access specific tables, queries, or topics.
Required role: Admin
Adding a config
- Go to Organization Settings → Configs tab.
- Click Add Config.
- Choose a type:
Tulip
| Field | Description |
|---|---|
| Name | A label for this config (e.g., "Production Tulip") |
| Tulip URL | Your Tulip instance URL |
| Auth Token | Bearer token for Tulip API access |
| Workspace ID | (Optional) Tulip workspace to scope to |
| Cache Table ID | The Tulip table used for internal data storage |
SQL
| Field | Description |
|---|---|
| Name | A label for this config (e.g., "Warehouse DB") |
| Driver | Database type: PostgreSQL or MSSQL |
| Host | Database server hostname or IP |
| Port | Database port |
| Database | Database name |
| Username | Database login username |
| Password | Database login password |
| Use SSL | Enable SSL for the connection |
MQTT
| Field | Description |
|---|---|
| Name | A label for this config (e.g., "Factory MQTT Broker") |
| Broker URL | WebSocket endpoint (ws:// or wss://) |
| Username | (Optional) Broker login username |
| Password | (Optional) Broker login password |
| Client ID | (Optional) MQTT client identifier |
- Click Save.
Testing a config
After creating or editing a config, click Test Connection to verify that the credentials work and the system is reachable. You'll see a success or failure message with details.
- Tulip connections are tested client-side (your browser connects directly).
- SQL and MQTT connections are tested server-side (the worker connects on your behalf).
Setting a primary config
One Tulip config must be designated as the primary config. The primary config is used for internal data storage (widgets, dashboards, and connections are stored in its cache table).
To change the primary config, click the star icon next to a Tulip config. Only Tulip configs can be primary.
Editing and deleting
- Click a config to edit its settings.
- Delete a config by clicking the delete button. Deleting a config will make any data connections that reference it stop working.
User access
By default, only admins can see all configs. Members must be granted access to specific configs before they can create data connections that use them.