Skip to Content

Supported connectors

Connect CockroachDB

Connect a CockroachDB cluster.

Before you start

  • You are an Admin or a Developer, or your role has the datasource Connect permission.
  • Your firewall allows Databrain’s outbound IP on the database port. The form shows the IP under Setup guide > Allow the outbound IP. See Allow Databrain’s IP.
  • You have a SQL user with read access to the schemas you want to use.

Connect

  1. Go to Data Studio > Datasources and select Connect data source.

    Datasources page with the Connect data source button outlined
    Connect data source is at the top right of the Datasources page.
  2. Select CockroachDB. You can type the name in Search connectors.

    Add datasource page with the CockroachDB tile outlined
    The CockroachDB tile on the Add datasource page.
  3. Fill in the form:

    FieldWhat to enter
    Connection stringOptional. Paste a postgresql:// URL to fill the fields below. The URL is not saved.
    Datasource nameHow this datasource appears in lists and pickers, for example Production warehouse.
    Host, PortThe cluster host and port. Port defaults to 26257.
    Database NameThe database you want to read from.
    Username, PasswordThe SQL user and its password.
    SchemasThe schemas to sync, case sensitive. Defaults to public.
    SSL modeTurn on if the cluster accepts only encrypted connections. CockroachDB Cloud does.
    SSH Tunneldisable for a direct connection. Choose enable to connect through a bastion host, then enter SSH Host, SSH Port (22), Username and Private key (OpenSSH or PEM).
  4. Select Connect datasource.

Connect CockroachDB form with the connect button outlined and the Setup guide on the right
Fill in the form, then select the button at the bottom. The Setup guide on the right lists the grants and where each value comes from.

Databrain checks the connection and reads your schema. You see Step 3 of 3 with Model your data. Next, create a datamart.

Grant read access

The user needs SELECT on the tables you want to model, and read access to information_schema so Databrain can read the schema. Replace the placeholders:

GRANT USAGE ON SCHEMA <schema> TO <user>;
GRANT SELECT ON ALL TABLES IN SCHEMA <schema> TO <user>;

If something goes wrong

If the check fails, the datasource stays on the form with Needs credentials. Fix the field the message names and select Connect datasource again.

  • The database did not answer in time. A firewall blocks Databrain. Allow the outbound IP on the database port.
  • The database rejected these credentials. Check the username and password, and that the user can sign in from a remote host.
  • The credentials worked, but the user cannot read the catalogue. Run the grants above.

On this page