cockroachdb / homebrew-tap

`brew install cockroachdb/tap/cockroach`

CockroachDB Homebrew Tap

This is the official source for installing CockroachDB, CockroachDB SQL CLI, and the CockroachDB Cloud CLI with Homebrew.

Installing

$ brew install cockroachdb/tap/cockroach
$ brew install cockroachdb/tap/[email protected] # for older versions
$ brew install cockroachdb/tap/cockroach-sql
$ brew install cockroachdb/tap/ccloud

Alternately, you can configure the tap and install the package separately:

$ brew tap cockroachdb/tap
$ brew install cockroach
$ brew install cockroach-sql
$ brew install ccloud

See our complete installation instructions for alternative installation methods, including support for Linux and Windows.

homebrew-tap's Issues

allow older versions to be installed (<= v22.1)

I've seen some other brews have older versions (e.g. you can do brew install [email protected]), we should probably have support for older versions of CRDB with something like brew install cockroachdb/tap/[email protected] and the like.

Edit 2023-07-12: we will support this from v22.2+ onwards. we can work on v22.1 and back if we change the template files to not include the ARM builds.

Rename this repo?

This tap is used with either brew install cockroachdb/cockroach/cockroach or brew tap cockroachdb/cockroach; brew install cockroach. That's a lot of repetitions of the word cockroach. MongoDB (among others) does something that's arguably nicer-looking, replacing the second component (the most flexible part of the naming scheme) with brew, resulting in mongodb/brew/mongodb-community. This looks a little nicer for the user, although it does mean that they have a mostly-invisible repo with the silly name homebrew-brew. Other projects use tap for this.

We'll be reactivating this tap for the 19.2 launch; after that it gets harder to change. So if we decide we want to rename the repo, now's our best chance.

After any update you can't describe objects anymore.

after any update with homebrew that updates the cockroach tap the db is left in a state where desribing an object is broken.
this is immediately after going from 23.1.2 to 23.1.3. this also happened when going from 22.2.X to 23.1.2

you can \d the database and list objects, but you can't \d a specific object.

# Welcome to the CockroachDB SQL shell.
# All statements must be terminated by a semicolon.
# To exit, type: \q.
#
# Server version: CockroachDB CCL v23.1.3 (x86_64-apple-darwin19, built 2023/06/08 22:55:09, go1.19.4) (same version as client)
# Cluster ID: deda4d40-49e2-4e9b-b176-67501582e33e
#
# Enter \? for a brief introduction.
#
root@localhost:26257/defaultdb> \d                                                                                                                                                                                                                                         
List of relations:
  Schema |       Name        | Type  | Owner |    Table
---------+-------------------+-------+-------+---------------
  public | myothertable      | table | root  | NULL
  public | myothertable_pkey | index | root  | myothertable
  public | mytable           | table | root  | NULL
  public | mytable_pkey      | index | root  | mytable
(4 rows)
root@localhost:26257/defaultdb> \d mytable                                                                                                                                                                                                                                 
ERROR: relation "[104]" does not exist
SQLSTATE: 42P01
root@localhost:26257/defaultdb> SELECT * FROM mytable;                                                                                                                                                                                                                     
  myid | mytext
-------+---------
(0 rows)

Time: 42ms total (execution 42ms / network 0ms)

root@localhost:26257/defaultdb> insert into mytable values (1, 'one');                                                                                                                                                                                                     
INSERT 0 1

Time: 21ms total (execution 21ms / network 0ms)

