Skip to content

Commit f7e9852

Browse files
committed
Documentation improvements
1 parent 2bfc0be commit f7e9852

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ Write SQL queries in a simple and composable way.
33
The main goal is to find the best balance between write idiomatic SQL queries and manage cenarios
44
of complex query composition mixed with conditional clauses.
55

6-
The [full documentation](https://docs.rs/sql_query_builder/)
76

87
## Quick Start
98

@@ -32,14 +31,27 @@ Output
3231
SELECT id, login FROM users WHERE login = $1 AND is_admin = true
3332
```
3433

34+
35+
## Feature Flags
36+
37+
SQL Query Builder comes with the following optional features:
38+
- `postgresql` enable Postgres syntax
39+
40+
You can enable features like
41+
42+
```toml
43+
# Cargo.toml
44+
45+
sql_query_builder = { version = "0.x.x", features = ["postgresql"] }
46+
```
47+
48+
49+
## How it's works
3550
In simple terms this library will not try to understand what you are writing inside the arguments, this is good
3651
because it's removes a lot complexity and verbosity that other libraries needs to generate a SQL query,
3752
in contrast debugging tends to be more difficult and silly error can araise.
3853
The lib has `.debug()` method with a nice output to minimize the effort to debug a complex query.
3954

40-
41-
## How it's works
42-
4355
Consecutive calls to the same clause will accumulates values respecting the order of the calls,
4456
the two select produce the same SQL query
4557

@@ -200,15 +212,4 @@ let select = SelectBuilder::new()
200212
```
201213

202214

203-
## Feature Flags
204-
205-
SQL Query Builder comes with the following optional features:
206-
- `postgresql` enable Postgres syntax
207-
208-
You can enable features like
209-
210-
```toml
211-
# Cargo.toml
212-
213-
sql_query_builder = { version = "0.x.x", features = ["postgresql"] }
214-
```
215+
See the [documentation](https://docs.rs/sql_query_builder/) for more builders like `InsertBuilder`, `UpdateBuilder` and `DeleteBuilder`

0 commit comments

Comments
 (0)