Database Connectors
      Back to home
      1. Seek Connect Help Center
      2. Database Connectors

      CockroachDB Source Connector

      CockroachDB

      Overview​

      The CockroachDB source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.

      Resulting schema​

      The CockroachDb source does not alter the schema present in your database. Depending on the destination connected to this source, however, the schema may be altered. See the destination's documentation for more details.

      Data type mapping​

      CockroachDb data types are mapped to the following data types when synchronizing data:

      Note: arrays for all the above types as well as custom types are supported, although they may be de-nested depending on the destination.

      Features​

      Getting started​

      Requirements​

      1. CockroachDb v1.15.x or above
      2. Allow connections from Seek Connect to your CockroachDb database (if they exist in separate VPCs)
      3. Create a dedicated read-only Seek Connect user with access to all tables needed for replication

      Setup guide​

      1. Make sure your database is accessible from the machine running Seek Connect​

      This is dependent on your networking setup. The easiest way to verify if Seek is able to connect to your CockroachDb instance via the check connection tool in the UI.

      2. Create a dedicated read-only user with access to the relevant tables (Recommended but optional)​

      This step is optional but highly recommended to allow for better permission control and auditing. Alternatively, you can use Seek Connect with an existing user in your database.

      To create a dedicated database user, run the following commands against your database: 

      CREATE USER connect PASSWORD 'your_password_here';

      Then give it access to the relevant schema: 

      GRANT USAGE ON SCHEMA <schema_name> TO connect

      Note that to replicate data from multiple CockroachDb schemas, you can re-run the command above to grant access to all the relevant schemas, but you'll need to set up multiple sources connecting to the same db on multiple schemas.

      Next, grant the user read-only access to the relevant tables. The simplest way is to grant read access to all tables in the schema as follows: 

      GRANT SELECT ON ALL TABLES IN SCHEMA <schema_name> TO connect;
      # Allow connect user to see tables created in the future

      ALTER DEFAULT PRIVILEGES IN SCHEMA <schema_name> GRANT SELECT ON TABLES TO connect;

      3. That's it!​

      Your database user should now be ready for use with Seek Connect.