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.

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.1.dev1672379067.tar.gz.

File metadata

File hashes

Hashes for databricks_sql_connector-2.1.dev1672379067.tar.gz
Algorithm Hash digest
SHA256 63ec7fc84aa8b63e93c85aa3987bf4a5614dda36a10b9f47e14816c10da25761
MD5 3b261c5fc5bf2cbcdc8853f41a3e0cfb
BLAKE2b-256 655a883550beaff825e230dc2af3442882da9c471553f2a67b7126ba67787112

See more details on using hashes here.

File details

Details for the file databricks_sql_connector-2.1.dev1672379067-py3-none-any.whl.

File metadata

File hashes

Hashes for databricks_sql_connector-2.1.dev1672379067-py3-none-any.whl
Algorithm Hash digest
SHA256 6e81ce7b1eb65ddf2f9643bc228509b3c2b46fee69d7a406d28e9722743a96ea
MD5 bb730e65c10fbd6b122d24e3d2e78bf8
BLAKE2b-256 d3e2d796d2a826c3affe47775471a118b55eb4db9f1332cf7aa1fff1854732db

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