https://github.com/databricks/databricks-sql-python

Databricks SQL Connector for Python
https://github.com/databricks/databricks-sql-python

databricks dwh python3 sql

Last synced: 7 days ago
JSON representation

Databricks SQL Connector for Python

• Host: GitHub
• URL: https://github.com/databricks/databricks-sql-python
• Owner: databricks
• License: apache-2.0
• Created: 2022-05-18T14:20:03.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-16T17:29:52.000Z (9 days ago)
• Last Synced: 2024-12-16T21:13:40.356Z (9 days ago)
• Topics: databricks, dwh, python3, sql
• Language: Python
• Homepage:
• Size: 1.62 MB
• Stars: 172
• Watchers: 23
• Forks: 97
• Open Issues: 91
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Databricks SQL Connector for Python

[![PyPI](https://img.shields.io/pypi/v/databricks-sql-connector?style=flat-square)](https://pypi.org/project/databricks-sql-connector/)

[![Downloads](https://pepy.tech/badge/databricks-sql-connector)](https://pepy.tech/project/databricks-sql-connector)

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](https://www.python.org/dev/peps/pep-0249/) and exposes a [SQLAlchemy](https://www.sqlalchemy.org/) dialect for use with tools like `pandas` and `alembic` which use SQLAlchemy to execute DDL. Use `pip install databricks-sql-connector[sqlalchemy]` to install with SQLAlchemy's dependencies. `pip install databricks-sql-connector[alembic]` will install alembic's dependencies.

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](help.databricks.com).

## Requirements

Python 3.8 or above is required.

## Documentation

For the latest documentation, see

- [Databricks](https://docs.databricks.com/dev-tools/python-sql-connector.html)

- [Azure Databricks](https://docs.microsoft.com/en-us/azure/databricks/dev-tools/python-sql-connector)

## Quickstart

Install the library with `pip install databricks-sql-connector`

```bash

export DATABRICKS_HOST=********.databricks.com

export DATABRICKS_HTTP_PATH=/sql/1.0/endpoints/****************

```

Example usage:

```python

import os

from databricks import sql

host = os.getenv("DATABRICKS_HOST")

http_path = os.getenv("DATABRICKS_HTTP_PATH")

connection = sql.connect(

  server_hostname=host,

  http_path=http_path)

cursor = connection.cursor()

cursor.execute('SELECT :param `p`, * FROM RANGE(10)', {"param": "foo"})

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)

> Note: This example uses [Databricks OAuth U2M](https://docs.databricks.com/en/dev-tools/auth/oauth-u2m.html) 

> to authenticate the target Databricks user account and needs to open the browser for authentication. So it 

> can only run on the user's machine.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

[Apache License 2.0](LICENSE)