CockroachDB

The CockroachDB data source connector connects Prisma to a CockroachDB database server.

Example

To connect to a CockroachDB database server, you need to configure a datasource block in your Prisma schema file:

schema.prisma
1datasource db {
2  provider = "cockroachdb"
3  url      = env("DATABASE_URL")
4}

The fields passed to the datasource block are:

• provider: Specifies the cockroachdb data source connector.
• url: Specifies the connection URL for the CockroachDB database server. In this case, an environment variable is used to provide the connection URL.

Connection details

CockroachDB uses the PostgreSQL format for its connection URL. See the PostgreSQL connector documentation for details of this format, and the optional arguments it takes.

Differences between CockroachDB and PostgreSQL

The following table lists differences between CockroachDB and PostgreSQL:

Type mapping limitations in CockroachDB

The CockroachDB connector maps the scalar types from the Prisma data model to native column types. These native types are mostly the same as for PostgreSQL — see the PostgreSQL connector documentation for details. However, there are some limitations, listed below.

Alternatively, see the Prisma schema reference for type mappings organized by Prisma type.

Other limitations

The following table lists any other current known limitations of CockroachDB compared to PostgreSQL:

Type mapping between CockroachDB and the Prisma schema

The CockroachDB connector maps the scalar types from the Prisma data model as follows to native column types:

Alternatively, see the Prisma schema reference for type mappings organized by Prisma type.

schema.prisma
1model Device {
2  id       BigInt                  @id @default(autoincrement())
3  interval Unsupported("INTERVAL")
4}