summaryrefslogtreecommitdiff
path: root/databases/py-databricks-sql-connector/pkg-descr
diff options
context:
space:
mode:
Diffstat (limited to 'databases/py-databricks-sql-connector/pkg-descr')
-rw-r--r--databases/py-databricks-sql-connector/pkg-descr15
1 files changed, 15 insertions, 0 deletions
diff --git a/databases/py-databricks-sql-connector/pkg-descr b/databases/py-databricks-sql-connector/pkg-descr
new file mode 100644
index 000000000000..d8ce2f20df94
--- /dev/null
+++ b/databases/py-databricks-sql-connector/pkg-descr
@@ -0,0 +1,15 @@
+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.
+
+This connector uses Arrow as the data-exchange format, and supports APIs (e.g.
+fetchmany_arrow) 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. PyArrow
+is required to enable this and use these APIs, you can install it via pip
+install pyarrow or pip install databricks-sql-connector[pyarrow].
+
+The connector includes built-in support for HTTP/HTTPS proxy servers with
+multiple authentication methods including basic authentication and
+Kerberos/Negotiate authentication. See docs/proxy.md and
+examples/proxy_authentication.py for details.