Skip to content

Commit 72c5ed4

Browse files
committed
docs: adjust to new terminology
- renamed `queries` directory to `statements`. - renamed `queries.md` -> `statements.md`. - rename `simple.md` -> `unprepared.md` Apart from that, I adjusted the documentation to use the new terminology.
1 parent cfcffee commit 72c5ed4

28 files changed

+209
-209
lines changed

docs/source/SUMMARY.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- [Quick start](quickstart/quickstart.md)
66
- [Creating a project](quickstart/create-project.md)
77
- [Running Scylla using Docker](quickstart/scylla-docker.md)
8-
- [Connecting and running a simple query](quickstart/example.md)
8+
- [Connecting and executing a simple CQL statement](quickstart/example.md)
99

1010
- [Migration guides](migration-guides/migration-guides.md)
1111
- [Adjusting code to changes in serialization API introduced in 0.11](migration-guides/0.11-serialization.md)
@@ -16,18 +16,18 @@
1616
- [Authentication](connecting/authentication.md)
1717
- [TLS](connecting/tls.md)
1818

19-
- [Making queries](queries/queries.md)
20-
- [Simple query](queries/simple.md)
21-
- [Query values](queries/values.md)
22-
- [Query result](queries/result.md)
23-
- [Prepared query](queries/prepared.md)
24-
- [Batch statement](queries/batch.md)
25-
- [Paged query](queries/paged.md)
26-
- [Lightweight transaction query (LWT)](queries/lwt.md)
27-
- [USE keyspace](queries/usekeyspace.md)
28-
- [Schema agreement](queries/schema-agreement.md)
29-
- [Query timeouts](queries/timeouts.md)
30-
- [Timestamp generators](queries/timestamp-generators.md)
19+
- [Executing CQL statements](statements/statements.md)
20+
- [Unprepared statement](statements/unprepared.md)
21+
- [Statement values](statements/values.md)
22+
- [Query result](statements/result.md)
23+
- [Prepared statement](statements/prepared.md)
24+
- [Batch statement](statements/batch.md)
25+
- [Paged query](statements/paged.md)
26+
- [Lightweight transaction statement (LWT)](statements/lwt.md)
27+
- [USE keyspace](statements/usekeyspace.md)
28+
- [Schema agreement](statements/schema-agreement.md)
29+
- [Request timeouts](statements/timeouts.md)
30+
- [Timestamp generators](statements/timestamp-generators.md)
3131

3232
- [Execution profiles](execution-profiles/execution-profiles.md)
3333
- [Creating a profile and setting it](execution-profiles/create-and-use.md)

docs/source/contents.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
index
77
quickstart/quickstart
88
connecting/connecting
9-
queries/queries
9+
statements/statements
1010
execution-profiles/execution-profiles
1111
data-types/data-types
1212
load-balancing/load-balancing

docs/source/data-types/data-types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ to achieve seamless sending and receiving of CQL values.
55

66
See the following chapters for examples on how to send and receive each data type.
77

8-
See [Query values](../queries/values.md) for more information about sending values in queries.\
9-
See [Query result](../queries/result.md) for more information about reading values from queries
8+
See [Statement values](../statements/values.md) for more information about sending values along with statements.\
9+
See [Query result](../statements/result.md) for more information about retrieving values from queries
1010

1111
Database types and their Rust equivalents:
1212
* `Boolean` <----> `bool`

docs/source/execution-profiles/create-and-use.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ let session: Session = SessionBuilder::new()
2828
```
2929

3030
### Example
31-
To create an `ExecutionProfile` and attach it to a `Query`:
31+
To create an `ExecutionProfile` and attach it to a `Statement`:
3232
```rust
3333
# extern crate scylla;
3434
# use std::error::Error;

docs/source/execution-profiles/priority.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ let session: Session = SessionBuilder::new()
3535

3636
let mut query = Statement::from("SELECT * FROM ks.table");
3737

38-
// Query is not assigned any specific profile, so session's profile is applied.
39-
// Therefore, the query will be executed with Consistency::One.
38+
// Statement is not assigned any specific profile, so session's profile is applied.
39+
// Therefore, the statement will be executed with Consistency::One.
4040
session.query_unpaged(query.clone(), ()).await?;
4141