root@localhost:26257/defaultdb> \d mytable                                                                                                                                                                                                                                 
ERROR: relation "[104]" does not exist
SQLSTATE: 42P01```

CockroachDB won't upgrade to 20.2 on Big Sur

 ✘ arjun@altaria  ~  brew upgrade                                        
Warning: You are using macOS 11.0.
We do not provide support for this released but not yet supported version.
You will encounter build failures with some formulae.
Please create pull requests instead of asking for help on Homebrew's GitHub,
Discourse, Twitter or any other official channels. You are responsible for
resolving any issues you experience while you are running this
released but not yet supported version.

==> Upgrading 1 outdated package:
cockroachdb/tap/cockroach 20.1.8 -> 20.2.0
==> Upgrading cockroachdb/tap/cockroach 20.1.8 -> 20.2.0 
==> Downloading https://binaries.cockroachdb.com/cockroach-v20.2.0.darwin-10.9-amd64.tgz
Already downloaded: /Users/arjun/Library/Caches/Homebrew/downloads/d1157092aa4b382fa86ac3e6a27e6df9c144cefbbdd975411e3e70ca41997ae1--cockroach-v20.2.0.darwin-10.9-amd64.tgz
Error: Your CLT does not support macOS 11.0.
It is either outdated or was modified.
Please update your CLT or delete it if no updates are available.
Error: An exception occurred within a child process:
  SystemExit: exit

SHA mismatch on beta-20170330

If I attempt to install the latest version of cockroach available via this brewtap I get a SHA mismatch:

$ brew install cockroach
==> Installing cockroach from cockroachdb/cockroach
==> Downloading https://binaries.cockroachdb.com/cockroach-beta-20170330.src.tgz
######################################################################## 100.0%
Error: SHA256 mismatch
Expected: 578335950bd22b773f91cf8a30ebd8aa3906e8970c903aa1b04c737b2109a442
Actual: 884b3c0342abb939666a39c3b198d1521eee795cdd0bb77205a47c45e00fab6e
Archive: /Users/novabyte/Library/Caches/Homebrew/cockroach-beta-20170330.tgz
To retry an incomplete download, remove the file above.

update manual and services start syntax

need to change node start syntax from start --insecure to start-single-node --insecure

Calling plist_options is deprecated

After one of Homebrew updates current formula has depricated option:

Warning: Calling plist_options is deprecated! Use service.require_root instead.
Please report this issue to the cockroachdb/tap tap (not Homebrew/brew or Homebrew/core), or even better, submit a PR to fix it:
  /usr/local/Homebrew/Library/Taps/cockroachdb/homebrew-tap/Formula/cockroach.rb:62

Failure to start after install

Appears to install and compile successfully but fails to start.

~ go version
go version go1.8 darwin/amd64

~ brew install cockroachdb/cockroach/cockroach
==> Installing cockroach from cockroachdb/cockroach
==> Downloading https://binaries.cockroachdb.com/cockroach-beta-20170330.src.tgz
Already downloaded: /Users/eddiezane/Library/Caches/Homebrew/cockroach-beta-20170330.tgz
==> make install
==> Caveats
......................................
==> Summary
🍺  /usr/local/Cellar/cockroach/beta-20170330: 5 files, 44.7MB, built in 4 minutes 7 seconds

~ cockroach start
[1]    81027 killed     cockroach start

On macOS 10.12.4 (16E195)

Trouble Running `brew install cockroachdb/cockroach/cockroach`

Dev Environment:

• Mac (Version 10.11.6)
• OS X El Capitan

Error Message:

🐈 dominiquecharlebois ~ $ brew install cockroachdb/cockroach/cockroach
Warning: You are using a pre-release version of Xcode.
You may encounter build failures or other breakages.
Please create pull-requests instead of filing issues.
==> Installing cockroach from cockroachdb/cockroach
==> Cloning https://github.com/cockroachdb/cockroach.git
Updating /Users/dominiquecharlebois/Library/Caches/Homebrew/cockroach--git
==> Checking out tag beta-20170309
==> xcrun make GOFLAGS=-v -C src/github.com/cockroachdb/cockroach build
Last 15 lines from /Users/dominiquecharlebois/Library/Logs/Homebrew/cockroach/01.xcrun:
Makefile:283: .bootstrap: No such file or directory
installing githooks/post-checkout
installing githooks/post-rewrite
installing githooks/post-merge
git submodule update --init
go1\.7|go1\.8.* required (see CONTRIBUTING.md): go version go1.6.3 darwin/amd64
make: *** [.go-version] Error 1
make: *** Waiting for unfinished jobs....
go install ./vendor/github.com/robfig/glock
cmd ./pkg/cmd/github-post                                      	[error exit status 1]
pkg/cmd/github-post/main.go:21:2: cannot find package "context" in any of:
	/private/tmp/cockroach-20170318-37625-irau1h/src/github.com/cockroachdb/cockroach/vendor/context (vendor tree)
	/usr/local/Cellar/go/1.6.3/libexec/src/context (from $GOROOT)
	/private/tmp/cockroach-20170318-37625-irau1h/src/context (from $GOPATH)
make: *** [.bootstrap] Error 1

READ THIS: https://git.io/brew-troubleshooting
If reporting this issue please do so at (not Homebrew/brew):
  https://github.com/cockroachdb/homebrew-cockroach/issues

Might be bug, might be ENV related.

Tests and lint are broken

brew test ./Formula/cockroachdb currently hangs trying to start the server, and linting (brew audit --strict --online ./Formula/cockroachdb) reports some minor issues. We should clean these up and hook them into some kind of CI. (it needs to be run on a mac so we should use something like circleci or travis-ci instead of our in-house teamcity)

Calling bottle :unneeded is deprecated in homebrew tap

Warning: Calling bottle :unneeded is deprecated! There is no replacement.
Please report this issue to the gobuffalo/tap tap (not Homebrew/brew or Homebrew/core):
  /usr/local/Homebrew/Library/Taps/gobuffalo/homebrew-tap/buffalo.rb:9

Homebrew tap does not work with Big Sur macOS 11.0

$ brew tap cockroachdb/tap
$ brew install cockroach
Warning: You are using macOS 11.0.
We do not provide support for this released but not yet supported version.
You will encounter build failures with some formulae.
Please create pull requests instead of asking for help on Homebrew's GitHub,
Discourse, Twitter or any other official channels. You are responsible for
resolving any issues you experience while you are running this
released but not yet supported version.

==> Installing cockroach from cockroachdb/tap
==> Downloading https://binaries.cockroachdb.com/cockroach-v20.2.0.darwin-10.9-amd64.tgz
Already downloaded: /Users/will/Library/Caches/Homebrew/downloads/d1157092aa4b382fa86ac3e6a27e6df9c144cefbbdd975411e3e70ca41997ae1--cockroach-v20.2.0.darwin-10.9-amd64.tgz
Error: Your CLT does not support macOS 11.0.
It is either outdated or was modified.
Please update your CLT or delete it if no updates are available.
Error: An exception occurred within a child process:
  SystemExit: exit
$

This is with CLT Xcode 12.2 (12B45b) and other homebrew installations are working. I know Big Sur is new and the message says Please create pull requests instead of asking for help on Homebrew's GitHub,, but I'm not familiar enough to create a PR for this, and figured it would be good to have an issue to track this :) Thanks!

Provide native binary for macOS ARM64

The formula installs an x86_64 binary even when running on an Apple M1.

Installing cockroachdb via brew fails due to git authentication

Tried to install the cockroachdb CLI as instructed in the documentation. However, it prompts for github credentials, and then errors out stating that password authentication is no longer supported by github.

matesafranka@Mates-MBP Dev % brew install cockroachdb/tab/cockroach
==> Tapping cockroachdb/tab
Cloning into '/usr/local/Homebrew/Library/Taps/cockroachdb/homebrew-tab'...
Username for 'https://github.com': [email protected]
Password for 'https://[email protected]@github.com': 
remote: Support for password authentication was removed on August 13, 2021.
remote: Please see https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.
fatal: Authentication failed for 'https://github.com/cockroachdb/homebrew-tab/'
Error: Failure while executing; `git clone https://github.com/cockroachdb/homebrew-tab /usr/local/Homebrew/Library/Taps/cockroachdb/homebrew-tab --origin=origin --template=` exited with 128.

