Download CockroachDB

Upgrade Nakama#When upgrading to a new version of Nakama, you need to do three things before you run the newer version:Check the Release Notes, in case that version has specific upgrade requirements.Migrate your data to the format supported by the new version of Nakama.Ensure that the client version you’re running is compatible with the server deployed.Docker#As new versions of Nakama, or CockroachDB, become available you might want to upgrade. Docker makes upgrading easy, as all you need to do is pull down a new version of the container image. When upgrading to a new version of Nakama, the process in the docker-compose.yml performs a migration of your data to the new database schema automatically.You can pull the most recent Nakama image and allow Docker Compose to perform the data migration.123docker-compose down # top and remove both the Nakama and CockroachDB containersdocker pull heroiclabs/nakama # download the latest Nakama imagedocker-compose up # start the containers (both Nakama and CockroachDB) as fresh installsAnd, similarly, here’s how to update the CockroachDB container:1docker pull cockroachdb/cockroach # download the latest CockroachDB imageIf you’d like to explicitly run a database schema migration, issue the following command:1docker run heroiclabs/nakama migrate upManual upgrade#You can upgrade one node or your whole cluster to the latest version of Nakama by following the instructions below.For each node in the cluster:Stop Nakama. If you are using systemd on a Linux setup, the command is:1sudo systemctl stop nakamaBack-up CockroachDB:1cockroach dump nakama > mydatabackup.sql --insecureDownload the latest release and replace the nakama binary with

