Published
Databricks SQL Connector for Python
pip install databricks-sql-connector
Package Downloads
Authors
Project URLs
Requires Python
<4.0.0,>=3.8.0
Dependencies
- thrift
<0.21.0,>=0.16.0 - pandas
<2.3.0,>=1.2.5; python_version >= "3.8" - pyarrow
<17,>=14.0.1 - lz4
<5.0.0,>=4.0.2 - requests
<3.0.0,>=2.18.1 - oauthlib
<4.0.0,>=3.1.0 - numpy
<2.0.0,>=1.16.6; python_version >= "3.8" and python_version < "3.11" - numpy
<2.0.0,>=1.23.4; python_version >= "3.11" - sqlalchemy
>=2.0.21; extra == "sqlalchemy" or extra == "alembic" - openpyxl
<4.0.0,>=3.0.10 - alembic
<2.0.0,>=1.0.11; extra == "alembic" - urllib3
>=1.26
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. It conforms to the Python DB API 2.0 specification and exposes a SQLAlchemy dialect for use with tools like pandas and alembic which use SQLAlchemy to execute DDL. Use pip install databricks-sql-connector[sqlalchemy] to install with SQLAlchemy's dependencies. pip install databricks-sql-connector[alembic] will install alembic's dependencies.
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.
Requirements
Python 3.8 or above is required.
Documentation
For the latest documentation, see
Quickstart
Install the library with pip install databricks-sql-connector
export DATABRICKS_HOST=********.databricks.com
export DATABRICKS_HTTP_PATH=/sql/1.0/endpoints/****************
Example usage:
import os
from databricks import sql
host = os.getenv("DATABRICKS_HOST")
http_path = os.getenv("DATABRICKS_HTTP_PATH")
connection = sql.connect(
server_hostname=host,
http_path=http_path)
cursor = connection.cursor()
cursor.execute('SELECT :param `p`, * FROM RANGE(10)', {"param": "foo"})
result = cursor.fetchall()
for row in result:
print(row)
cursor.close()
connection.close()
In the above example:
server-hostnameis the Databricks instance host name.http-pathis 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)
Note: This example uses Databricks OAuth U2M to authenticate the target Databricks user account and needs to open the browser for authentication. So it can only run on the user's machine.
Contributing
See CONTRIBUTING.md