CockroachDB
Overview
Connect Superblocks to CockroachDB to build apps with read and write access to a CockroachDB database. Read data from a CockroachDB database and utilize it in API steps or UI components:
Save information to a CockroachDB database:
Setting up CockroachDB
1. Add integration
Select CockroachDB from the integrations page.
2. Configure settings
Fill out the form with the following settings:
| Setting | Required | Description |
|---|---|---|
| Name | TRUE | Name that will be displayed to users when selecting this integration in Superblocks |
| Host | TRUE | Hostname or IP address to connect to |
| Port | TRUE | Port to use when connecting to CockroachDB |
| Database Name | TRUE | Name of database to connect to |
| Database Username | TRUE | Username to use to connect |
| Database Password | TRUE | Password for database username |
| Enable SSL | FALSE | Connect via SSL if selected |
| Use a self-signed SSL certificate | FALSE | Provide Server CA, Client Key, and Client Cert if selected |
3. Test and save
Click Test Connection to check that Superblocks can connect to the data source.
info
If using Superblocks Cloud, add these Superblocks IPs to your allowlist (not necessary for On-Premise-Agent).
After connecting successfully, click Create to save the integration.
4. Set profiles
Optionally, configure different profiles for separate development environments.
success
CockroachDB connected Now you can use CockroachDB in any Application, Workflow, or Scheduled Job.
Creating CockroachDB steps
Connect to your CockroachDB integration from Superblocks by creating steps in Application APIs, Workflows and Scheduled Jobs. You can configure a Superblocks CockroachDB integration with read only, read/write, or write only users. You can then configure a Superblocks CockroachDB step to read from a database, as well as modify/delete data. To get started, enter your SQL query into the text area of the CockroachDB step. Then click "Run" to see the Result and Executed SQL statement below.
info
See our guide for setting up basic CRUD actions using CockroachDB
Use cases
Applications
Create an admin dashboard that reads from CockroachDB and other sources. Mix in APIs to allow support agents to refund orders, update shipping statuses, or transform large datasets in a single UI.
Workflows
Enrich customer order data within CockroachDB with shipping data from Snowflake or other datastores.
Scheduled Jobs
Post data from CockroachDB to a Slack channel on a daily basis for teams who need to see information on new bookings, but don't have access to the database.
Troubleshooting
Check out our guide on common errors across database integrations, in addition to Troubleshoot Common Problems. If you are encountering an error that you don't see in the guide, or the provided steps are insufficient to resolve the error, please contact us at help@superblocks.com.