4242
query.set_execution_profile_handle(Some(query_profile.into_handle()));
43-
// Query's profile is applied.
44-
// Therefore, the query will be executed with Consistency::Two.
43+
// Statement's profile is applied.
44+
// Therefore, the statement will be executed with Consistency::Two.
4545
session.query_unpaged(query.clone(), ()).await?;
4646

4747
query.set_consistency(Consistency::Three);
48-
// An option is set directly on the query.
49-
// Therefore, the query will be executed with Consistency::Three.
48+
// An option is set directly on the Statement.
49+
// Therefore, the statement will be executed with Consistency::Three.
5050
session.query_unpaged(query, ()).await?;
5151

5252
# Ok(())

docs/source/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ Although optimized for Scylla, the driver is also compatible with [Apache Cassan
1212

1313

1414
## Contents
15-
* [Quick start](quickstart/quickstart.md) - Setting up a Rust project using `scylla-rust-driver` and running a few queries
15+
* [Quick start](quickstart/quickstart.md) - Setting up a Rust project using `scylla-rust-driver` and executing a few CQL statements
1616
* [Migration guides](migration-guides/migration-guides.md) - How to update the code that used an older version of this driver
1717
* [Connecting to the cluster](connecting/connecting.md) - Configuring a connection to scylla cluster
18-
* [Making queries](queries/queries.md) - Making different types of queries (simple, prepared, batch, paged)
19-
* [Execution profiles](execution-profiles/execution-profiles.md) - Grouping query execution configuration options together and switching them all at once
18+
* [CQL statement execution](statements/statements.md) - Executing different types of CQL statement (simple, prepared, batch, paged)
19+
* [Execution profiles](execution-profiles/execution-profiles.md) - Grouping statement execution configuration options together and switching them all at once
2020
* [Data Types](data-types/data-types.md) - How to use various column data types
2121
* [Load balancing](load-balancing/load-balancing.md) - Load balancing configuration
22-
* [Retry policy configuration](retry-policy/retry-policy.md) - What to do when a query fails, query idempotence
23-
* [Driver metrics](metrics/metrics.md) - Statistics about the driver - number of queries, latency etc.
22+
* [Retry policy configuration](retry-policy/retry-policy.md) - What to do when execution attempt fails, statement idempotence
23+
* [Driver metrics](metrics/metrics.md) - Statistics about the driver - number of executed statements, latency etc.
2424
* [Logging](logging/logging.md) - Viewing and integrating logs produced by the driver
25-
* [Query tracing](tracing/tracing.md) - Tracing query execution
25+
* [Request tracing](tracing/tracing.md) - Tracing request execution
2626
* [Database schema](schema/schema.md) - Fetching and inspecting database schema

docs/source/queries/lwt.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

docs/source/retry-policy/default.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ let session: Session = SessionBuilder::new()
3030
# }
3131
```
3232

33-
To use in a [simple query](../queries/simple.md):
33+
To use in an [unprepared statement](../statements/unprepared.md):
3434
```rust
3535
# extern crate scylla;
3636
# use scylla::client::session::Session;
@@ -41,25 +41,25 @@ use scylla::statement::unprepared::Statement;
4141
use scylla::client::execution_profile::ExecutionProfile;
4242
use scylla::policies::retry::DefaultRetryPolicy;
4343

44-
// Create a Query manually and set the retry policy
45-
let mut my_query: Statement = Statement::new("INSERT INTO ks.tab (a) VALUES(?)");
46-
my_query.set_retry_policy(Some(Arc::new(DefaultRetryPolicy::new())));
44+
// Create a Statement manually and set the retry policy
45+
let mut my_statement: Statement = Statement::new("INSERT INTO ks.tab (a) VALUES(?)");
46+
my_statement.set_retry_policy(Some(Arc::new(DefaultRetryPolicy::new())));
4747

4848
// You can also set retry policy in an execution profile
4949
let handle = ExecutionProfile::builder()
5050
.retry_policy(Arc::new(DefaultRetryPolicy::new()))
5151
.build()
5252
.into_handle();
53-
my_query.set_execution_profile_handle(Some(handle));
53+
my_statement.set_execution_profile_handle(Some(handle));
5454

55-
// Run the query using this retry policy
55+
// Execute the statement using this retry policy
5656
let to_insert: i32 = 12345;
57-
session.query_unpaged(my_query, (to_insert,)).await?;
57+
session.query_unpaged(my_statement, (to_insert,)).await?;
5858
# Ok(())
5959
# }
6060
```
6161

62-
To use in a [prepared query](../queries/prepared.md):
62+
To use in a [prepared statement](../statements/prepared.md):
6363
```rust
6464
# extern crate scylla;
6565
# use scylla::client::session::Session;
@@ -83,7 +83,7 @@ let handle = ExecutionProfile::builder()
8383
.into_handle();
8484
prepared.set_execution_profile_handle(Some(handle));
8585

86-
// Run the query using this retry policy
86+
// Execute the statement using this retry policy
8787
let to_insert: i32 = 12345;
8888
session.execute_unpaged(&prepared, (to_insert,)).await?;
8989
# Ok(())

docs/source/retry-policy/downgrading-consistency.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ let session: Session = SessionBuilder::new()
7171
# }
7272
```
7373

74-
To use in a [simple query](../queries/simple.md):
74+
To use in an [unprepared statement](../statements/unprepared.md):
7575
```rust
7676
# extern crate scylla;
7777
# use scylla::client::session::Session;
@@ -87,18 +87,18 @@ let handle = ExecutionProfile::builder()
8787
.build()
8888
.into_handle();
8989

90-
// Create a Query manually and set the retry policy
91-
let mut my_query: Statement = Statement::new("INSERT INTO ks.tab (a) VALUES(?)");
92-
my_query.set_execution_profile_handle(Some(handle));
90+
// Create a Statement manually and set the retry policy
91+
let mut my_statement: Statement = Statement::new("INSERT INTO ks.tab (a) VALUES(?)");
92+
my_statement.set_execution_profile_handle(Some(handle));
9393

94-
// Run the query using this retry policy
94+
// Execute the statement using this retry policy
9595
let to_insert: i32 = 12345;
96-
session.query_unpaged(my_query, (to_insert,)).await?;
96+
session.query_unpaged(my_statement, (to_insert,)).await?;
9797
# Ok(())
9898
# }
9999
```
100100

101-
To use in a [prepared query](../queries/prepared.md):
101+
To use in a [prepared statement](../statements/prepared.md):
102102
```rust
103103
# extern crate scylla;
104104
# use scylla::client::session::Session;
@@ -122,7 +122,7 @@ let mut prepared: PreparedStatement = session
122122
prepared.set_execution_profile_handle(Some(handle));
123123

124124

125-
// Run the query using this retry policy
125+
// Execute the statement using this retry policy
126126
let to_insert: i32 = 12345;
127127
session.execute_unpaged(&prepared, (to_insert,)).await?;
128128
# Ok(())

docs/source/retry-policy/fallthrough.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ let session: Session = SessionBuilder::new()
2929
# }
3030
```
3131

32-
To use in a [simple query](../queries/simple.md):
32+
To use in an [unprepared statement](../statements/unprepared.md):
3333
```rust
3434
# extern crate scylla;
3535
# use scylla::client::session::Session;
@@ -45,18 +45,18 @@ let handle = ExecutionProfile::builder()
4545
.build()
4646
.into_handle();
4747

48-
// Create a Query manually and set the retry policy
49-
let mut my_query: Statement = Statement::new("INSERT INTO ks.tab (a) VALUES(?)");
50-
my_query.set_execution_profile_handle(Some(handle));
48+
// Create a Statement manually and set the retry policy
49+
let mut my_statement: Statement = Statement::new("INSERT INTO ks.tab (a) VALUES(?)");
50+
my_statement.set_execution_profile_handle(Some(handle));
5151

52-
// Run the query using this retry policy
52+
// Execute the statement using this retry policy
5353
let to_insert: i32 = 12345;
54-
session.query_unpaged(my_query, (to_insert,)).await?;
54+
session.query_unpaged(my_statement, (to_insert,)).await?;
5555
# Ok(())
5656
# }
5757
```
5858

59-
To use in a [prepared query](../queries/prepared.md):
59+
To use in a [prepared statement](../statements/prepared.md):
6060
```rust
6161
# extern crate scylla;
6262
# use scylla::client::session::Session;

0 commit comments

Comments
 (0)