CockroachDB's support of the PostgreSQL wire protocol makes most PostgreSQL drivers, ORM frameworks, and other types of third-party database tools designed for PostgreSQL compatible with CockroachDB. Cockroach Labs guarantees official support for a set of popular PostgreSQL tools, which we list on this page.
Support levels
Cockroach Labs has partnered with open-source projects, vendors, and individuals to offer the following levels of support with third-party tools:
- Full support indicates that Cockroach Labs is committed to maintaining compatibility with the vast majority of the tool's features. CockroachDB is regularly tested against the latest version documented in the table below.
- Partial support indicates that Cockroach Labs is working towards full support for the tool. The primary features of the tool are compatible with CockroachDB (e.g., connecting and basic database operations), but full integration may require additional steps, lack support for all features, or exhibit unexpected behavior.
Unless explicitly stated, support for a driver or data access framework does not include automatic, client-side transaction retry handling. For client-side transaction retry handling samples, see Example Apps.
If you encounter problems using CockroachDB with any of the tools listed on this page, please open an issue with details to help us make progress toward better support.
For a list of tools supported by the CockroachDB community, see Third-Party Tools Supported by the Community.
Drivers
| Language | Driver | Latest tested version | Support level | CockroachDB adapter | Tutorial |
|---|---|---|---|---|---|
| C | libpq | PostgreSQL 13 | Beta | N/A | N/A |
| C# (.NET) | Npgsql | 4.1.3.1 | Beta | N/A | Build a C# App with CockroachDB (Npgsql) |
| Go | pgx pq |
v5.3.1 (use latest version of CockroachDB adapter) v1.10.5 |
Full Full |
crdbpgx(includes client-side transaction retry handling) N/A |
Build a Go App with CockroachDB (pgx) Build a Go App with CockroachDB (pq) |
| Java | JDBC | REL42.7.3 | Full | N/A | |
| JavaScript | pg | 8.2.1 | Full | N/A | Build a Node.js App with CockroachDB (pg) |
| Python | psycopg2 | 2.8.6 | Full | N/A | Build a Python App with CockroachDB (psycopg2) |
| Ruby | pg | v1.4.6 | Full | N/A | Build a Ruby App with CockroachDB (pg) |
Data access frameworks (e.g., ORMs)
| Language | Framework | Latest tested version | Support level | CockroachDB adapter | Tutorial |
|---|---|---|---|---|---|
| Go | GORM go-pg upper/db |
v1.24.1 v10.9.0 v4 |
Full Full Full |
crdbgorm(includes client-side transaction retry handling) N/A N/A |
Build a Go App with CockroachDB (GORM) N/A Build a Go App with CockroachDB (upper/db) |
| Java | Hibernate (including Hibernate Spatial) jOOQ MyBatis |
6.6.0 (must be 5.4.19) 3.13.2 (must be 3.13.0) 3.5.5 |
Full Full Full |
N/A N/A N/A |
|
| JavaScript/TypeScript | Sequelize TypeORM |
v6.0.5 (use latest version of CockroachDB adapter) 0.3.17 |
Full Full |
sequelize-cockroachdbN/A |
|
| Ruby | ActiveRecord RGeo/RGeo-ActiveRecord |
7.2.1 (use latest version of CockroachDB adapter) |
Full | activerecord-cockroachdb-adapter(includes client-side transaction retry handling) |
|
| Python | Django (including GeoDjango) peewee SQLAlchemy |
4.1.x (use latest version of CockroachDB adapter) 3.13.3 0.7.13 1.4.17 (use latest version of CockroachDB adapter) |
Full Full Full Full |
django-cockroachdbN/A N/A sqlalchemy-cockroachdb(includes client-side transaction retry handling) |
Application frameworks
| Framework | Data access | Latest tested version | Support level | Tutorial |
|---|---|---|---|---|
| Spring | JDBC JPA (Hibernate) MyBatis |
See individual Java ORM or driver for data access version support. | See individual Java ORM or driver for data access support level. | Build a Spring App with CockroachDB (JDBC) Build a Spring App with CockroachDB (JPA) Build a Spring App with CockroachDB (MyBatis) |
Graphical user interfaces (GUIs)
| GUI | Latest tested version | Support level | Tutorial |
|---|---|---|---|
| DBeaver | 5.2.3 | Full | Visualize CockroachDB Schemas with DBeaver |
Integrated development environments (IDEs)
| IDE | Latest tested version | Support level | Tutorial |
|---|---|---|---|
| DataGrip | 2021.1 | Full | N/A |
| IntelliJ IDEA | 2021.1 | Full | Use IntelliJ IDEA with CockroachDB |
Schema migration tools
| Tool | Latest tested version | Support level | Tutorial |
|---|---|---|---|
| Alembic | 1.7 | Full | Migrate CockroachDB Schemas with Alembic |
| Flyway | 7.1.0 | Full | Migrate CockroachDB Schemas with Flyway |
| Liquibase | 4.2.0 | Full | Migrate CockroachDB Schemas with Liquibase |
Other tools
| Tool | Latest tested version | Support level | Tutorial |
|---|---|---|---|
| Flowable | 6.4.2 | Full | Getting Started with Flowable and CockroachDB (external) |
See also
Was this helpful?
