Build a Simple CRUD Node.js App with CockroachDB and Knex.js

On this page

Warning:

CockroachDB v21.2 is no longer supported as of May 16, 2023. For more details, refer to the Release Support Policy.

This tutorial shows you how build a simple Node.js application with CockroachDB and Knex.js.

Step 1. Start CockroachDB

Create a free cluster

If you haven't already, sign up for a CockroachDB Cloud account.
Log in to your CockroachDB Cloud account.
On the Clusters page, click Create Cluster.
On the Create your cluster page, select Serverless.
Click Create cluster.

Your cluster will be created in a few seconds and the Create SQL user dialog will display.

Create a SQL user

The Create SQL user dialog allows you to create a new SQL user and password.

Enter a username in the SQL user field or use the one provided by default.
Click Generate & save password.
Copy the generated password and save it in a secure location.
Click Next.

Currently, all new users are created with full privileges. For more information and to change the default settings, see [Manage SQL users on a cluster.

Get the connection string

The Connect to cluster dialog shows information about how to connect to your cluster.

Select General connection string from the Select option dropdown.
Open the General connection string section, then copy the connection string provided and save it in a secure location.

The sample application used in this tutorial uses system CA certificates for server certificate verification, so you can skip the Download CA Cert instructions.

Note:

The connection string is pre-populated with your username, password, cluster name, and other details. Your password, in particular, will be provided only once. Save it in a secure place (Cockroach Labs recommends a password manager) to connect to your cluster in the future. If you forget your password, you can reset it by going to the SQL Users page for the cluster, found at https://cockroachlabs.cloud/cluster/<CLUSTER ID>/users.

If you haven't already, download the CockroachDB binary.
Run the cockroach start-single-node command:
```
$ cockroach start-single-node --advertise-addr 'localhost' --insecure
```
This starts an insecure, single-node cluster.

Take note of the following connection information in the SQL shell welcome text:

CockroachDB node starting at 2021-08-30 17:25:30.06524 +0000 UTC (took 4.3s)
build:               CCL v21.1.6 @ 2021/07/20 15:33:43 (go1.15.11)
webui:               http://localhost:8080
sql:                 postgresql://root@localhost:26257?sslmode=disable

You'll use the sql connection string to connect to the cluster later in this tutorial.

Warning:

The --insecure flag used in this tutorial is intended for non-production testing only. To run CockroachDB in production, use a secure cluster instead.

Step 2. Get the code

Clone the code's GitHub repo:

$ git clone https://github.com/cockroachlabs/example-app-node-knex

Step 3. Run the code

Set the DATABASE_URL environment variable to the connection string:
```
$ export DATABASE_URL="postgresql://root@localhost:26257?sslmode=disable"
```
```
$ export DATABASE_URL="<connection-string>"
```
Where <connection-string> is the connection string you obtained from the CockroachDB Cloud Console.
The app uses the connection string saved to the DATABASE_URL environment variable to connect to your cluster and execute the code.
Install the app requirements:
```
$ npm install
```

Run the app:

$ npm start

The output should look like this:

Initializing accounts table...
New account balances:
{ id: 'bc0f7136-7103-4dc4-88fc-102d5bbd312f', balance: '1000' }
{ id: '35bde7d0-29c9-4277-a117-3eb80c85ae16', balance: '250' }
{ id: '18cc1b2d-be61-4a8d-942c-480f5a6bc207', balance: '0' }
Transferring funds...
New account balances:
{ id: 'bc0f7136-7103-4dc4-88fc-102d5bbd312f', balance: '900' }
{ id: '35bde7d0-29c9-4277-a117-3eb80c85ae16', balance: '350' }
{ id: '18cc1b2d-be61-4a8d-942c-480f5a6bc207', balance: '0' }
Deleting a row...
New account balances:
{ id: 'bc0f7136-7103-4dc4-88fc-102d5bbd312f', balance: '900' }
{ id: '18cc1b2d-be61-4a8d-942c-480f5a6bc207', balance: '0' }

What's next?

You might also be interested in the following pages:

Was this helpful?

Cockroach
University

Docs Hub

Build a Simple CRUD Node.js App with CockroachDB and Knex.js

Step 1. Start CockroachDB

Create a free cluster

Create a SQL user

Get the connection string

Step 2. Get the code

Step 3. Run the code

What's next?

Cockroach University

Docs Hub

Cockroach University

Docs Hub

Build a Simple CRUD Node.js App with CockroachDB and Knex.js

Step 1. Start CockroachDB

Create a free cluster

Create a SQL user

Get the connection string

Step 2. Get the code

Step 3. Run the code

What's next?

Cockroach
University

Cockroach
University