sequelize-cockroachdb
    TypeScript icon, indicating that this package has built-in type declarations

    6.0.2 • Public • Published

    sequelize-cockroachdb

    This NPM package makes Sequelize compatible with CockroachDB.

    Learn how to build a Node.js app with CockroachDB.

    Please file bugs against the sequelize-cockroachdb project

    Requirements

    This package needs Node.js v12 or later

    Setup and run tests

    First make sure you have CockroachDB installed. You can run cockroach version to see if is installed or you can download here

    Run cockroach start-single-node --insecure --logtostderr to start the database. If this returns ERROR: cockroach server exited with error: unable to lookup hostname run with --host localhost flag.

    Run cockroach sql --insecure to enter in SQL mode and type CREATE DATABASE sequelize_test;

    Then install the depedencies with npm i and npm test to run all tests

    Limitations

    Dealing with transactions

    From the docs

    CockroachDB guarantees that while a transaction is pending, it is isolated from other concurrent transactions with serializable isolation.

    Which means that any other query made in another connection to the same node will hang.

    For example:

    const t = await this.sequelize.transaction();
    await this.User.create({ name: "bob" }, { transaction: t });
    await this.User.findAll({ transaction: null }); // Query will hang!

    CockroachDB does not support yet:

    See tests/model_create_test.js to browse those implementations.

    Install

    npm i sequelize-cockroachdb

    DownloadsWeekly Downloads

    1,338

    Version

    6.0.2

    License

    Apache-2.0

    Unpacked Size

    55.3 kB

    Total Files

    10

    Last publish

    Collaborators

    • celiala
    • nathanstilwell
    • j-low
    • laurenbarker
    • davidh-crl
    • rafiss
    • koorosh
    • richardcrdb
    • absterr08
    • azhng
    • maryliag
    • santamaura