CockroachDB Connection Details
Introduction
Connector Version
This documentation is based on version 25.0.9368 of the connector.
Get Started
CockroachDB Version Support
The connector enables standards-based access to Cockroach DB version 2.0 and later.
Establish a Connection
Connect to CockroachDB
Set the following to connect to data.
- Server: The host name or IP address of the server.
- Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
- Database: The name of the Cockroach database. If not specified, the connector connects to the user's default database.
- User: The Cockroach DB user account used to authenticate.
- Password: The password used to authenticate the user.
Fine-Tuning Data Access
Fine Tuning Data Access
You can use the following properties to gain more control over the data returned from CockroachDB:
- AllowPreparedStatement: Set to true to allow the preparation of a query statement before its execution.
Preparing the query avoids recompiling the same query over and over, but requires that the connection is left open while the statement is prepared. - TimeZone: The time zone to be used for the current session.
- UseSSL: This determines whether the connector will attempt to negotiate TLS/SSL connections to the server.
Important Notes
Configuration Files and Their Paths
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features
This section details a selection of advanced features of the CockroachDB connector.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats. For further information, see the SSLServerCert property under "Connection String Options".
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.
Log
For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.
SSL Configuration
Customize the SSL Configuration
To enable TLS, set UseSSL to True.
With this configuration, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
Client SSL Certificates
The CockroachDB connector also supports setting client certificates. Set the following to connect using a client certificate.
- SSLClientCert: The name of the certificate store for the client certificate.
- SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
- SSLClientCertPassword: The password for the TLS/SSL client certificate.
- SSLClientCertSubject: The subject of the TLS/SSL client certificate.
Data Type Mapping
Data Type Mappings
The connector maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
| CockroachDB | Schema |
|---|---|
abstime |
string |
aclitem |
string |
bigint |
long |
bigserial |
long |
bit varying |
string |
bit |
string |
boolean |
bool |
box |
string |
bytea |
binary |
char |
string |
character varying |
string |
character |
string |
cid |
string |
cidr |
string |
circle |
string |
date |
date |
daterange |
string |
double precision |
float |
gtsvector |
string |
inet |
string |
int2vector |
string |
int4range |
string |
int8range |
string |
integer |
int |
json |
string |
jsonb |
binary |
line |
string |
lseg |
string |
macaddr8 |
string |
macaddr |
string |
money |
decimal |
name |
string |
numeric |
decimal |
numrange |
string |
oid |
string |
oidvector |
string |
path |
string |
pg_dependencies |
string |
pg_lsn |
string |
pg_ndistinct |
string |
pg_node_tree |
string |
point |
string |
polygon |
string |
real |
float |
refcursor |
string |
regclass |
string |
regconfig |
string |
regdictionary |
string |
regnamespace |
string |
regoper |
string |
regoperator |
string |
regproc |
string |
regprocedure |
string |
regrole |
string |
regtype |
string |
reltime |
string |
serial |
int |
smallint |
int |
smallserial |
int |
smgr |
string |
text |
string |
tid |
string |
time with time zone |
string |
time without time zone |
time |
timestamp with time zone |
datetime |
timestamp without time zone |
datetime |
tinterval |
string |
tsquery |
string |
tsrange |
string |
tstzrange |
string |
tsvector |
string |
txid_snapshot |
string |
uuid |
string |
xid |
string |
xml |
string |
Advanced Configurations Properties
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
| Property | Description |
|---|---|
Server |
The host name or IP address of the server. |
Port |
The port number of the CockroachDB server. |
Database |
The name of the Cockroach database. |
User |
Specifies the user ID of the authenticating CockroachDB user account. |
Password |
Specifies the password of the authenticating user account. |
UseSSL |
Whether SSL is enabled. |
Cluster |
The name of the CockroachDB cluster. |
| Property | Description |
|---|---|
SSLClientCert |
Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection. |
SSLClientCertType |
Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source. |
SSLClientCertPassword |
Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access. |
SSLClientCertSubject |
Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store. |
SSLServerCert |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
|---|---|
Location |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
BrowsableSchemas |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables |
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC. |
Views |
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
| Property | Description |
|---|---|
AllowPreparedStatement |
Allow the preparation of a query statement before its execution. |
FetchResultSetMetadata |
This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server. |
IncludeTableTypes |
If set to true, the provider will query for the types of individual tables and views. |
MaxRows |
Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
Other |
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
QueryPassthrough |
This option passes the query to the CockroachDB server as is. |
Timeout |
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
TimeZone |
The time zone for the current session. |
Authentication
This section provides a complete list of authentication properties you can configure.
| Property | Description |
|---|---|
Server |
The host name or IP address of the server. |
Port |
The port number of the CockroachDB server. |
Database |
The name of the Cockroach database. |
User |
Specifies the user ID of the authenticating CockroachDB user account. |
Password |
Specifies the password of the authenticating user account. |
UseSSL |
Whether SSL is enabled. |
Cluster |
The name of the CockroachDB cluster. |
Server
The host name or IP address of the server.
Data Type
string
Default Value
localhost
Remarks
The host name or IP of the server hosting the CockroachDB Database. If not set, the default value "localhost" is used.
Port
The port number of the CockroachDB server.
Data Type
string
Default Value
26257
Remarks
The port number of the Server hosting the CockroachDB Database. If not specified, the default port number 26257 is used.
Database
The name of the Cockroach database.
Data Type
string
Default Value
""
Remarks
The database to connect to when connecting to the CockroachDB Server. If a database is not provided, the default database will be used.
User
Specifies the user ID of the authenticating CockroachDB user account.
Data Type
string
Default Value
""
Remarks
The authenticating server requires both User and Password to validate the user's identity.
Password
Specifies the password of the authenticating user account.
Data Type
string
Default Value
""
Remarks
The authenticating server requires both User and Password to validate the user's identity.
UseSSL
Whether SSL is enabled.
Data Type
bool
Default Value
false
Remarks
This field sets whether the connector will attempt to negotiate TLS/SSL connections to the server. By default, the connector checks the server's certificate against the system's trusted certificate store. To specify another certificate, set SSLServerCert.
Cluster
The name of the CockroachDB cluster.
Data Type
string
Default Value
""
Remarks
The cluster to connect to when connecting to the CockroachDB Server. Not specified by default.
SSL
This section provides a complete list of SSL properties you can configure.
| Property | Description |
|---|---|
SSLClientCert |
Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection. |
SSLClientCertType |
Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source. |
SSLClientCertPassword |
Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access. |
SSLClientCertSubject |
Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store. |
SSLServerCert |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
SSLClientCert
Specifies the TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). This property works in conjunction with other SSL-related properties to establish a secure connection.
Data Type
string
Default Value
""
Remarks
This property specifies the client certificate store for SSL Client Authentication. Use this property alongside SSLClientCertType, which defines the type of the certificate store, and SSLClientCertPassword, which specifies the password for password-protected stores. When SSLClientCert is set and SSLClientCertSubject is configured, the driver searches for a certificate matching the specified subject.
Certificate store designations vary by platform. On Windows, certificate stores are identified by names such as MY (personal certificates), while in Java, the certificate store is typically a file containing certificates and optional private keys.
The following are designations of the most common User and Machine certificate stores in Windows:
| Property | Description |
|---|---|
MY |
A certificate store holding personal certificates with their associated private keys. |
CA |
Certifying authority certificates. |
ROOT |
Root certificates. |
SPC |
Software publisher certificates. |
For PFXFile types, set this property to the filename. For PFXBlob types, set this property to the binary contents of the file in PKCS12 format.
SSLClientCertType
Specifies the type of key store containing the TLS/SSL client certificate for SSL Client Authentication. Choose from a variety of key store formats depending on your platform and certificate source.
Possible Values
USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB, BCFKSFILE, BCFKSBLOB
Data Type
string
Default Value
USER
Remarks
This property determines the format and location of the key store used to provide the client certificate. Supported values include platform-specific and universal key store formats. The available values and their usage are:
| Property | Description |
|---|---|
USER - default |
For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
MACHINE |
For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
PFXFILE |
The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB |
The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE |
The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
JKSBLOB |
The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
PEMKEY_FILE |
The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB |
The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE |
The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB |
The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE |
The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB |
The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE |
The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE |
The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
XMLFILE |
The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB |
The certificate store is a string that contains a certificate in XML format. |
BCFKSFILE |
The certificate store is the name of a file that contains an Bouncy Castle keystore. |
BCFKSBLOB |
The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore. |
SSLClientCertPassword
Specifes the password required to access the TLS/SSL client certificate store. Use this property if the selected certificate store type requires a password for access.
Data Type
string
Default Value
""
Remarks
This property provides the password needed to open a password-protected certificate store. This property is necessary when using certificate stores that require a password for decryption, as is often recommended for PFX or JKS type stores.
If the certificate store type does not require a password, for example USER or MACHINE on Windows, this property can be left blank. Ensure that the password matches the one associated with the specified certificate store to avoid authentication errors.
SSLClientCertSubject
Specifes the subject of the TLS/SSL client certificate to locate it in the certificate store. Use a comma-separated list of distinguished name fields, such as CN=www.server.com, C=US. The wildcard * selects the first certificate in the store.
Data Type
string
Default Value
*
Remarks
This property determines which client certificate to load based on its subject. The connector searches for a certificate that exactly matches the specified subject. If no exact match is found, the connector looks for certificates containing the value of the subject. If no match is found, no certificate is selected.
The subject should follow the standard format of a comma-separated list of distinguished name fields and values. For example, CN=www.server.com, OU=Test, C=US. Common fields include the following:
| Field | Meaning |
|---|---|
CN |
Common Name. This is commonly a host name like www.server.com. |
O |
Organization |
OU |
Organizational Unit |
L |
Locality |
S |
State |
C |
Country |
E |
Email Address |
Note
If any field contains special characters, such as commas, the value must be quoted. For example: CN="Example, Inc.", C=US.
SSLServerCert
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
Data Type
string
Default Value
""
Remarks
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
|---|---|
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema
This section provides a complete list of schema properties you can configure.
| Property | Description |
|---|---|
Location |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
BrowsableSchemas |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables |
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA, TableB, TableC. |
Views |
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
Data Type
string
Default Value
%APPDATA%\CockroachDB Data Provider\Schema
Remarks
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\CockroachDB Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
|---|---|
Windows |
The value of the APPDATA environment variable |
Mac |
~/Library/Application Support |
Linux |
~/.config |
BrowsableSchemas
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type
string
Default Value
""
Remarks
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Tables
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.
Data Type
string
Default Value
""
Remarks
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note
If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Views
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type
string
Default Value
""
Remarks
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note
If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
Miscellaneous
This section provides a complete list of miscellaneous properties you can configure.
| Property | Description |
|---|---|
AllowPreparedStatement |
Allow the preparation of a query statement before its execution. |
FetchResultSetMetadata |
This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server. |
IncludeTableTypes |
If set to true, the provider will query for the types of individual tables and views. |
MaxRows |
Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
Other |
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
QueryPassthrough |
This option passes the query to the CockroachDB server as is. |
Timeout |
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
TimeZone |
The time zone for the current session. |
AllowPreparedStatement
Allow the preparation of a query statement before its execution.
Data Type
bool
Default Value
true
Remarks
If the AllowPreparedStatement property is set to false, statements are parsed each time they are executed. Setting this property to false can be useful if you are executing many different queries only once.
If you are executing the same query repeatedly, you will generally see better performance by leaving this property at the default, true. Preparing the query avoids recompiling the same query over and over. However, prepared statements also require the connector to keep the connection active and open while the statement is prepared.
FetchResultSetMetadata
This field sets whether the provider retrieves metadata pertaining to the schema and table name for resultset columns returned by the server.
Data Type
bool
Default Value
false
Remarks
By default, the connector will not request that the server provides detailed information about resultset columns like the table name or schema name. It requires issuing additional metadata queries via connector , and it may affect query performance essentially in some scenarios. Consider setting this property to True when you need such detailed descriptive information for the resultset columns.
IncludeTableTypes
If set to true, the provider will query for the types of individual tables and views.
Data Type
bool
Default Value
false
Remarks
If set to true, the connector will query Cockroach DB server for the types of individual tables and views.
MaxRows
Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Data Type
int
Default Value
-1
Remarks
This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.
When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Other
Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Data Type
string
Default Value
""
Remarks
This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.
Note
It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting
| Property | Description |
|---|---|
DefaultColumnSize |
Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT=True |
Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
RecordToFile=filename |
Records the underlying socket data transfer to the specified file. |
QueryPassthrough
This option passes the query to the CockroachDB server as is.
Data Type
bool
Default Value
false
Remarks
When this is set, queries are passed through directly to CockroachDB.
Timeout
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
Data Type
int
Default Value
30
Remarks
This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond the timeout value if each paging call completes within the timeout limit.
Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
TimeZone
The time zone for the current session.
Data Type
string
Default Value
""
Remarks
If the TimeZone property is not set, the connector uses the client system time zone. Setting this property can be useful when you need the server to convert "time with time zone" and "timestamp with timezone" values to a time zone other than the client's system time zone.