Skip to content

Commit 2a3e0f8

Browse files
committed
docs: improve documentation for query_raw method
1 parent 6bfcf50 commit 2a3e0f8

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ If something is missing, or you found a mistake in one of these examples, please
99
### General usage
1010

1111
- [usage.rs](usage.rs) - creating tables, executing other DDLs, inserting the data, and selecting it back. Additionally, it covers `WATCH` queries. Optional cargo features: `inserter`, `watch`.
12-
- [query_raw.rs](query_raw.rs) - raw queries without parameter binding, with question mark escaping. FORMAT is the RowBinary by default
12+
- [query_raw.rs](query_raw.rs) - raw queries executes SQL queries exactly as written, without parameter binding or preprocessing. This allows queries containing literal question marks that would otherwise be treated as bind parameters. FORMAT is the RowBinary by default
1313
- [mock.rs](mock.rs) - writing tests with `mock` feature. Cargo features: requires `test-util`.
1414
- [inserter.rs](inserter.rs) - using the client-side batching via the `inserter` feature. Cargo features: requires `inserter`.
1515
- [async_insert.rs](async_insert.rs) - using the server-side batching via the [asynchronous inserts](https://clickhouse.com/docs/en/optimize/asynchronous-inserts) ClickHouse feature

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ impl Client {
331331
/// # Parameters
332332
///
333333
/// - **Input**: `&str` - the raw SQL query to be executed
334-
/// - **Output**: [`Query`] - the query builder that executes the query
334+
/// - **Output**: [`query::Query`] - the query builder that executes the query
335335
///
336336
pub fn query_raw(&self, query: &str) -> query::Query {
337337
query::Query::raw(self, query)

0 commit comments

Comments
 (0)