Skip to content

Commit 68f8a2d

Browse files
committed
fix(docs): resolve MD060 table-column-style lint violations
- Add spaces to all table separator rows (|---|---| → | --- | --- |) across all 19 docs files to satisfy markdownlint MD060 compact style - Remove orphan duplicate row at end of docs/queries/create.md
1 parent c8dade6 commit 68f8a2d

19 files changed

Lines changed: 57 additions & 59 deletions

docs/api-reference.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Main entry point for SELECT queries and static gateway to DML builders.
2424
**Static factory methods**
2525

2626
| Method | Returns | Description |
27-
|--------|---------|-------------|
27+
| -------- | --------- | ------------- |
2828
| `insert()` | `InsertBuilder` | New `InsertBuilder` |
2929
| `insertInto(String table)` | `InsertBuilder` | New `InsertBuilder` pre-set to `table` |
3030
| `update()` | `UpdateBuilder` | New `UpdateBuilder` |
@@ -37,7 +37,7 @@ Main entry point for SELECT queries and static gateway to DML builders.
3737
**SELECT builder methods**
3838

3939
| Method | Returns | Description |
40-
|--------|---------|-------------|
40+
| -------- | --------- | ------------- |
4141
| `from(String table)` | `QueryBuilder` | Set source table |
4242
| `select(String... columns)` | `QueryBuilder` | Add columns to SELECT clause; omit for `SELECT *` |
4343
| `distinct()` | `QueryBuilder` | Add `DISTINCT` to SELECT |
@@ -82,7 +82,7 @@ Main entry point for SELECT queries and static gateway to DML builders.
8282
Lower-level SELECT builder that produces `SqlResult` directly (no `Query` intermediary).
8383

