Build a Ruby App with CockroachDB and ActiveRecord

This tutorial shows you how build a simple Ruby application with CockroachDB and ActiveRecord. CockroachDB provides an ActiveRecord adapter for CockroachDB as a RubyGem.

Tip:

For a more realistic use of ActiveRecord with CockroachDB in a Rails app, see our examples-orms repository.

Step 1. Start CockroachDB

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 root certificate

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

  1. Select General connection string from the Select option dropdown.
  2. Open a new terminal on your local machine, and run the CA Cert download command provided in the Download CA Cert section. The client driver used in this tutorial requires this certificate to connect to CockroachDB Cloud.

Get the connection string

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

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.

  1. If you haven't already, download the CockroachDB binary.
  2. Run the cockroach start-single-node command:

    icon/buttons/copy
    $ 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.

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

icon/buttons/copy
git clone https://github.com/cockroachlabs/example-app-ruby-activerecord

Step 3. Configure the dependencies

  1. Install libpq for your platform.

    For example, to install libpq on macOS with Homebrew, run the following command:

    icon/buttons/copy
    brew install libpq
    
  2. Configure bundle to use libpq.

    For example, if you installed libpq on macOS with Homebrew, run the following command from the example-app-ruby-activerecord directory:

    icon/buttons/copy
    bundle config --local build.pg --with-opt-dir="{libpq-path}"
    

    Where {libpq-path} is the full path to the libpq installation on your machine (e.g., /usr/local/opt/libpq).

  3. Install the dependencies:

    icon/buttons/copy
    bundle install
    

Step 4. Run the code

  1. Set the DATABASE_URL environment variable to the connection string to your CockroachDB Cloud cluster:

    icon/buttons/copy
    $ export DATABASE_URL="postgresql://root@localhost:26257?sslmode=disable"
    
    icon/buttons/copy
    $ 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.

  2. Run the code to create a table and insert some rows:

    icon/buttons/copy
    ruby main.rb
    

    The output should be similar to the following:

    -- create_table(:accounts, {:force=>true, :id=>:integer})
       -> 0.1998s
    account: 1 balance: 1000
    account: 2 balance: 250
    

What's next?

Read more about using ActiveRecord, or check out a more realistic implementation of ActiveRecord with CockroachDB in a Rails app in our examples-orms repository.

You might also be interested in the following pages:


Yes No