Skip to content

Commit f33c2b1

Browse files
authored
chore: add note about Postgres-only IAM DB Authn (#116)
* chore: add note about Postgres-only IAM DB Authn * chore: update docstring
1 parent badd747 commit f33c2b1

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,8 @@ connector.connect(
112112
Note: If specifying Private IP, your application must already be in the same VPC network as your Cloud SQL Instance.
113113

114114
### IAM Authentication
115-
Connections using [IAM database authentication](https://cloud.google.com/sql/docs/postgres/iam-logins) are supported when using the Postgres driver.
115+
Connections using [IAM database authentication](https://cloud.google.com/sql/docs/postgres/iam-logins) are supported when using the PostgreSQL driver.
116+
This feature is unsupported for other drivers.
116117
First, make sure to [configure your Cloud SQL Instance to allow IAM authentication](https://cloud.google.com/sql/docs/postgres/create-edit-iam-instances#configure-iam-db-instance) and [add an IAM database user](https://cloud.google.com/sql/docs/postgres/create-manage-iam-users#creating-a-database-user).
117118
Now, you can connect using user or service account credentials instead of a password.
118119
In the call to connect, set the `enable_iam_auth` keyword argument to true and `user` to the email address associated with your IAM user.

google/cloud/sql/connector/connector.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def connect(
7575
can be either IPTypes.PUBLIC or IPTypes.PRIVATE.
7676
7777
:param enable_iam_auth
78-
Enables IAM based authentication for Postgres instances.
78+
Enables IAM based authentication (PostgreSQL only).
7979
:type enable_iam_auth: bool
8080
8181
:param kwargs:

0 commit comments

Comments
 (0)