8484
| Method | Returns | Description |
85-
|--------|---------|-------------|
85+
| -------- | --------- | ------------- |
8686
| `from(String table)` | `SelectBuilder` | Set source table |
8787
| `select(String... columns)` | `SelectBuilder` | Add SELECT columns |
8888
| `distinct()` | `SelectBuilder` | Add `DISTINCT` |
@@ -102,7 +102,7 @@ Lower-level SELECT builder that produces `SqlResult` directly (no `Query` interm
102102
### `InsertBuilder`
103103

104104
| Method | Returns | Description |
105-
|--------|---------|-------------|
105+
| -------- | --------- | ------------- |
106106
| `into(String table)` | `InsertBuilder` | Set target table |
107107
| `value(String col, Object val)` | `InsertBuilder` | Add a column/value pair |
108108
| `build()` | `SqlResult` | Render with standard dialect |
@@ -113,7 +113,7 @@ Lower-level SELECT builder that produces `SqlResult` directly (no `Query` interm
113113
### `UpdateBuilder`
114114

115115
| Method | Returns | Description |
116-
|--------|---------|-------------|
116+
| -------- | --------- | ------------- |
117117
| `table(String table)` | `UpdateBuilder` | Set target table |
118118
| `set(String col, Object val)` | `UpdateBuilder` | Add a SET pair |
119119
| `whereEquals(col, val)` | `UpdateBuilder` | `WHERE col = ?` (AND) |
@@ -127,7 +127,7 @@ Lower-level SELECT builder that produces `SqlResult` directly (no `Query` interm
127127
### `DeleteBuilder`
128128

129129
| Method | Returns | Description |
130-
|--------|---------|-------------|
130+
| -------- | --------- | ------------- |
131131
| `from(String table)` | `DeleteBuilder` | Set target table |
132132
| `whereEquals(col, val)` | `DeleteBuilder` | `WHERE col = ?` (AND) |
133133
| `whereNotEquals(col, val)` | `DeleteBuilder` | `WHERE col != ?` (AND) |
@@ -147,7 +147,7 @@ Lower-level SELECT builder that produces `SqlResult` directly (no `Query` interm
147147
### `CreateBuilder`
148148

149149
| Method | Returns | Description |
150-
|--------|---------|-------------|
150+
| -------- | --------- | ------------- |
151151
| `table(String name)` | `CreateBuilder` | Set table name |
152152
| `column(String name, String sqlType)` | `CreateBuilder` | Add column definition |
153153
| `primaryKey(String name)` | `CreateBuilder` | Declare a primary key column |
@@ -164,7 +164,7 @@ Lower-level SELECT builder that produces `SqlResult` directly (no `Query` interm
164164
Enum of comparison operators. See [Conditions](conditions) for the full table.
165165

166166
| Constant | SQL |
167-
|----------|-----|
167+
| ---------- | ----- |
168168
| `EQ` | `= ?` |
169169
| `NEQ` | `!= ?` |
170170
| `GT` | `> ?` |
@@ -187,7 +187,7 @@ Enum of comparison operators. See [Conditions](conditions) for the full table.
187187
### `Condition`
188188

189189
| Member | Description |
190-
|--------|-------------|
190+
| -------- | ------------- |
191191
| `Condition(Operator op, Object value)` | Create a condition; `value` may be `null` |
192192
| `getOperator()` | Returns the `Operator` |
193193
| `getValue()` | Returns the comparison value (`null`, scalar, `List<?>`, or `Query`) |
@@ -198,7 +198,7 @@ Enum of comparison operators. See [Conditions](conditions) for the full table.
198198
### `ConditionEntry`
199199

200200
| Member | Description |
201-
|--------|-------------|
201+
| -------- | ------------- |
202202
| `ConditionEntry(String col, Condition cond, Connector connector)` | Create a condition entry |
203203
| `getColumn()` | Column name (`null` for EXISTS-subquery conditions) |
204204
| `getCondition()` | The wrapped `Condition` |
@@ -209,7 +209,7 @@ Enum of comparison operators. See [Conditions](conditions) for the full table.
209209
### `Connector`
210210

211211
| Constant | SQL keyword |
212-
|----------|-------------|
212+
| ---------- | ------------- |
213213
| `AND` | `AND` |
214214
| `OR` | `OR` |
215215

@@ -223,7 +223,7 @@ Immutable data holder produced by `QueryBuilder.build()`. All fields have
223223
getters and setters; setters are used exclusively by the builders.
224224

225225
| Getter | Type | Description |
226-
|--------|------|-------------|
226+
| -------- | ------ | ------------- |
227227
| `getTable()` | `String` | Source table name |
228228
| `getSelectColumns()` | `List<String>` | Columns in SELECT clause; empty = `SELECT *` |
229229
| `isDistinct()` | `boolean` | Whether `DISTINCT` is active |
@@ -244,7 +244,7 @@ getters and setters; setters are used exclusively by the builders.
244244
### `JoinClause`
245245

246246
| Member | Description |
247-
|--------|-------------|
247+
| -------- | ------------- |
248248
| `JoinClause(Type, String table, String on)` | Plain-table join |
249249
| `JoinClause(Type, Query subquery, String alias, String on)` | Subquery (derived-table) join |
250250
| `getType()` | `JoinClause.Type`: `INNER`, `LEFT`, `RIGHT`, or `CROSS` |
@@ -258,7 +258,7 @@ getters and setters; setters are used exclusively by the builders.
258258
### `ScalarSelectItem`
259259

260260
| Member | Description |
261-
|--------|-------------|
261+
| -------- | ------------- |
262262
| `ScalarSelectItem(Query subquery, String alias)` | Create a scalar SELECT item |
263263
| `getSubquery()` | The subquery to embed |
264264
| `getAlias()` | Column alias in SELECT clause |
@@ -283,7 +283,7 @@ public interface QueryableStorage {
283283
### `SqlDialect`
284284

285285
| Member | Description |
286-
|--------|-------------|
286+
| -------- | ------------- |
287287
| `STANDARD` | ANSI SQL (no identifier quoting) |
288288
| `MYSQL` | MySQL: back-tick quoting; DELETE LIMIT supported |
289289
| `SQLITE` | SQLite: double-quote quoting; DELETE LIMIT supported |
@@ -295,7 +295,7 @@ public interface QueryableStorage {
295295
### `SqlResult`
296296

297297
| Method | Returns | Description |
298-
|--------|---------|-------------|
298+
| -------- | --------- | ------------- |
299299
| `getSql()` | `String` | Rendered SQL with `?` placeholders |
300300
| `getParameters()` | `List<Object>` | Bind parameters in placeholder order |
301301

@@ -311,7 +311,7 @@ usage guide.
311311
**Static methods**
312312

313313
| Method | Returns | Description |
314-
|--------|---------|-------------|
314+
| -------- | --------- | ------------- |
315315
| `global()` | `QueryBuilderDefaults` | Current JVM-wide defaults instance |
316316
| `setGlobal(defaults)` | `void` | Replace the JVM-wide defaults; throws `NullPointerException` if `null` |
317317
| `builder()` | `Builder` | New builder pre-filled with canonical defaults |
@@ -320,7 +320,7 @@ usage guide.
320320
**Instance getters**
321321

322322
| Method | Returns | Description |
323-
|--------|---------|-------------|
323+
| -------- | --------- | ------------- |
324324
| `getDialect()` | `SqlDialect` | Configured SQL dialect |
325325
| `getDefaultColumns()` | `String` | Default SELECT column expression |
326326
| `getDefaultLimit()` | `int` | Default LIMIT; `-1` means none |
@@ -333,7 +333,7 @@ usage guide.
333333
### `QueryBuilderDefaults.Builder`
334334

335335
| Method | Returns | Description |
336-
|--------|---------|-------------|
336+
| -------- | --------- | ------------- |
337337
| `dialect(SqlDialect)` | `Builder` | Set dialect; throws `NullPointerException` if `null` |
338338
| `defaultColumns(String)` | `Builder` | Set default SELECT columns; throws `NullPointerException` if `null` |
339339
| `defaultLimit(int)` | `Builder` | Set default LIMIT; pass `-1` to disable |
@@ -349,7 +349,7 @@ usage guide.
349349
### `QueryBuilderException`
350350

351351
| Constructor | Description |
352-
|-------------|-------------|
352+
| ------------- | ------------- |
353353
| `QueryBuilderException()` | No-message default |
354354
| `QueryBuilderException(String message)` | Simple message |
355355
| `QueryBuilderException(String message, Throwable cause)` | Wraps another exception |
@@ -360,7 +360,7 @@ usage guide.
360360
### `QueryException`
361361

362362
| Constructor | Description |
363-
|-------------|-------------|
363+
| ------------- | ------------- |
364364
| `QueryException()` | No-message default |
365365
| `QueryException(String message)` | Simple message |
366366
| `QueryException(String message, Throwable cause)` | Wraps another exception |
@@ -371,7 +371,7 @@ usage guide.
371371
### `QueryRenderException`
372372

373373
| Constructor | Description |
374-
|-------------|-------------|
374+
| ------------- | ------------- |
375375
| `QueryRenderException()` | No-message default |
376376
| `QueryRenderException(String message)` | Simple message |
377377
| `QueryRenderException(String message, Throwable cause)` | Wraps another exception |

docs/conditions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ conditions use `AND` by default; call the `orWhere*` variant to use `OR`.
3333
`Operator` is the single source of truth for all supported comparison operators.
3434

3535
| Constant | SQL rendering | Notes |
36-
|----------|---------------|-------|
36+
| ---------- | --------------- | ------- |
3737
| `EQ` | `col = ?` | Equality |
3838
| `NEQ` | `col != ?` | Not equal |
3939
| `GT` | `col > ?` | Greater than |
@@ -61,7 +61,7 @@ The table below maps every `QueryBuilder` `where*` method to its `Operator`
6161
constant and the SQL it generates.
6262

6363
| Builder method | Operator | Generated SQL fragment |
64-
|----------------|----------|------------------------|
64+
| ---------------- | ---------- | ------------------------ |
6565
| `whereEquals(col, val)` | `EQ` | `col = ?` |
6666
| `orWhereEquals(col, val)` | `EQ` | `OR col = ?` |
6767
| `whereNotEquals(col, val)` | `NEQ` | `col != ?` |
@@ -131,7 +131,7 @@ new QueryBuilder()
131131
`Condition` pairs an `Operator` with its comparison value.
132132

133133
| Member | Type | Description |
134-
|--------|------|-------------|
134+
| -------- | ------ | ------------- |
135135
| `Condition(Operator op, Object value)` | constructor | Create a condition; `value` may be `null` for `IS_NULL`, `IS_NOT_NULL`, `EXISTS` |
136136
| `getOperator()` | `Operator` | The operator for this condition |
137137
| `getValue()` | `Object` | The comparison value (`null`, scalar, `List<?>`, or `Query`) |
@@ -147,7 +147,7 @@ without a database.
147147
`ConditionEntry` wraps a `Condition` with its column name and `Connector`.
148148

149149
| Member | Type | Description |
150-
|--------|------|-------------|
150+
| -------- | ------ | ------------- |
151151
| `ConditionEntry(String column, Condition condition, Connector connector)` | constructor | Create a condition entry |
152152
| `getColumn()` | `String` | The column name (`null` for `EXISTS_SUBQUERY` / `NOT_EXISTS_SUBQUERY`) |
153153
| `getCondition()` | `Condition` | The wrapped condition |
@@ -158,6 +158,6 @@ without a database.
158158
## Connector enum
159159

160160
| Constant | SQL keyword |
161-
|----------|-------------|
161+
| ---------- | ------------- |
162162
| `AND` | `AND` |
163163
| `OR` | `OR` |

docs/configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ defaults for a single builder instance using `.withDefaults()`.
2828
**Configurable settings:**
2929

3030
| Setting | Default | Description |
31-
|---------|---------|-------------|
31+
| --------- | --------- | ------------- |
3232
| `dialect` | `SqlDialect.STANDARD` | SQL dialect used for identifier quoting |
3333
| `defaultColumns` | `"*"` | Column expression used in `SELECT` when none are specified |
3434
| `defaultLimit` | `-1` (no limit) | `LIMIT` applied when the builder has no `.limit()` call |
@@ -165,7 +165,7 @@ QueryBuilderDefaults.setGlobal(QueryBuilderDefaults.builder().build());
165165
### `QueryBuilderDefaults` (static methods)
166166

167167
| Method | Returns | Description |
168-
|--------|---------|-------------|
168+
| -------- | --------- | ------------- |
169169
| `global()` | `QueryBuilderDefaults` | The current JVM-wide defaults instance |
170170
| `setGlobal(defaults)` | `void` | Replace the JVM-wide defaults; throws `NullPointerException` if `null` |
171171
| `builder()` | `Builder` | New builder pre-filled with canonical defaults |
@@ -174,7 +174,7 @@ QueryBuilderDefaults.setGlobal(QueryBuilderDefaults.builder().build());
174174
### `QueryBuilderDefaults` (instance getters)
175175

176176
| Method | Returns | Description |
177-
|--------|---------|-------------|
177+
| -------- | --------- | ------------- |
178178
| `getDialect()` | `SqlDialect` | The configured SQL dialect |
179179
| `getDefaultColumns()` | `String` | Default SELECT column expression |
180180
| `getDefaultLimit()` | `int` | Default LIMIT value; `-1` means none |
@@ -185,7 +185,7 @@ QueryBuilderDefaults.setGlobal(QueryBuilderDefaults.builder().build());
185185
### `QueryBuilderDefaults.Builder`
186186

187187
| Method | Returns | Description |
188-
|--------|---------|-------------|
188+
| -------- | --------- | ------------- |
189189
| `dialect(SqlDialect)` | `Builder` | Set dialect; throws `NullPointerException` if `null` |
190190
| `defaultColumns(String)` | `Builder` | Set default SELECT columns; throws `NullPointerException` if `null` |
191191
| `defaultLimit(int)` | `Builder` | Set default LIMIT; pass `-1` to disable |
@@ -199,7 +199,7 @@ QueryBuilderDefaults.setGlobal(QueryBuilderDefaults.builder().build());
199199
All three builders throw `NullPointerException` if `null` is passed.
200200

201201
| Builder | Method signature |
202-
|---------|-----------------|
202+
| --------- | ----------------- |
203203
| `QueryBuilder` | `withDefaults(QueryBuilderDefaults defaults)` |
204204
| `SelectBuilder` | `withDefaults(QueryBuilderDefaults defaults)` |
205205
| `DeleteBuilder` | `withDefaults(QueryBuilderDefaults defaults)` |

docs/dialects/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ parameterized `SqlResult`. Four built-in dialects are provided as constants
2424
on the interface:
2525

2626
| Constant | Page | Identifier quoting | DELETE LIMIT | ILIKE | RETURNING |
27-
|----------|------|--------------------|--------------|-------|-----------|
27+
| ---------- | ------ | -------------------- | -------------- | ------- | ----------- |
2828
| `SqlDialect.STANDARD` | [STANDARD]({{ site.baseurl }}/sql-dialects/standard/) | None (ANSI) | No | No | No |
2929
| `SqlDialect.MYSQL` | [MySQL]({{ site.baseurl }}/sql-dialects/mysql/) | Back-tick `` ` `` | Yes | No | No |
3030
| `SqlDialect.SQLITE` | [SQLite]({{ site.baseurl }}/sql-dialects/sqlite/) | Double-quote `"` | Yes | No | No |
@@ -38,7 +38,7 @@ The same `Query` produces different SQL across dialects due to identifier
3838
quoting:
3939

4040
| Feature | STANDARD | MYSQL | SQLITE | POSTGRESQL |
41-
|---------|----------|-------|--------|------------|
41+
| --------- | ---------- | ------- | -------- | ------------ |
4242
| Table quoting | `users` | `` `users` `` | `"users"` | `"users"` |
4343
| Column quoting | `id` | `` `id` `` | `"id"` | `"id"` |
4444
| DELETE LIMIT | No | Yes | Yes | No |
@@ -54,7 +54,7 @@ quoting:
5454
rendered SQL string and the ordered bind-parameter list.
5555

5656
| Method | Returns | Description |
57-
|--------|---------|-------------|
57+
| -------- | --------- | ------------- |
5858
| `getSql()` | `String` | The rendered SQL with `?` placeholders |
5959
| `getParameters()` | `List<Object>` | Bind parameters in the order they appear in the SQL |
6060

@@ -97,7 +97,7 @@ and `appendConditionFragment`.
9797
## SqlDialect interface
9898

9999
| Member | Description |
100-
|--------|-------------|
100+
| -------- | ------------- |
101101
| `SqlDialect.STANDARD` | ANSI SQL constant instance |
102102
| `SqlDialect.MYSQL` | MySQL dialect constant instance |
103103
| `SqlDialect.SQLITE` | SQLite dialect constant instance |

docs/dialects/mysql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ description: "MySQL dialect — back-tick identifier quoting and DELETE LIMIT su
2424
Quoting is applied to SELECT and DELETE queries rendered through this dialect.
2525

2626
| Feature | Value |
27-
|---------|-------|
27+
| --------- | ------- |
2828
| Identifier quoting | Back-tick `` ` `` |
2929
| DELETE LIMIT | Supported |
3030
| ILIKE | Not supported |

docs/dialects/postgresql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ and adds two PostgreSQL-specific features: case-insensitive `ILIKE` / `NOT ILIKE
2424
operators on SELECT queries, and a `RETURNING` clause on `DELETE` statements.
2525

2626
| Feature | Value |
27-
|---------|-------|
27+
| --------- | ------- |
2828
| Identifier quoting | Double-quote `"` |
2929
| DELETE LIMIT | Not supported |
3030
| ILIKE / NOT ILIKE | Supported |

docs/dialects/sqlite.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ description: "SQLite dialect — double-quote identifier quoting and DELETE LIMI
2424
supports the `LIMIT` clause on `DELETE` statements.
2525

2626
| Feature | Value |
27-
|---------|-------|
27+
| --------- | ------- |
2828
| Identifier quoting | Double-quote `"` |
2929
| DELETE LIMIT | Supported |
3030
| ILIKE | Not supported |

docs/dialects/standard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ It is the default dialect used by `buildSql()` and `build()` when no dialect
2424
is specified.
2525

2626
| Feature | Value |
27-
|---------|-------|
27+
| --------- | ------- |
2828
| Identifier quoting | None |
2929
| DELETE LIMIT | Not supported |
3030
| ILIKE | Not supported |

docs/exceptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ try {
4747
**Constructors:**
4848

4949
| Constructor | Use case |
50-
|-------------|----------|
50+
| ------------- | ---------- |
5151
| `QueryBuilderException()` | No-message default |
5252
| `QueryBuilderException(String message)` | Simple message |
5353
| `QueryBuilderException(String message, Throwable cause)` | Wraps another exception |
@@ -72,7 +72,7 @@ try {
7272
**Constructors:**
7373

7474
| Constructor | Use case |
75-
|-------------|----------|
75+
| ------------- | ---------- |
7676
| `QueryException()` | No-message default |
7777
| `QueryException(String message)` | Simple message |
7878
| `QueryException(String message, Throwable cause)` | Wraps another exception |
@@ -96,7 +96,7 @@ try {
9696
**Constructors:**
9797

9898
| Constructor | Use case |
99-
|-------------|----------|
99+
| ------------- | ---------- |
100100
| `QueryRenderException()` | No-message default |
101101
| `QueryRenderException(String message)` | Simple message |
102102
| `QueryRenderException(String message, Throwable cause)` | Wraps another exception |

docs/in-memory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ List<String> ids = store.query(q);
149149
`Condition.matches` evaluates the following operators against an attribute map:
150150

151151
| Operator | In-memory behaviour |
152-
|----------|---------------------|
152+
| ---------- | --------------------- |
153153
| `EQ` | `Objects.equals(stored, value)` |
154154
| `NEQ` | `!Objects.equals(stored, value)` |
155155
| `GT` / `GTE` / `LT` / `LTE` | Numeric comparison; coerces `Long`/`Integer`/`Double` as needed |

0 commit comments

Comments
 (0)