This tutorial shows you how build a simple Hello World Go application with CockroachDB and the GORM ORM.
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 CockroachDB Serverless.Note:
This cluster will be free forever.
Click Create your free cluster.
Your cluster will be created in approximately 20-30 seconds.
Set up your cluster connection
Navigate to the cluster's SQL Users page, and create a new user, with a new password.
Navigate to the Cluster Overview page, select Connect, and, under the Connection String tab, download the cluster certificate.
Take note of the connection string provided. You'll use it to connect to the database later in this tutorial.
- If you haven't already, download the CockroachDB binary.
$ 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
sqlconnection string to connect to the cluster later in this tutorial.
--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/hello-world-go-gorm
main.go file contains all of the code for the sample Hello World app:
404: Not Found
main method of this program does the following:
- Attempts to connect to a running cluster, given a connection string.
- Prints a message to the terminal about the connection status.
Step 3. Run the code
Initialize and run the app:
$ go mod init basic-sample && go mod tidy
$ go run main.go
The program will prompt you for a connection string to the database:
Enter a connection string:
sql connection URL provided in the
cockroach welcome text).
Enter the connection string provided in the Connection info window of the CockroachDB Cloud Console.
You need to provide a SQL user password in order to securely connect to a CockroachDB Cloud cluster. The connection string should have a placeholder for the password (
After entering the connection string, the program will execute.
The output should look like this:
Hey! You successfully connected to your CockroachDB cluster.
You might also be interested in the following pages: