Skip to content

Commit

Permalink
docs: add note about connection test (#1842)
Browse files Browse the repository at this point in the history
  • Loading branch information
enocom authored Jun 14, 2023
1 parent a537ea9 commit e9861ac
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
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
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

0 comments on commit e9861ac

Please sign in to comment.