Skip to content

Commit 534555f

Browse files
Jessesaishreeeee
authored andcommitted
Readme updates (#4)
Signed-off-by: Sai Shree Pradhan <[email protected]>
1 parent ca57a64 commit 534555f

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
# Databricks SQL Connector for Python
22

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/).
44

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

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).
88

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)
1215

1316
## Quickstart
1417

1518
Install the library with `pip install databricks-sql-connector`
1619

1720
Example usage:
1821

19-
```
22+
```python
2023
from databricks import sql
2124

2225
connection = sql.connect(
@@ -40,5 +43,3 @@ Where:
4043
- `<http-path>` is the HTTP Path either to a Databricks SQL endpoint (e.g. /sql/1.0/endpoints/1234567890abcdef),
4144
or to a Databricks Runtime interactive cluster (e.g. /sql/protocolv1/o/1234567890123456/1234-123456-slid123)
4245
- `<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).

0 commit comments

Comments
 (0)