The CockroachDB connector is a Palantir-provided driver for CockroachDB.
To create a new CockroachDB source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for CockroachDB-specific configuration and networking. For the complete property reference, see the official CockroachDB driver documentation ↗.
The CockroachDB connector is in the beta phase of development and may not be available on your enrollment. Functionality may change during active development.
| Capability | Status |
|---|---|
| Exploration | 🟡 Beta |
| Batch syncs | 🟡 Beta |
| Incremental | 🟡 Beta |
| Table exports | 🟡 Beta |
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
Database ↗ | Mandatory | The name of the Cockroach database. | — |
Password ↗ | Mandatory | Specifies the password of the authenticating user account. | — |
Port ↗ | Mandatory | The port number of the CockroachDB server. | 26257 |
Server ↗ | Mandatory | The host name or IP address of the server. | localhost |
User ↗ | Mandatory | Specifies the user ID of the authenticating CockroachDB user account. | — |
UseSSL ↗ | Mandatory | Whether SSL is enabled. | TRUE |
Cluster ↗ | Recommended | The name of the CockroachDB cluster. | — |
The table below lists the domains that the source must be able to access to run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead. The agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| <Server>:<Port> | Always. Server and Port connection properties (default: localhost:26257) |
This connector supports table exports. Learn how to set up a table export.