|
1 | 1 | #Databricks SQL Connector for Python |
2 | 2 |
|
3 | | -**Status: Generally Available** |
| 3 | +The Databricks SQL Connector for Python allows you to develop Python applications that connect to Databricks clusters and SQL warehouses. It is a Thrift-based client with no dependencies on ODBC or JDBC. It conforms to the[Python DB API 2.0 specification](https://www.python.org/dev/peps/pep-0249/). |
4 | 4 |
|
5 | | -Documentation can be found here:[Databricks SQL Connector for Python](https://docs.databricks.com/dev-tools/python-sql-connector.html). |
| 5 | +This connector uses Arrow as the data-exchange format, and supports APIs to directly fetch Arrow tables. Arrow tables are wrapped in the`ArrowQueue` class to provide a natural API to get several rows at a time. |
6 | 6 |
|
7 | | -##About |
| 7 | +You are welcome to file an issue here for general use cases. You can also contact Databricks Support[here](help.databricks.com). |
8 | 8 |
|
9 | | -The Databricks SQL Connector is a Python library that allows you to use Python code to run |
10 | | -SQL commands on Databricks clusters and Databricks SQL endpoints. |
11 | | -This library follows[PEP 249 -- Python Database API Specification v2.0](https://www.python.org/dev/peps/pep-0249/). |
| 9 | +#Documentation |
| 10 | + |
| 11 | +For the latest documentation, see |
| 12 | + |
| 13 | +-[Databricks](https://docs.databricks.com/dev-tools/python-sql-connector.html) |
| 14 | +-[Azure Databricks](https://docs.microsoft.com/en-us/azure/databricks/dev-tools/python-sql-connector) |
12 | 15 |
|
13 | 16 | ##Quickstart |
14 | 17 |
|
15 | 18 | Install the library with`pip install databricks-sql-connector` |
16 | 19 |
|
17 | 20 | Example usage: |
18 | 21 |
|
19 | | -``` |
| 22 | +```python |
20 | 23 | from databricksimport sql |
21 | 24 |
|
22 | 25 | connection= sql.connect( |
|
40 | 43 | -`<http-path>` is the HTTP Path either to a Databricks SQL endpoint (e.g. /sql/1.0/endpoints/1234567890abcdef), |
41 | 44 | or to a Databricks Runtime interactive cluster (e.g. /sql/protocolv1/o/1234567890123456/1234-123456-slid123) |
42 | 45 | -`<personal-access-token>` is a HTTP Bearer access token, e.g. a Databricks Personal Access Token. |
43 | | - |
44 | | -For more information, see[Databricks documentation](https://docs.databricks.com/dev-tools/python-sql-connector.html). |
|
