README.md

CockroachDB Driver Bundle for Symfony

CockroachDB Driver is a Doctrine DBAL Driver to handle incompatibilities with PostgreSQL. This package is meant to be used with (and requires) Symfony 6.0 or newer.

It is based on https://github.com/lapaygroup/doctrine-cockroachdb by Lapay Group.

CockroachDB Quick Setup Guide

• Linux Setup Guide
• Mac Setup Guide
• Windows Setup Guide

Usage

Connection configuration example using a DSN

# doctrine.yaml
doctrine:
    dbal:
        url: crdb://<user>@<host>:<port(26257)>/<dbname>?sslmode=verify-full&sslrootcert=<path-to-ca.crt>&sslcert=<path-to-user.crt>&sslkey=<path-to-user.key>

Alternative: YAML connection configuration example

# doctrine.yaml
doctrine:
    dbal:
        user: <user>
        port: <port(26257)>
        host: <host>
        dbname: <dbname>
        sslmode: verify-full
        sslrootcert: <path-to-ca.crt>
        sslcert: <path-to-user.crt>
        sslkey: <path-to-user.key>
        driver: crdb

License

MIT