CLI tool.Note:The ccloud CLI tool is in Preview.Install ccloudChoose your OS:You can install ccloud using either Homebrew or by downloading the binary.Use HomebrewInstall Homebrew.Install using the ccloud tap:icon/buttons/copybrew install cockroachdb/tap/ccloudDownload the binaryIn a terminal, enter the following command to download and extract the ccloud binary and add it to your PATH: icon/buttons/copy curl | tar -xJ && cp -i ccloud /usr/local/bin/Use the ARM 64 binary if you have an M-series Mac: icon/buttons/copy curl | tar -xJ && cp -i ccloud /usr/local/bin/In a terminal, enter the following command to download and extract the ccloud binary and add it to your PATH: icon/buttons/copy curl | tar -xz && cp -i ccloud /usr/local/bin/In a PowerShell window, enter the following command to download and extract the ccloud binary and add it to your PATH: icon/buttons/copy $ErrorActionPreference = "Stop"; [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $ProgressPreference = 'SilentlyContinue'; $null = New-Item -Type Directory -Force $env:appdata/ccloud; Invoke-WebRequest -Uri -OutFile ccloud.zip; Expand-Archive -Force -Path ccloud.zip; Copy-Item -Force ccloud/ccloud.exe -Destination $env:appdata/ccloud; $Env:PATH += ";$env:appdata/ccloud"; # We recommend adding ";$env:appdata/ccloud" to the Path variable for your system environment. See for more information.Run ccloud quickstart to create a new cluster, create a SQL user, and retrieve the connection string.The easiest way of getting started with CockroachDB Cloud is to use ccloud quickstart. The ccloud quickstart command guides you through logging in to CockroachDB Cloud, creating a new CockroachDB Serverless cluster, and connecting to the new cluster. Run ccloud quickstart and follow the instructions: icon/buttons/copy The ccloud quickstart command will open a browser window to log you in to CockroachDB Cloud. If you are new to CockroachDB Cloud, you can register using one of the single sign-on (SSO) options, or create a new account using an email address.The ccloud quickstart command will prompt you for the cluster name, cloud provider, and cloud provider region,

Then ask if you want to connect to the cluster. Each prompt has default values that you can select, or change if you want a different option.Select Parameters only then copy the connection parameters displayed and save them in a secure location.? How would you like to connect? Parameters onlyLooking up cluster ID: succeededCreating SQL user: succeededSuccess! Created SQL user name: maxroach cluster: 37174250-b944-461f-b1c1-3a99edb6af32Retrieving cluster info: succeededConnection parameters Database: defaultdb Host: blue-dog-147.6wr.cockroachlabs.cloud Password: ThisIsNotAGoodPassword Port: 26257 Username: maxroachIf you haven't already, download the CockroachDB binary.Run the cockroach start-single-node command:icon/buttons/copy$ cockroach start-single-node --advertise-addr 'localhost' --insecureThis 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: postgresql://root@localhost:26257?sslmode=disableYou'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 codeClone the code's GitHub repository:icon/buttons/copy$ git clone git@github.com:cockroachlabs/example-app-typescript-typeorm.gitNavigate to the repo directory and install the application dependencies:icon/buttons/copy$ cd example-app-typescript-typeormicon/buttons/copyStep 3. Configure your CockroachDB connectionOpen the datasource.ts file, and comment out the ssl: true, extra and options configuration properties.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 synchronize: true, logging: false, entities: ["src/entity/**/*.ts"], migrations: ["src/migration/**/*.ts"], subscribers: ["src/subscriber/**/*.ts"],})Set the DATABASE_URL environment variable to the connection string provided in the cockroach welcome text:icon/buttons/copyexport DATABASE_URL="postgresql://root@localhost:26257/defaultdb?sslmode=disable"Set the DATABASE_URL environment variable to a CockroachDB connection string compatible with TypeORM.icon/buttons/copyexport DATABASE_URL=""TypeORM accepts the following format for CockroachDB Standard connection strings:icon/buttons/copypostgresql://:@:/Step 4. Run

Skip to content Navigation Menu GitHub Copilot Write better code with AI Security Find and fix vulnerabilities Actions Automate any workflow Codespaces Instant dev environments Issues Plan and track work Code Review Manage code changes Discussions Collaborate outside of code Code Search Find more, search less Explore Learning Pathways Events & Webinars Ebooks & Whitepapers Customer Stories Partners Executive Insights GitHub Sponsors Fund open source developers The ReadME Project GitHub community articles Enterprise platform AI-powered developer platform Pricing Provide feedback Saved searches Use saved searches to filter your results more quickly ;ref_cta:Sign up;ref_loc:header logged out"}"> Sign up the scalable, survivable, SQL database Verified We've verified that the organization cockroachdb controls the domain: www.cockroachlabs.com Overview Repositories Projects Packages People Sponsoring Pinned Loading CockroachDB — the cloud native, distributed SQL database designed for high availability, effortless scale, and control over data placement. Go 30.6k 3.9k CockroachDB user documentation HTML 195 468 RocksDB/LevelDB inspired key-value database in Go Go 5.2k 489 Go error library with error portability over the network Go 2.2k 66 Repositories --> Type Select type All Public Sources Forks Archived Mirrors Templates Language Select language All Astro C C# C++ Clojure Dockerfile Go HTML Java JavaScript Mustache Protocol Buffer Python Ruby Rust Scala Shell Smarty Starlark TSQL TypeScript Vim Script Sort Select order Last updated Name Stars Showing 10 of 209 repositories cockroach Public CockroachDB — the cloud native, distributed SQL database designed for high availability, effortless scale, and control over data placement. cockroachdb/cockroach’s past year of commit activity pebble Public RocksDB/LevelDB inspired key-value database in Go cockroachdb/pebble’s past year of commit activity cockroachdb/cockroach-go’s past year of commit activity cockroachdb/cockroach-operator’s past year of commit activity docs Public CockroachDB user documentation cockroachdb/docs’s past year of commit activity demo-video-code Public A collection of code examples to accompany demo videos. cockroachdb/demo-video-code’s past year of commit activity Go 1 0 0 0 Updated Mar 21, 2025 cockroachdb/helm-charts’s past year of commit activity Go 89 Apache-2.0 150 45 31 Updated Mar 21, 2025 cockroachdb/activerecord-cockroachdb-adapter’s past year of commit activity Ruby 106 Apache-2.0 51 21 7 Updated Mar 20, 2025 stress Public A fork of Golang's stress function. cockroachdb/stress’s past year of commit activity Go 5 BSD-3-Clause 6 0 1 Updated Mar 20, 2025 errors Public Go error library with error portability over the network cockroachdb/errors’s past year of commit activity Most used topics