Skip to main content

CockroachDB Connections

Cockroach DB is a cloud-native SQL database for building global and scalable cloud services that survive disasters. For more information, see


This connection is in early preview. It is read-only and available only in SaaS product editions. For more information on early previews, see Early Preview Connection Types.

Limitations and Requirements


During normal selection or import of an entire table, you may encounter an error indicating a problem with a specific column. Since some tables require filtering based on a particular column, data from them can only be ingested using custom SQL statements. In this case, the problematic column can be used as a filter in the WHERE clause of a custom SQL statement to ingest the table.

  • For more information, please consult the CData driver documentation for the specific table.

  • For more information on using custom SQL, see Create Dataset with SQL.


For filtering date columns, this connection type supports a set of literal functions on dates. You can use these to reduce the volume of data extracted from the database using a custom SQL query. For more information, see the pg_dateliteralfunctions.htm page in the driver documentation for this connection type.

  • Supports basic (User Name and Password) authentication.

  • You can list all tables under all databases if you have credentials for a particular database.

  • You must provide a SSL client certificate to connect to Cockroach DB in a secure mode.

Create Connection

via Cloud Portal

When you create the connection, please review the following properties and specify them accordingly:

Connection Property



The host name or IP address of the server.


The port number of the Cockroach DB server.


The name of the Cockroach DB database.

User Name

The Cockroach DB user account used to authenticate.


The password used to authenticate the user.

Connect String Options

The following default value sets the connection timeout in seconds:


Setting this value to 0 disables timeouts.

Default Column Data Type Inference

Leave this value as Enabled.

For more information, see the driver documentation

via API

Depending on your product edition, you can create connections of this type. Key information:

"vendor": "cockroachdb",
"vendorName": "Cockroachdb",
"type": "jdbc"

For more information, see

Coming soon.

Data Type Conversions

For more information, see the driver documentation