Skip to content

Commit

Permalink
docs: minor tweak to connection test docs (#1843)
Browse files Browse the repository at this point in the history
  • Loading branch information
enocom authored Jun 14, 2023
1 parent e9861ac commit 51cc2c6
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,9 @@ replaces colons with periods:

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
tool. The test will attempt to connect to the specified instance and fail
if the instance is unreachable.
tool. The test will attempt to connect to the specified instance(s) and fail
if the instance is unreachable. If the test fails, the Proxy will exit with
a non-zero exit code.

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

0 comments on commit 51cc2c6

Please sign in to comment.