You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,13 @@
1
1
# Cloud SQL Connector for Python Drivers
2
-
*Warning*: This project is experimental, and is not an officially supported Google product.
2
+
**Warning**: This project is currently in _alpha_, and releases may contain breaking API changes.
3
3
4
-
The Cloud SQL Python Connector library is a library for MySQL/Postgres Python
5
-
drivers that allows users with sufficient permissions to connect to a Cloud SQL
4
+
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
6
5
database without having to manually allowlist IPs or manage SSL certificates.
7
6
8
-
Currently only supports MySQL through the `pymysql` driver.
@@ -40,7 +42,7 @@ To use the connector: import the connector by including the following statement
40
42
from google.cloud.sql.connector import connector
41
43
```
42
44
43
-
Use the connector to create a connection object by calling the connect method. Input your connection string as the first positional argument and “mysql-connector” for the second positional argument. Insert the rest of your connection keyword arguments like user, password and database.
45
+
Use the connector to create a connection object by calling the connect method. Input your connection string as the first positional argument and the name of the database driver for the second positional argument. Insert the rest of your connection keyword arguments like user, password and database. You can also set the optional `timeout` or `ip_type` keyword arguments.
44
46
45
47
```
46
48
connector.connect(
@@ -52,7 +54,7 @@ connector.connect(
52
54
... insert other kwargs ...
53
55
)
54
56
```
55
-
57
+
**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).
0 commit comments