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.2.dev1669954165.tar.gz.

File metadata

File hashes

Hashes for databricks_sql_connector-2.2.dev1669954165.tar.gz
Algorithm Hash digest
SHA256 65b1acef8965145c8225b6d3e48cdeaa1801961d62cb7d92a2cf7b77b21e14fe
MD5 56fda707fb8cd2230fc1d090d121af9a
BLAKE2b-256 00eb0027caad96c26d683338c25a7f791b4ab3ba6d89ecfa7345694fe5dd57c5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for databricks_sql_connector-2.2.dev1669954165-py3-none-any.whl
Algorithm Hash digest
SHA256 8af79f0dac87680f8d6db4b4a948cba81b062cf51fc148ee16708498a4a6bc93
MD5 d6e4157963ed7e3d036982dd5cc33e70
BLAKE2b-256 7107db53a620a0e2160cfcd024b261bc07122ad6d1bf8ccd6dbdcda8364e14bb

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