CockroachDB

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 ↗.

Configuration

The properties below are mandatory or recommended.

PropertyRequired?DescriptionDefault
DatabaseMandatoryThe name of the Cockroach database.
PasswordMandatorySpecifies the password of the authenticating user account.
PortMandatoryThe port number of the CockroachDB server.26257
ServerMandatoryThe host name or IP address of the server.localhost
UserMandatorySpecifies the user ID of the authenticating CockroachDB user account.
UseSSLMandatoryWhether SSL is enabled.TRUE
ClusterRecommendedThe name of the CockroachDB cluster.

Networking

The table below lists the domains that the source needs to be able to access in order to successfully 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.

DomainRequired
<Server>:<Port>Always. Server and Port connection properties (default: localhost:26257)