{"id":242162,"date":"2024-02-22T15:24:43","date_gmt":"2024-02-22T22:24:43","guid":{"rendered":"https:\/\/virtual-dba.com\/?p=242162"},"modified":"2024-06-03T12:19:50","modified_gmt":"2024-06-03T19:19:50","slug":"how-to-build-a-cockroachdb-sandbox-on-windows","status":"publish","type":"post","link":"https:\/\/virtual-dba.com\/blog\/how-to-build-a-cockroachdb-sandbox-on-windows\/","title":{"rendered":"How to Build a CockroachDB Sandbox on Windows"},"content":{"rendered":"\n

Setting up a lab environment on your local machine to run CockroachDB is very helpful for learning about this exciting database platform and testing applications locally. This article outlines the procedure for setting up a local installation of CockroachDB on a Windows system. It’s based on CockroachDB’s documentation<\/a> but adds significant quality-of-life enhancements.<\/p>\n\n\n\n

All steps are performed in a PowerShell terminal.<\/p>\n\n\n\n

Steps for Installing CockroachDB 23.2.1<\/h2>\n\n\n\n

1. Install CockroachDB:<\/strong><\/p>\n\n\n\n

PS C:\\> $ErrorActionPreference<\/mark> = \"Stop\"\n\nPS C:\\> [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12\n\nPS C:\\> $ProgressPreference<\/mark> = 'SilentlyContinue'\n\nPS C:\\> $null<\/mark> = New-Item<\/mark> -Type Directory -Force $env:appdata<\/mark>\/cockroach\n\nPS C:\\> Invoke-WebRequest<\/mark> `\n>> -Uri https:\/\/binaries.cockroachdb.com\/cockroach-v23.2.1.windows-6.2-amd64.zip `\n>> -OutFile cockroach.zip\n\nPS C:\\> Expand-Archive -Force -Path cockroach.zip\n\nPS C:\\> Copy-Item<\/mark> -Force `\n>> \"cockroach\/cockroach-v23.2.1.windows-6.2-amd64\/cockroach.exe\" `\n>> -Destination $env:appdata<\/mark>\/cockroach\n\nPS C:\\> $Env:PATH += \";$env:appdata<\/mark>\/cockroach\"<\/code><\/pre>\n\n\n\n
2. Verify installation<\/strong>:<\/p>\n\n\n\n
PS C:\\> cockroach<\/mark> version\nBuild Tag:        v23.2.1\nBuild Time:       2024\/02\/15 22:46:32\nDistribution:     CCL\nPlatform:         windows amd64 (x86_64-w64-mingw32)\nGo Version:       go1.21.5 X:no coverage redesign\nC Compiler:       gcc 6.5.0\nBuild Commit ID:  898cd6a363fd47bb92a03bac216f9bed0f64bc08\nBuild Type:       release\nEnabled Assertions: false<\/code><\/pre>\n\n\n\n
After installation, you must add the CockroachDB path to your PowerShell profile to run Cockroach commands. This is necessary because after you spin up a local Cockroach node, you will need to use a new PowerShell terminal for all other work, and without setting the environment path, the cockroach commands will fail.<\/p>\n\n\n\n
3. If the profile file does not exist, create it and add a line to append the location of the cockroach executable to your path:<\/strong><\/p>\n\n\n\n
PS C:\\> if<\/mark> (!(Test-Path<\/mark> -Path $PROFILE<\/mark>)) {\n>>   New-Item<\/mark> -ItemType File -Path $PROFILE<\/mark> -Force\n>> }\n\n\n    Directory: C:\\Users\\mpetros\\Documents\\WindowsPowerShell\n\n\nMode                LastWriteTime         Length Name\n----                -------------         ------ ----\n-a----        2\/22\/2024   8:03 AM              0 Microsoft.PowerShell_profile.ps1\n\n\nPS C:\\> Add-Content<\/mark> -Path $PROFILE<\/mark> '$Env:Path += \";$env:appdata\/cockroach\"'<\/code><\/pre>\n\n\n\n
This completes the steps required for installation.<\/p>\n\n\n\n
To start a single-node CockroachDB cluster:<\/p>\n\n\n\n
4. Start a local single node cluster<\/strong>:<\/p>\n\n\n\n
PS C:\\> cockroach<\/mark> start-single-node --insecure --listen-addr localhost \n*\n* WARNING: ALL SECURITY CONTROLS HAVE BEEN DISABLED!\n*\n* This mode is intended for non-production testing only.\n*\n* In this mode:\n* - Your cluster is open to any client that can access localhost.\n* - Intruders with access to your machine or network can observe client-server traffic.\n* - Intruders can log in without a password and read or write any data in the cluster.\n* - Intruders can consume all your server's resources and cause unavailability.\n*\n*\n* INFO: To start a secure server without mandating TLS for clients,\n* consider --accept-sql-without-tls instead. For other options, see:\n*\n* - https:\/\/go.crdb.dev\/issue-v\/53404\/v23.2\n* - https:\/\/www.cockroachlabs.com\/docs\/v23.2\/secure-a-cluster.html\n*\n*\n* WARNING: Running a server without --sql-addr, with a combined RPC\/SQL listener, is deprecated.\n* This feature will be removed in a later version of CockroachDB.\n*\nCockroachDB node starting at 2024-02-22 16:09:49.0881121 +0000 UTC m=+5.528598401 (took 5.0s)\nbuild:               CCL v23.2.1 @ 2024\/02\/15 22:46:32 (go1.21.5 X:no coverage redesign)\nwebui:               http:\/\/localhost:8080\nsql:                 postgresql:\/\/root@localhost:26257\/defaultdb?sslmode=disable\nsql (JDBC):          jdbc:postgresql:\/\/localhost:26257\/defaultdb?sslmode=disable&user=root\nRPC client flags:    C:\\Users\\mpetros\\AppData\\Roaming\/cockroach\\cockroach.exe <client cmd> --host=localhost:26257 --insecure\nlogs:                C:\\Users\\mpetros\\cockroach-data\\logs\ntemp dir:            C:\\Users\\mpetros\\cockroach-data\\cockroach-temp2685956849\nexternal I\/O path:   C:\\Users\\mpetros\\cockroach-data\\extern\nstore[0]:            path=C:\\Users\\mpetros\\cockroach-data\nstorage engine:      pebble\nclusterID:           e45c29dc-d1c7-4332-83ac-6879dd264a64\nstatus:              initialized new cluster\nnodeID:              1<\/code><\/pre>\n\n\n\n
5. Verify that the cluster is running as expected:<\/strong><\/p>\n\n\n\n