Skip to content

Commit 19b977e

Browse files
regenerate docs (#206)
1 parent 5d82e7e commit 19b977e

File tree

2 files changed

+19
-18
lines changed

2 files changed

+19
-18
lines changed

README.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -74,26 +74,27 @@ Advanced functionality - varies between databases:
7474

7575
More info can be found in [here](https://docs.sqlc.dev/en/stable/reference/query-annotations.html).
7676

77-
## Macros Annotations
77+
## Macro Annotations
7878
- `sqlc.arg` - Attach a name to a parameter in a SQL query
79-
- `sqlc.embed` - Embedding allows you to reuse existing model structs in more queries
8079
- `sqlc.narg` - The same as `sqlc.arg`, but always marks the parameter as nullable
8180
- `sqlc.slice` - For databases that do not support passing arrays to the `IN` operator, generates a dynamic query at runtime with the correct number of parameters
81+
- `sqlc.embed` - Embedding allows you to reuse existing model structs in more queries
8282

8383
<br/>
8484

85-
| Annotation | PostgresSQL | MySQL | SQLite |
86-
|-------------|-------------|-------|--------|
87-
| sqlc.arg | ✅ | ✅ | ✅ |
88-
| sqlc.embed | ❌ | ❌ | ❌ |
89-
| sqlc.narg | ❌ | | ❌ |
90-
| sqlc.slice | 🚫 | | ❌ |
85+
| Annotation | PostgresSQL | MySQL | SQLite |
86+
|-------------|-------------|-------|---------|
87+
| sqlc.arg | ✅ | ✅ | ✅ |
88+
| sqlc.narg | ❌ | ❌ | ❌ |
89+
| sqlc.slice | 🚫 | | ❌ |
90+
| sqlc.embed | | | ❌ |
9191

9292
- ✅ means the feature is fully supported.
9393
- 🚫 means the database does not support the feature.
9494
- ❌ means the feature is not supported by the plugin (but could be supported by the database).
9595

96-
More info can be found in [here](https://docs.sqlc.dev/en/stable/reference/macros.html#macros).# Contributing
96+
More info can be found in [here](https://docs.sqlc.dev/en/stable/reference/macros.html#macros).
97+
# Contributing
9798
## Local plugin development
9899
### Prerequisites
99100
Make sure that the following applications are installed and added to your path.

docs/03_Usage.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,23 @@ Advanced functionality - varies between databases:
3535

3636
More info can be found in [here](https://docs.sqlc.dev/en/stable/reference/query-annotations.html).
3737

38-
## Macros Annotations
38+
## Macro Annotations
3939
- `sqlc.arg` - Attach a name to a parameter in a SQL query
40-
- `sqlc.embed` - Embedding allows you to reuse existing model structs in more queries
4140
- `sqlc.narg` - The same as `sqlc.arg`, but always marks the parameter as nullable
4241
- `sqlc.slice` - For databases that do not support passing arrays to the `IN` operator, generates a dynamic query at runtime with the correct number of parameters
42+
- `sqlc.embed` - Embedding allows you to reuse existing model structs in more queries
4343

4444
<br/>
4545

46-
| Annotation | PostgresSQL | MySQL | SQLite |
47-
|-------------|-------------|-------|--------|
48-
| sqlc.arg ||| |
49-
| sqlc.embed ||| |
50-
| sqlc.narg | | | |
51-
| sqlc.slice | 🚫 | | |
46+
| Annotation | PostgresSQL | MySQL | SQLite |
47+
|-------------|-------------|-------|---------|
48+
| sqlc.arg ||||
49+
| sqlc.narg ||||
50+
| sqlc.slice | 🚫 | ||
51+
| sqlc.embed | | ||
5252

5353
- ✅ means the feature is fully supported.
5454
- 🚫 means the database does not support the feature.
5555
- ❌ means the feature is not supported by the plugin (but could be supported by the database).
5656

57-
More info can be found in [here](https://docs.sqlc.dev/en/stable/reference/macros.html#macros).
57+
More info can be found in [here](https://docs.sqlc.dev/en/stable/reference/macros.html#macros).

0 commit comments

Comments
 (0)