chore: adjust <Backend>.do_connect() be kw or positional only, add callouts to url connection method #10985
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
impala
NickCrews
changed the title
|
ACTION NEEDED Ibis follows the Conventional Commits specification for release automation. The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification. |
NickCrews
added
breaking change
NickCrews
force-pushed
the
do_connect-tweaks
branch
from
d454f9a to
21ebc1b
Compare
NickCrews
changed the title
ibis-docs-bot
bot
removed
the
docs-preview
NickCrews
force-pushed
the
do_connect-tweaks
branch
from
21ebc1b to
c0fb341
Compare
NickCrews
changed the title
…outs to url connection method
NickCrews
force-pushed
the
do_connect-tweaks
branch
from
c0fb341 to
b18d5ea
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
resolves #10901
This not only adds better docs, but it also is slightly breaking
by mkaing many args kwarg-only. So if someone was doing
ibis.bigquery.connect("my-project-id", "my-dataset-id")then that would be broken. For most backends, there are so many connection params, I would expect most devs to pass them by kwarg already, but I bet this will affect some people.This is also potentially slightly breaking for duckdb and sqlite by making the database path positional-only. I'm not as sure about if this is a good idea.
Let me know, I can adjust the scope of this as you want.