Build a TypeScript App with CockroachDB and TypeORM

Create a free cluster

1. If you haven't already, sign up for a CockroachDB Cloud account.
2. Log in to your CockroachDB Cloud account.
3. On the Clusters page, click Create Cluster.

4. On the Create your cluster page, select Serverless.

   Unless you change your monthly budget, this cluster will be free forever.

5. 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.

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

4. Click Next.

   Currently, all new users are created with full privileges. For more information and to change the default settings, see Granting privileges and Using roles.

Get the connection information

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

1. Select Parameters only from the Select option dropdown.
2. Copy the connection information for each parameter displayed and save it in a secure location.

1. If you haven't already, download the CockroachDB binary.

2. Run the cockroach start-single-node command:

   $ cockroach start-single-node --advertise-addr 'localhost' --insecure
   

   This starts an insecure, single-node cluster.

3. 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.

1. Open the datasource.ts file, and comment out the ssl: true, extra and options configuration properties.

2. In the datasource.ts file, uncomment ssl: { rejectUnauthorized: false }.

   Warning:

   Only use ssl: { rejectUnauthorized: false } in development, for insecure connections.

   The DataSource configuration should look similar to the following:

   export const AppDataSource = new DataSource({
       type: "cockroachdb",
       url: process.env.DATABASE_URL,
       ssl: { rejectUnauthorized: false }, // For insecure connections only
       /* ssl: true,
       extra: {
           options: "--cluster=<routing-id>"
       }, */
       synchronize: true,
       logging: false,
       entities: ["src/entity/**/*.ts"],
       migrations: ["src/migration/**/*.ts"],
       subscribers: ["src/subscriber/**/*.ts"],
   })
   

3. Set the DATABASE_URL environment variable to the connection string provided in the cockroach welcome text:

   export DATABASE_URL="postgresql://root@localhost:26257?sslmode=disable"
   

1. Open the datasource.ts file, and edit the options: "--cluster=<routing-id>" configuration property to specify the routing ID to your serverless cluster.

2. Set the DATABASE_URL environment variable to a CockroachDB connection string compatible with TypeORM.

   export DATABASE_URL="<connection-string>"
   

   TypeORM accepts the following format for CockroachDB Serverless connection strings:

   postgresql://<username>:<password>@<host>:<port>/<database>