From f342e6f965dabffc22b5c7761be31e7f1eef805e Mon Sep 17 00:00:00 2001 From: Jesse Date: Thu, 23 Jun 2022 15:42:23 -0500 Subject: [PATCH 1/3] Readme updates --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 97b391e86..f037829b2 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ # Databricks SQL Connector for Python -**Status: Generally Available** +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. And it conforms to the [Python DB API 2.0 specification](https://www.python.org/dev/peps/pep-0249/). -Documentation can be found here: [Databricks SQL Connector for Python](https://docs.databricks.com/dev-tools/python-sql-connector.html). +The initial public release (`v1.0`) was a very lightly modified version of [PyHive](https://pypi.org/project/PyHive/). The `v2.0` release was a complete from scratch re-write, with the same public API. Since `v2.0`, it uses Arrow as the data-exchange format. `v2.0` also 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. -## About +You are welcome to file an issue here for general use cases. You can also contact Databricks Support [here](help.databricks.com). -The Databricks SQL Connector is a Python library that allows you to use Python code to run -SQL commands on Databricks clusters and Databricks SQL endpoints. -This library follows [PEP 249 -- Python Database API Specification v2.0](https://www.python.org/dev/peps/pep-0249/). +# Documentation + +For the latest documentation, see + +- [Databricks](https://docs.databricks.com/dev-tools/python-sql-connector.html) +- [Azure Databricks](https://docs.microsoft.com/en-us/azure/databricks/dev-tools/python-sql-connector) ## Quickstart @@ -16,7 +19,7 @@ Install the library with `pip install databricks-sql-connector` Example usage: -``` +```python from databricks import sql connection = sql.connect( From b2716322cd76d037418d7d83e42ef6a3e003a294 Mon Sep 17 00:00:00 2001 From: Jesse Date: Thu, 23 Jun 2022 15:44:26 -0500 Subject: [PATCH 2/3] Remove duplicate link to help pages --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index f037829b2..faa21f852 100644 --- a/README.md +++ b/README.md @@ -43,5 +43,3 @@ Where: - `` is the HTTP Path either to a Databricks SQL endpoint (e.g. /sql/1.0/endpoints/1234567890abcdef), or to a Databricks Runtime interactive cluster (e.g. /sql/protocolv1/o/1234567890123456/1234-123456-slid123) - `` is a HTTP Bearer access token, e.g. a Databricks Personal Access Token. - -For more information, see [Databricks documentation](https://docs.databricks.com/dev-tools/python-sql-connector.html). From 7bee8e4c379e354d3a60fda4cca431b527415d7b Mon Sep 17 00:00:00 2001 From: Jesse Date: Thu, 23 Jun 2022 21:09:16 -0500 Subject: [PATCH 3/3] Remove references to v1 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index faa21f852..f07233866 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Databricks SQL Connector for Python -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. And it conforms to the [Python DB API 2.0 specification](https://www.python.org/dev/peps/pep-0249/). +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/). -The initial public release (`v1.0`) was a very lightly modified version of [PyHive](https://pypi.org/project/PyHive/). The `v2.0` release was a complete from scratch re-write, with the same public API. Since `v2.0`, it uses Arrow as the data-exchange format. `v2.0` also 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. +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. You are welcome to file an issue here for general use cases. You can also contact Databricks Support [here](help.databricks.com).