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

databricks-sql-connector-2.0.5.tar.gz (201.3 kB view details)

Uploaded Source

Built Distribution

databricks_sql_connector-2.0.5-py3-none-any.whl (204.2 kB view details)

Uploaded Python 3

File details

Details for the file databricks-sql-connector-2.0.5.tar.gz.

File metadata

  • Download URL: databricks-sql-connector-2.0.5.tar.gz
  • Upload date:
  • Size: 201.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.7.9 Darwin/21.6.0

File hashes

Hashes for databricks-sql-connector-2.0.5.tar.gz
Algorithm Hash digest
SHA256 f744fe26010d7798e4bb7a9c6106a2bf2cb6da63381b8e2e7b0a4beae374c0cd
MD5 a30baa666000164f08c3e9d5d4e2f6c4
BLAKE2b-256 8f410a890d696f8527cb7ad98a57acfb70e865e7637ec97b68dd2b85a3a357b5

See more details on using hashes here.

File details

Details for the file databricks_sql_connector-2.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for databricks_sql_connector-2.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a0db589ac35446989e129aef51b22f615dc1f65b143e90717aa85320d7f82284
MD5 53ff2a7bda8a2dc6f23ecdc8ca9efe41
BLAKE2b-256 c64a927d366be00743186cf1dcce25bdabb2a5c55b0386a508bcf77c18d67cc2

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