Skip to content

Commit 10d56b1

Browse files
authored
chore(docs): update readme to include info about new functionality (#88)
1 parent f0f2ede commit 10d56b1

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# 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.
33

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
65
database without having to manually allowlist IPs or manage SSL certificates.
76

8-
Currently only supports MySQL through the `pymysql` driver.
7+
Currently supported drivers are
8+
- [`pymysql`](https://github.com/PyMySQL/PyMySQL) (MySQL)
9+
- [`pg8000`](https://github.com/tlocke/pg8000) (PostgreSQL)
10+
- [`pytds`](https://github.com/denisenkom/pytds) (SQL Server)
911

1012
# Supported Python Versions
1113
Currently Python versions >= 3.6 are supported.
@@ -40,7 +42,7 @@ To use the connector: import the connector by including the following statement
4042
from google.cloud.sql.connector import connector
4143
```
4244

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.
4446

4547
```
4648
connector.connect(
@@ -52,7 +54,7 @@ connector.connect(
5254
... insert other kwargs ...
5355
)
5456
```
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).
5658

5759
### Setup for development
5860

0 commit comments

Comments
 (0)