Skip to content

Conversation

@susodapop
Copy link
Contributor

Updating the README prior to announcing the public release at DAIS.

@susodapop susodapop requested review from a team and arikfr June 23, 2022 23:28
Copy link
Collaborator

@moderakh moderakh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @susodapop

README.md Outdated
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. And it conforms to the [Python DB API 2.0 specification](https://www.python.org/dev/peps/pep-0249/).

Documentation can be found here: [Databricks SQL Connector for Python](https://docs.databricks.com/dev-tools/python-sql-connector.html).
The initial public release (`v1.0`) was a very lightly modified version of [PyHive](https://pypi.org/project/PyHive/). The `v2.0` release was a complete from scratch re-write, with the same public API. Since `v2.0`, it uses Arrow as the data-exchange format. `v2.0` also 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.
Copy link
Collaborator

@moderakh moderakh Jun 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The v2.0 release was a complete from scratch re-write, with the same public API.

can a customer who is using v1. just bump the version of dependency and use v1 in their code without making any code change other than version bump?

are there any breaking changes from v1 -> v2?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so, yes. However, after conferring with @taotao-db I removed the reference to the v1 connector. I included it originally because I was confused. I thought the v1 code was contained in the commit history here. But it's actually housed elsewhere and will not be open sourced AFAIK. So best not to reference it here to avoid confusion.

@susodapop susodapop merged commit e8b4d01 into main Jun 24, 2022
@susodapop susodapop deleted the susodapop-patch-1 branch June 24, 2022 17:45
PeterDKay referenced this pull request in sede-open/databricks-sql-python May 25, 2023
saishreeeee pushed a commit that referenced this pull request Jun 4, 2025
saishreeeee pushed a commit that referenced this pull request Jun 4, 2025
Signed-off-by: Sai Shree Pradhan <saishree.pradhan@databricks.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants