Skip to content

Commit

Permalink
Fix non-existing reference and typo in the documentation (#104)
Browse files Browse the repository at this point in the history
The title says it all
  • Loading branch information
JCZuurmond authored May 24, 2024
1 parent 1bfcf61 commit dd280a5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Results are fetched in JSON format through presigned external links. This is per
like AWS Lambda, Azure Functions, or any other containerised short-lived applications, where container startup
time is faster with the smaller dependency set.

Applications, that need to a more traditional SQL Python APIs with cursors, efficient data transfer of hundreds of
Applications, that need a more traditional SQL Python APIs with cursors, efficient data transfer of hundreds of
megabytes or gigabytes of data serialized in Apache Arrow format, and low result fetching latency, should use
the stateful Databricks SQL Connector for Python.

Expand Down
12 changes: 9 additions & 3 deletions docs/comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
<!-- TOC -->
* [Library size comparison](#library-size-comparison)
* [Pick the library that you need](#pick-the-library-that-you-need)
* [Detailed comparison](#detailed-comparison)
* [Databricks Connect](#databricks-connect)
* [Databricks SQL Connector](#databricks-sql-connector)
* [Databricks Labs LightSQL](#databricks-labs-lightsql)
Expand All @@ -11,9 +12,10 @@
## Pick the library that you need

_Simple applications_, like AWS Lambdas or Azure Functions, and scripts, that are **constrained by the size of external
dependencies** or **cannot depend on compiled libraries**, like `pyarrow` (88M), `pandas` (71M), `numpy` (60M),
`libarrow` (41M), `cygrpc` (30M), `libopenblas64` (22M), **need less than 5M of dependencies** (see [detailed report](docs/comparison.md)),
experience the [Unified Authentication](https://docs.databricks.com/en/dev-tools/auth.html#databricks-client-unified-authentication), and **work only with Databricks SQL Warehouses**, should use this library.
dependencies** or **cannot depend on compiled libraries**, like `pyarrow` (88M), `pandas` (71M), `numpy` (60M),
`libarrow` (41M), `cygrpc` (30M), `libopenblas64` (22M), **need less than 5M of dependencies** , experience
the [Unified Authentication](https://docs.databricks.com/en/dev-tools/auth.html#databricks-client-unified-authentication),
and **work only with Databricks SQL Warehouses**, should use this library.

Applications, that need the full power of Databricks Runtime locally with the full velocity of PySpark SDL, experience
the [Unified Authentication](https://docs.databricks.com/en/dev-tools/auth.html#databricks-client-unified-authentication)
Expand All @@ -24,6 +26,10 @@ Applications, that need to a more traditional SQL Python APIs with cursors, effi
megabytes or gigabytes of data serialized in Apache Arrow format, and low result fetching latency, should use
the stateful [Databricks SQL Connector for Python](https://docs.databricks.com/en/dev-tools/python-sql-connector.html).

[[back to top](#library-size-comparison)]

## Detailed comparison

| ... | Databricks Connect 2.x | Databricks SQL Connector | PyODBC + ODBC Driver | Databricks Labs LightSQL |
|-----------------------------------------|----------------------------------------|---------------------------------------------------|---------------------------------------------------|------------------------------------|
| Light-weight mocking | no | no | no | **yes** |
Expand Down

0 comments on commit dd280a5

Please sign in to comment.