Skip to content

Commit 38ffa95

Browse files
authored
[PECO-1803] Remove sqlalchemy and update README.md (#469)
Remove sqlalchemy and update README.md Signed-off-by: Jacky Hu <[email protected]>
1 parent 85af9c0 commit 38ffa95

File tree

6 files changed

+12
-573
lines changed

6 files changed

+12
-573
lines changed

CONTRIBUTING.md

-3
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,6 @@ The `PySQLStagingIngestionTestSuite` namespace requires a cluster running DBR ve
144144

145145
The suites marked `[not documented]` require additional configuration which will be documented at a later time.
146146

147-
#### SQLAlchemy dialect tests
148-
149-
See README.tests.md for details.
150147

151148
### Code formatting
152149

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
[![PyPI](https://img.shields.io/pypi/v/databricks-sql-connector?style=flat-square)](https://pypi.org/project/databricks-sql-connector/)
44
[![Downloads](https://pepy.tech/badge/databricks-sql-connector)](https://pepy.tech/project/databricks-sql-connector)
55

6-
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.
6+
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/).
77

8-
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.
8+
This connector uses Arrow as the data-exchange format, and supports APIs (e.g. `fetchmany_arrow`) 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. [PyArrow](https://arrow.apache.org/docs/python/index.html) is required to enable this and use these APIs, you can install it via `pip install pyarrow` or `pip install databricks-sql-connector[pyarrow]`.
99

1010
You are welcome to file an issue here for general use cases. You can also contact Databricks Support [here](help.databricks.com).
1111

@@ -22,7 +22,7 @@ For the latest documentation, see
2222

2323
## Quickstart
2424

25-
Install the library with `pip install databricks-sql-connector`
25+
Install the library with `pip install databricks-sql-connector[pyarrow]`
2626

2727
```bash
2828
export DATABRICKS_HOST=********.databricks.com

examples/sqlalchemy.py

-174
This file was deleted.

0 commit comments

Comments
 (0)