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 that uses 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.dev1675985183.tar.gz.

File metadata

File hashes

Hashes for databricks_sql_connector-2.2.dev1675985183.tar.gz
Algorithm Hash digest
SHA256 81ea40bc5392c409d7febe245b15f49090ed42065587d6b095381dfaa76f08b0
MD5 9a8a4ac3b8152ed5092b4af0c2ac3704
BLAKE2b-256 31174ae891185a5241370fa79c3557b1a3d8e2edf078fca10d4bc96ba58ef5e7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for databricks_sql_connector-2.2.dev1675985183-py3-none-any.whl
Algorithm Hash digest
SHA256 20759ae59513b1d46edc764842e604eed233eab330066846dcabc4aa778ba24a
MD5 51d66d4ad48174f44a9bd2f6a94ad878
BLAKE2b-256 c255b02aaffa7b4e246d4efb8f0829dbe21280c16e81123314873a623e95387f

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