Skip to main content

Databricks SQL Connector for Python

Project description

Databricks SQL Connector for Python

PyPI Downloads

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 SQLAlchemy to execute DDL.

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.7 or above is required.

Documentation

For the latest documentation, see

Quickstart

Install the library with pip install databricks-sql-connector

Example usage:

from databricks import sql

connection = sql.connect(
  server_hostname='********.databricks.com',
  http_path='/sql/1.0/endpoints/****************',
  access_token='dapi********************************')


cursor = connection.cursor()

cursor.execute('SELECT * FROM RANGE(10)')
result = cursor.fetchall()
for row in result:
  print(row)

cursor.close()
connection.close()

In the above example:

  • server-hostname is the Databricks instance host name.
  • http-path 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)
  • personal-access-token is the Databricks Personal Access Token for the account that will execute commands and queries

Contributing

See CONTRIBUTING.md

License

Apache License 2.0

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file databricks_sql_connector-2.2.dev1676479629.tar.gz.

File metadata

File hashes

Hashes for databricks_sql_connector-2.2.dev1676479629.tar.gz
Algorithm Hash digest
SHA256 77b0c08889c3a9d68886084d8d16b8ec015c1752f6d62103e0e5889448f6bc6a
MD5 d252036799f68cb4f0abd6488c8ca182
BLAKE2b-256 7c0508b8bc4b3358807d05681e5f91cac34a42e56b35fe426d59dcfc66cb8a9a

See more details on using hashes here.

File details

Details for the file databricks_sql_connector-2.2.dev1676479629-py3-none-any.whl.

File metadata

File hashes

Hashes for databricks_sql_connector-2.2.dev1676479629-py3-none-any.whl
Algorithm Hash digest
SHA256 3e39d9634f140737cbc8b04dba5294551a72b4356949d7bdb73662618ea82300
MD5 c5a964d63616c4d9cc768960a8509164
BLAKE2b-256 59890bf763efd07b0c7fbf887083e23e8ccee8a038b7864679c6b3d291f25b30

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page