# CockroachDB

<!-- BEGIN GENERATED:intro -->

The CockroachDB connector is a [Palantir-provided driver](../../data-integration/foundry-provided-drivers/index.md) for CockroachDB.

To create a new CockroachDB source, follow the [standard setup flow for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#setup), then use the sections below for CockroachDB-specific configuration and networking. For the complete property reference, see the [official CockroachDB driver documentation ↗](https://cdn.cdata.com/help/HJK/jdbc/pg_connectionj.htm).

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

:::callout{theme="neutral" title="Beta"}
The CockroachDB connector is in the [beta](../../platform-overview/development-life-cycle/index.md) phase of development and may not be available on your enrollment. Functionality may change during active development.
:::

## Supported capabilities

| Capability | Status |
|---|---|
| Exploration | 🟡 Beta |
| Batch syncs | 🟡 Beta |
| Incremental | 🟡 Beta |
| [Table exports](#table-exports) | 🟡 Beta |

<!-- END GENERATED:capabilities -->

<!-- BEGIN GENERATED:configuration -->

## Configuration

The properties below are mandatory or recommended.

| Property | Required? | Description | Default |
|---|---|---|---|
| [`Database` ↗](https://cdn.cdata.com/help/HJK/jdbc/RSBCockroachDB_p_Database.htm) | Mandatory | The name of the Cockroach database. | — |
| [`Password` ↗](https://cdn.cdata.com/help/HJK/jdbc/RSBCockroachDB_p_Password.htm) | Mandatory | Specifies the password of the authenticating user account. | — |
| [`Port` ↗](https://cdn.cdata.com/help/HJK/jdbc/RSBCockroachDB_p_Port.htm) | Mandatory | The port number of the CockroachDB server. | `26257` |
| [`Server` ↗](https://cdn.cdata.com/help/HJK/jdbc/RSBCockroachDB_p_Server.htm) | Mandatory | The host name or IP address of the server. | `localhost` |
| [`User` ↗](https://cdn.cdata.com/help/HJK/jdbc/RSBCockroachDB_p_User.htm) | Mandatory | Specifies the user ID of the authenticating CockroachDB user account. | — |
| [`UseSSL` ↗](https://cdn.cdata.com/help/HJK/jdbc/RSBCockroachDB_p_UseSSL.htm) | Mandatory | Whether SSL is enabled. | `TRUE` |
| [`Cluster` ↗](https://cdn.cdata.com/help/HJK/jdbc/RSBCockroachDB_p_Cluster.htm) | Recommended | The name of the CockroachDB cluster. | — |

<!-- END GENERATED:configuration -->

<!-- BEGIN GENERATED:networking -->

## Networking

The table below lists the domains that the source must be able to access to run.

For each domain, add a corresponding [egress policy](../../administration/configure-egress/index.md). If the source is hosted on-premises and not directly reachable from Foundry, use an [agent proxy egress policy](../../administration/configure-egress/index.md#agent-proxy-egress-policies) instead. The agent host itself must also be able to reach the listed domains. See [using an agent as a proxy](../../data-connection/agent-proxy/index.md) for details.

| Domain  | Required |
|--- |--- |
| \<Server>:\<Port> | Always. Server and Port connection properties (default: localhost:26257) |

<!-- END GENERATED:networking -->

<!-- BEGIN GENERATED:table-exports -->

## Table exports

This connector supports table exports. Learn how to [set up a table export](../../data-connection/export-overview/index.md#table-exports).

<!-- END GENERATED:table-exports -->