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.dev1666624638.tar.gz.

File metadata

File hashes

Hashes for databricks-sql-connector-2.1.dev1666624638.tar.gz
Algorithm Hash digest
SHA256 eca47df862fd02554ad3cef94b7d3668f5fc66f4ba32eaaaf52ff2d73e1ce57e
MD5 fb676e95b376f10ab804ca3696613d24
BLAKE2b-256 1d1c665837e6851dc2129d77c63b07a62b1f94e63b06fde0135d62e43b3ef066

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for databricks_sql_connector-2.1.dev1666624638-py3-none-any.whl
Algorithm Hash digest
SHA256 893ec08d2c57702bacc4017c58fd82b33a82ca62b533ffc142a5b3d6da54f526
MD5 0e3ff2fa2dd0e7df9a9c8e9eaf989884
BLAKE2b-256 d29f09529c7e35b6541379b23e60fb16a6ad7bd76bcf9abb8c161e1b119d6c81

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