Unable to install 20.2.6: checksum error

==> Upgrading cockroachdb/tap/cockroach 20.2.5 -> 20.2.6
==> Downloading https://binaries.cockroachdb.com/cockroach-v20.2.6.darwin-10.9-amd64.tgz
######################################################################## 100.0%
Error: SHA256 mismatch
Expected: 1068d49267a0344de93b33051b99bd0136dd03c68c4d8a606ef4bf462f6a8fa7
  Actual: b29ff48cff7350ab91d955e9e32bd1f575c1feef103aa0ef117a199c3f059ace
    File: /Users/bhatfield/Library/Caches/Homebrew/downloads/050144d6fd37631b5078476eb36213e5fd971428b2fd5f3e45bc8decd622e22b--cockroach-v20.2.6.darwin-10.9-amd64.tgz
To retry an incomplete download, remove the file above.

I did remove the file and retry - identical error. I believe this implies a formula issue.

Issue install cockroach with no error output

When trying to install cockroach DB on a recently setup M1 macbook I get the follow error.

2022-10-11 21:20:56 +0000

/opt/homebrew/Cellar/cockroach/22.1.8/bin/cockroach
gen
man
--path=/opt/homebrew/Cellar/cockroach/22.1.8/share/man/man1


HOMEBREW_VERSION: 3.6.5
ORIGIN: https://github.com/Homebrew/brew
HEAD: fb52a12144e80118c112ea744ab65ab6ca997d67
Last commit: 4 days ago
Core tap ORIGIN: https://github.com/Homebrew/homebrew-core
Core tap HEAD: d9469643c55a5089adafafe04d19881840ae78f4
Core tap last commit: 15 minutes ago
Core tap branch: master
HOMEBREW_PREFIX: /opt/homebrew
HOMEBREW_CASK_OPTS: []
HOMEBREW_MAKE_JOBS: 10
HOMEBREW_NO_BOOTSNAP: set
Homebrew Ruby: 2.6.8 => /System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/bin/ruby
CPU: 10-core 64-bit arm_firestorm_icestorm
Clang: 14.0.0 build 1400
Git: 2.37.0 => /Library/Developer/CommandLineTools/usr/bin/git
Curl: 7.79.1 => /usr/bin/curl
macOS: 12.5.1-arm64
CLT: 14.0.0.0.1.1661618636
Xcode: N/A
Rosetta 2: false

HOMEBREW_CC: clang
HOMEBREW_CXX: clang++
MAKEFLAGS: -j10
CMAKE_PREFIX_PATH: /opt/homebrew
CMAKE_INCLUDE_PATH: /Library/Developer/CommandLineTools/SDKs/MacOSX12.sdk/System/Library/Frameworks/OpenGL.framework/Versions/Current/Headers
CMAKE_LIBRARY_PATH: /Library/Developer/CommandLineTools/SDKs/MacOSX12.sdk/System/Library/Frameworks/OpenGL.framework/Versions/Current/Libraries
PKG_CONFIG_LIBDIR: /usr/lib/pkgconfig:/opt/homebrew/Library/Homebrew/os/mac/pkgconfig/12
HOMEBREW_GIT: git
HOMEBREW_SDKROOT: /Library/Developer/CommandLineTools/SDKs/MacOSX12.sdk
PATH: /opt/homebrew/Library/Homebrew/shims/mac/super:/usr/bin:/bin:/usr/sbin:/sbin

When running brew install cockroach I get the follow error, and it seems like the binary isn't actually being installed at that location