Install CockroachDB on Mac

Use Homebrew

For CockroachDB v22.2.x and above, Homebrew installs binaries for your system architecture, either Intel or ARM (Apple Silicon).

For previous releases, Homebrew installs Intel binaries. Intel binaries can run on ARM systems, but with a significant reduction in performance. CockroachDB on ARM for macOS is experimental and is not yet qualified for production use and not eligible for support or uptime SLA commitments.

1. Install Homebrew.

2. Instruct Homebrew to install CockroachDB:

   $ brew install cockroachdb/tap/cockroach

3. Keep up-to-date with CockroachDB releases and best practices:

   Thanks!

brew update

brew update
brew upgrade cockroach

Download the binary

For CockroachDB v22.2.x and above, download the binaries for your system architecture, either Intel or ARM (Apple Silicon).

For previous releases, download Intel binaries. Intel binaries can run on ARM systems, but with a significant reduction in performance. CockroachDB on ARM for macOS is experimental and is not yet qualified for production use and not eligible for support or uptime SLA commitments.

1. Visit Releases to download the CockroachDB archive for the architecture of your macOS host. The archive contains the cockroach binary and the supporting libraries that are used to provide spatial features.

   You can download the binary using a web browser or you can copy the link and use a utility like curl to download it. If you download the ARM binary using a web browser and you plan to use CockroachDB's spatial features, an additional step is required before you can install the library, as outlined in the next step.

   Extract the archive and optionally copy the cockroach binary into your PATH so you can execute cockroach commands from any shell. If you get a permission error, use sudo.

   Note:

   If you plan to use CockroachDB's spatial features, you must complete all of the following steps. Otherwise, your installation is now complete.

2. CockroachDB uses custom-built versions of the GEOS libraries. To install those libraries:

   1. Note that spatial features are currently disabled for Mac ARM users, for whom these steps do not apply. For an upcoming patch release where this functionality is reenabled, if you downloaded the CockroachDB ARM binary archive using a web browser, macOS flags the GEOS libraries in the extracted archive as quarantined. This flag must be removed before CockroachDB can use the libraries. To remove the quarantine flag from the libraries:

      xattr -d com.apple.quarantine lib/libgeos*
      

      This step is not required for Intel systems.

   2. Copy these libraries to one of the locations where CockroachDB expects to find them. By default, CockroachDB looks for external libraries in /usr/local/lib/cockroach or a lib subdirectory of the CockroachDB binary's current directory. If you place these libraries in another location, you must pass the location in the --spatial-libs flag to cockroach start. The instructions below assume the /usr/local/lib/cockroach location.

      1. Create the directory where the external libraries will be stored:

         mkdir -p /usr/local/lib/cockroach

      2. Copy the library files to the directory:

         cp -i cockroach-v24.2.5.darwin-10.9-amd64/lib/libgeos.dylib /usr/local/lib/cockroach/

         cp -i cockroach-v24.2.5.darwin-10.9-amd64/lib/libgeos_c.dylib /usr/local/lib/cockroach/

         If you get a permissions error, prefix the command with sudo.

3. Verify that CockroachDB can execute spatial queries.

   1. Make sure the cockroach binary you just installed is the one that runs when you type cockroach in your shell:

      which cockroach

      /usr/local/bin/cockroach

   2. Start a temporary, in-memory cluster using cockroach demo:

      cockroach demo

   3. In the demo cluster's interactive SQL shell, run the following command to test that the spatial libraries have loaded properly:

      > SELECT ST_IsValid(ST_MakePoint(1,2));

      You should see the following output:

      st_isvalid
      --------------
      true
      (1 row)
      

      If your cockroach binary is not properly accessing the dynamically linked C libraries in /usr/local/lib/cockroach, it will output an error message like the one below.

      ERROR: st_isvalid(): geos: error during GEOS init: geos: cannot load GEOS from dir "/usr/local/lib/cockroach": failed to execute dlopen
                Failed running "sql"

4. Keep up-to-date with CockroachDB releases and best practices:

   Thanks!

Use Kubernetes

To orchestrate CockroachDB locally using Kubernetes, either with configuration files or the Helm package manager, see Orchestrate CockroachDB Locally with Minikube.

Use Docker

CockroachDB's Docker images are multi-platform images that contain binaries for both Intel and ARM. Multi-platform images do not take up additional space on your Docker host.

Experimental images are not qualified for production use and not eligible for support or uptime SLA commitments.

1. Install a container runtime, such as Docker Desktop.
2. Verify that the runtime service is installed correctly and running in the background. Refer to the runtime's documentation. For Docker, start a terminal and run docker version. If you get an error, verify your installation and try again.

3. Visit Docker Hub and decide which image tag to pull. Releases are rolled out gradually. Docker images for a new release are published when other binary artifacts are published. The following tag formats are commonly used, although other tags are available.

   Tag	Example	Description
   An exact patch	v24.2.5	Pins a cluster to an exact patch. The cluster is upgraded to a newer patch or major version only when you pull a newer tag.
   Latest patch within a major version	latest-v24.2	Automatically updates a cluster to the latest patch of the version you specify. This tag is recommended in production, because it keeps your cluster updated within a major version but does not automatically upgrade your cluster to a new major version.
   latest	The latest patch within the latest major version.	This is the default if you do not specify a tag. It updates your cluster automatically to each new patch and major version, and is not recommended in production.

   Copy the tag you want to pull.

4. Pull the image. Replace {TAG} with the tag from the previous step.

   docker pull cockroachdb/cockroach:{TAG}
   

5. Start a cluster by starting the container on each node using docker start. The default command is cockroach start. Pass your desired flags as the final argument. For details, refer to Deploy a local container in Docker.

Build from source

See the public wiki for guidance. When building on the ARM architecture, refer to Limitations.