Skip to main content

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:

CockroachDb TypeResulting TypeNotes
bigintinteger
bitboolean
booleanboolean
characterstring
character varyingstring
datestring
double precisionstring
enumnumber
inetstring
intinteger
jsonstring
jsonbstring
numericnumber
smallintinteger
textstring
time with timezonestringmay be written as a native date type depending on the destination
time without timezonestringmay be written as a native date type depending on the destination
timestamp with timezonestringmay be written as a native date type depending on the destination
timestamp without timezonestringmay be written as a native date type depending on the destination
uuidstring

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

FeatureSupportedNotes
Full Refresh SyncYes
Incremental SyncYes
Change Data CaptureNo
SSL SupportYes

Getting started

Requirements

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

Setup guide

1. Make sure your database is accessible from the machine running Airbyte

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

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

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

CREATE USER airbyte PASSWORD 'your_password_here';

Then give it access to the relevant schema:

GRANT USAGE ON SCHEMA <schema_name> TO airbyte

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 airbyte;

# Allow airbyte user to see tables created in the future
ALTER DEFAULT PRIVILEGES IN SCHEMA <schema_name> GRANT SELECT ON TABLES TO airbyte;

3. That's it!

Your database user should now be ready for use with Airbyte.

Changelog

VersionDatePull RequestSubject
0.1.122022-04-2912480Query tables with adaptive fetch size to optimize JDBC memory consumption
0.1.112022-04-0611729Bump mina-sshd from 2.7.0 to 2.8.0
0.1.102022-02-2410235Fix Replication Failure due Multiple portal opens
0.1.92022-02-2110242Fixed cursor for old connectors that use non-microsecond format. Now connectors work with both formats
0.1.82022-02-1810242Updated timestamp transformation with microseconds
0.1.72022-02-1410256Add -XX:+ExitOnOutOfMemoryError JVM option
0.1.62022-02-0810173Improved discovering tables in case if user does not have permissions to any table
0.1.52021-12-249004User can see only permmited tables during discovery
0.1.42021-12-248958Add support for JdbcType.ARRAY
0.1.32021-10-107819Fixed Datatype errors during Cockroach DB parsing
0.1.22021-08-134699Added json config validator

Changelog source-cockroachdb-strict-encrypt

VersionDatePull RequestSubject
0.1.132022-06-1713864Updated stacktrace format for any trace message errors
0.1.122022-04-2912480Query tables with adaptive fetch size to optimize JDBC memory consumption
0.1.82022-04-0611729Bump mina-sshd from 2.7.0 to 2.8.0
0.1.62022-02-2110242Fixed cursor for old connectors that use non-microsecond format. Now connectors work with both formats
0.1.52022-02-1810242Updated timestamp transformation with microseconds
0.1.42022-02-1410256Add -XX:+ExitOnOutOfMemoryError JVM option
0.1.32022-02-0810173Improved discovering tables in case if user does not have permissions to any table
0.1.22021-12-249004User can see only permmited tables during discovery
0.1.12021-12-248958Add support for JdbcType.ARRAY
0.1.02021-11-237457CockroachDb source: Add only encrypted version for the connector