GoogleCloudPlatform / GoogleCloudPlatform/cloud-sql-proxy

Add example script for invoking commands against the Proxy

Open
#1,056 3 comments 7 reactions 1 assignee Assigned to @hessjcg View on GitHub
priority: p2 type: feature request
Dominant language
Go
Stars
1.4k
Forks
352
Avg merge
14h 54m
Merged PRs (30d)
5

Description

When trying to run a script or database migration, the user currently has to
1) start the cloudsql proxy and wait for the port to open or unix domain socket to be created
2) run the command
3) stop the cloudsql proxy

The usage would be simplified if the cloudsql proxy offered an `exec` subcommand that could be used like this:
```sh
./cloudsql-proxy exec -- psql --command 'select 1;'
```
The cloudsql-proxy binary would establish the connection, then run the supplied shell command, and terminate after the termination of the command.

Similar functionality is already offered by the firestore emulator to run automated tests (e.g., `firebase emulators:exec "./my-test.sh"`, see [1]).

Without this, waiting for the cloudsql proxy to become available and killing it reliably afterwards in a typical shell script that runs in a CI/CD pipeline is a significant hassle.

[1] https://firebase.google.com/docs/functions/local-emulator#run_the_emulator_suite

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.