Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add note about connection test #1842

Merged
merged 1 commit into from
Jun 14, 2023
Merged

docs: add note about connection test #1842

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,18 @@ replaces colons with periods:
./cloud-sql-proxy --unix-socket C:\cloudsql myproject:my-region:mysql
```

### Testing Connectivity

The Proxy includes support for a connection test on startup. This test helps
ensure the Proxy can reach the associated instance and is a quick debugging
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit

Suggested change
ensure the Proxy can reach the associated instance and is a quick debugging
ensure the Proxy can reach the associated instance(s) and is a quick debugging

tool. The test will attempt to connect to the specified instance and fail
if the instance is unreachable.

```shell
./cloud-sql-proxy --run-connection-test <INSTANCE_CONNECTION_NAME>
```


### Additional flags

To see a full list of flags, use:
Expand Down