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

This version

2.2.2

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.2.2.tar.gz (208.0 kB view details)

Uploaded Source

Built Distribution

databricks_sql_connector-2.2.2-py3-none-any.whl (213.6 kB view details)

Uploaded Python 3

File details

Details for the file databricks_sql_connector-2.2.2.tar.gz.

File metadata

  • Download URL: databricks_sql_connector-2.2.2.tar.gz
  • Upload date:
  • Size: 208.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.10.2 Linux/5.15.0-1024-azure

File hashes

Hashes for databricks_sql_connector-2.2.2.tar.gz
Algorithm Hash digest
SHA256 54c42b5d70b8a54ae9b67ccd80873e92be93a5c8227667cc9730f7feaa3845c6
MD5 a9bc2146c33584da4556ad36f0dc9179
BLAKE2b-256 8b462d504ac5de29ff6369ac9c4c3737f39940658d64d9c7022dfd410859f8d4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for databricks_sql_connector-2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fa03ff31e9b0423237cb3735511b1d4621e420ae126c8fc8e0096a9b818d5c1c
MD5 3500d825512a03f14c34a1af13b2a898
BLAKE2b-256 84a547219622c0c53f6e7e220bf880c0749d71abab1e97d489aad83aaf7c6d50

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