Connecting to CockroachDB

This section contains details for CockroachDB connections.

General information

FieldDescription
Data sourceCockroachDB
Supported versions42.5.1
Connection stringpostgresql://
Packaged?

Yes

Certified?

Yes

Supported features
Estimate job

Yes

Analyze data

Yes

Schedule

Yes

Processing capabilities
Pushdown

No

Spark agent

Yes

Yarn agent

Yes

Parallel JDBC

Yes

Java Platform version compatibility
JDK 8

Yes

JDK 11

Yes

Minimum user permissions

In order to bring your CockroachDB data into Collibra Data Quality & Observability, you need the following permissions.

  • Read access on your CockroachDB tables.
  • ROLE_ADMIN assigned to your user in Collibra DQ.

Recommended and required connection properties

RequiredConnection PropertyTypeValue

Yes

NameTextThe unique name of your connection. Ensure that there are no spaces in your connection name.

Yes

Connection URLString

The connection string path of your CockroachDB connection.

When referring to the example below, replace the ${value} sections of the connection URL with your actual value.

Example postgresql://${user}:${password}@free-tier.gcp-us-central1.cockroachlabs.cloud:26257/defaultdb?sslmode=verify-full&sslrootcert=$HOME/.postgresql/root.crt&options=--cluster%3Dnoisy-koala-3822

Yes

Driver NameString

The driver class name of your connection.

org.postgresql.Driver

Yes

PortInteger

The port number to establish a connection to the datasource.

The default port is 26257

No

Limit SchemasOption

Allows you to manage usage and restrict visibility to only the necessary schemas in the Explorer tree.

See Limiting schemas to learn how to limit schemas from the Connection Management page.

Note When you include a restricted schema in the query of a DQ Job, the query scope may be overwritten when the job runs. While only the schemas you selected when you set up the connection are shown in the Explorer menu, users are not restricted from running SQL queries on any schema from the data source.

No

Source NameStringN/A

No

Target AgentOptionThe Agent that submits your Spark job for processing.

Yes

Auth TypeOption

The method to authenticate your connection.

Note The configuration requirements are different depending on the Auth Type you select. See Authentication for more details on available authentication types.

No

PropertiesString

The configurable driver properties for your connection. Multiple properties must be comma delimited. For example, abc=123,test=true

Authentication

Select an authentication type from the dropdown menu. The options available in the dropdown menu are the currently supported authentication types for this data source.

RequiredFieldDescription

Yes

UsernameThe username of your CockroachDB account.

Yes

PrincipalThe Kerberos entity to authenticate and grant access to your connection.

Yes

PasswordThe password of your CockroachDB account.

Yes

Keytab

The file path of the keytab file that contains the encrypted key for a Kerberos principal.

Example /tmp/keytab/impala_user.keytab

Yes

Script

The file path that contains the script file that the password manager uses to interact with and authenticate a user account.

Example /tmp/keytab/cockroachdb_pwd_mgr.sh

No

Param $1Optional. An additional parameters to authenticate your CockroachDB connection.

No

Param $2Optional. An additional parameter to authenticate your CockroachDB connection.

No

Param $3Optional. An additional parameter to authenticate your CockroachDB connection.

Yes

TGT CacheThe ticket-granting ticket cache that stores the TGT to authenticate your connection.