prepared: docs for PreparedStatement
#986
Merged
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
|
|
wprzytula
requested changes
Apr 23, 2024
wprzytula
requested changes
Apr 23, 2024
muzarski
force-pushed
the
docstrings_for_cached_metadata
branch
from
4798ca3 to
89fcb27
Compare
muzarski
changed the title
PreparedStatement
muzarski
force-pushed
the
docstrings_for_cached_metadata
branch
from
89fcb27 to
08baf66
Compare
wprzytula
requested changes
Apr 26, 2024
docs/source/index.md
Outdated
| @@ -15,7 +15,7 @@ Although optimized for Scylla, the driver is also compatible with [Apache Cassan | |||
| * [Quick start](quickstart/quickstart.md) - Setting up a Rust project using `scylla-rust-driver` and running a few queries | |||
| * [Migration guides](migration-guides/migration-guides.md) - How to update the code that used an older version of this driver | |||
| * [Connecting to the cluster](connecting/connecting.md) - Configuring a connection to scylla cluster | |||
| * [Making queries](queries/queries.md) - Making different types of queries (simple, prepared, batch, paged) | |||
| * [Making queries](queries/queries.md) - Making different types of queries (unprepared, prepared, batch, paged) | |||
There was a problem hiding this comment.
Let's ditch the notion of query from the driver and use statement exclusively. Here, I would replace making queries with creating and executing statements.
There was a problem hiding this comment.
That would require a change in naming (replacing Query with UnpreparedStatement), otherwise you would have a Query type but not of the docs would mention queries. What do yuo think about splitting in in 2 PRs - in this one let's improve prepared statement docs, and in the next one let's replace Query with UnpreparedStatement (and fix docs), which would fix #713
There was a problem hiding this comment.
Sounds good to me, I can take care of that.
Lorak-mmk
requested changes
Apr 29, 2024
muzarski
force-pushed
the
docstrings_for_cached_metadata
branch
from
08baf66 to
0530445
Compare
|
v2: addressed review comments:
|
wprzytula
reviewed
May 6, 2024
muzarski
force-pushed
the
docstrings_for_cached_metadata
branch
from
0530445 to
10556e3
Compare
wprzytula
removed
the
waiting-on-author
wprzytula
approved these changes
May 14, 2024
Lorak-mmk
approved these changes
May 14, 2024
This was referenced May 14, 2024
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.
In response to #970 (comment).
Added docstring for
PreparedStatement, which mentions:Pre-review checklist
./docs/source/.Fixes:annotations to PR description.