Skip to content

Commit 7051eb5

Browse files
authored
chore: use "Postgres" not PostgreSQL in docs (#117)
1 parent aa73983 commit 7051eb5

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Cloud SQL Connector for Python Drivers
2-
**Warning**: This project is currently in _alpha_, and releases may contain breaking API changes.
2+
**Warning**: This project is currently in _alpha_, and releases may contain breaking API changes.
33

44
The Cloud SQL Python Connector is a library that can be used alongside a database driver to allow users with sufficient permissions to connect to a Cloud SQL
55
database without having to manually allowlist IPs or manage SSL certificates.
66

7-
Currently supported drivers are
7+
Currently supported drivers are
88
- [`pymysql`](https://github.com/PyMySQL/PyMySQL) (MySQL)
99
- [`pg8000`](https://github.com/tlocke/pg8000) (PostgreSQL)
1010
- [`pytds`](https://github.com/denisenkom/pytds) (SQL Server)
@@ -54,7 +54,7 @@ Use the connector to create a connection object by calling the connect method. I
5454

5555
```
5656
conn = connector.connect(
57-
"project:region:instance",
57+
"project:region:instance",
5858
"pymysql",
5959
user="root",
6060
password="shhh",
@@ -98,24 +98,24 @@ engine = sqlalchemy.create_engine(
9898
**Note for SQL Server users**: If your SQL Server instance requires SSL, you need to download the CA certificate for your instance and include `cafile={path to downloaded certificate}` and `validate_host=False`. This is a workaround for a [known issue](https://issuetracker.google.com/184867147).
9999

100100
### Specifying Public or Private IP
101-
The Cloud SQL Connector for Python can be used to connect to Cloud SQL instances using both public and private IP addresses. To specify which IP address to use to connect, set the `ip_type` keyword argument Possible values are `IPTypes.PUBLIC` and `IPTypes.PRIVATE`.
101+
The Cloud SQL Connector for Python can be used to connect to Cloud SQL instances using both public and private IP addresses. To specify which IP address to use to connect, set the `ip_type` keyword argument Possible values are `IPTypes.PUBLIC` and `IPTypes.PRIVATE`.
102102
Example:
103103
```
104104
connector.connect(
105-
"project:region:instance",
105+
"project:region:instance",
106106
"pymysql",
107107
ip_types=IPTypes.PRIVATE # Prefer private IP
108108
... insert other kwargs ...
109109
)
110110
```
111111

112-
Note: If specifying Private IP, your application must already be in the same VPC network as your Cloud SQL Instance.
112+
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 PostgreSQL driver.
115+
Connections using [IAM database authentication](https://cloud.google.com/sql/docs/postgres/iam-logins) are supported when using the Postgres driver.
116116
This feature is unsupported for other drivers.
117-
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).
118-
Now, you can connect using user or service account credentials instead of a password.
117+
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).
118+
Now, you can connect using user or service account credentials instead of a password.
119119
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.
120120
Example:
121121
```
@@ -131,7 +131,7 @@ connector.connect(
131131

132132
Tests can be run with `nox`. Change directory into the `cloud-sql-python-connector` and just run `nox` to run the tests.
133133

134-
1. Create a MySQL instance on Google Cloud SQL. Make sure to note your root password when creating the MySQL instance.
134+
1. Create a MySQL instance on Google Cloud SQL. Make sure to note your root password when creating the MySQL instance.
135135
2. When the MySQL instance has finished creating, go to the overview page and set the instance’s connection string to the environment variable MYSQL_CONNECTION_NAME using the following command:
136136
```
137137
export MYSQL_CONNECTION_NAME=your:connection:string

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 (PostgreSQL only).
78+
Enables IAM based authentication (Postgres only).
7979
:type enable_iam_auth: bool
8080
8181
:param kwargs:

0 commit comments

Comments
 (0)