litedbmodel 2.2.2 → 2.2.4

package/docs/api/interfaces/SelectOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v1.0.1**](../README.md)
+[**litedbmodel v2.2.4**](../README.md)
 
 ***
 
@@ -6,23 +6,24 @@
 
 # Interface: SelectOptions
 
-Defined in: types.ts:108
+Defined in: [types.ts:125](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L125)
 
 ## Properties
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="order"></a> `order?` | `string` \| `OrderSpec` | Order by clause. Accepts OrderSpec (Column.asc()/desc()) or raw string. | types.ts:110 |
-| <a id="limit"></a> `limit?` | `number` | - | types.ts:111 |
-| <a id="offset"></a> `offset?` | `number` | - | types.ts:112 |
-| <a id="select"></a> `select?` | `string` | - | types.ts:113 |
-| <a id="group"></a> `group?` | `string` | - | types.ts:114 |
-| <a id="tablename"></a> `tableName?` | `string` | - | types.ts:115 |
-| <a id="append"></a> `append?` | `string` | - | types.ts:116 |
-| <a id="forupdate"></a> `forUpdate?` | `boolean` | - | types.ts:117 |
-| <a id="join"></a> `join?` | `string` | JOIN clause to add to the query. Can include parameters using ? placeholders. **Example** `join: 'JOIN unnest(?::int[]) AS _keys(id) ON t.id = _keys.id'` | types.ts:124 |
-| <a id="joinparams"></a> `joinParams?` | `unknown`[] | Parameters for the JOIN clause (prepended to condition params). | types.ts:128 |
-| <a id="cte"></a> `cte?` | \{ `name`: `string`; `sql`: `string`; `params`: `unknown`[]; \} | CTE (Common Table Expression) to prepend to the query. Used for window functions like ROW_NUMBER() or complex subqueries. The SQL should use ? placeholders for parameters. **Example** `cte: { name: 'ranked', sql: 'SELECT *, ROW_NUMBER() OVER (PARTITION BY user_id) AS _rn FROM posts WHERE user_id IN (?, ?)', params: [1, 2] }` | types.ts:140 |
-| `cte.name` | `string` | - | types.ts:141 |
-| `cte.sql` | `string` | - | types.ts:142 |
-| `cte.params` | `unknown`[] | - | types.ts:143 |
+| <a id="order"></a> `order?` | `string` \| `OrderSpec` | Order by clause. Accepts OrderSpec (Column.asc()/desc()) or raw string. | [types.ts:127](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L127) |
+| <a id="limit"></a> `limit?` | `number` | - | [types.ts:128](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L128) |
+| <a id="offset"></a> `offset?` | `number` | - | [types.ts:129](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L129) |
+| <a id="select"></a> `select?` | `string` | - | [types.ts:130](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L130) |
+| <a id="group"></a> `group?` | `string` | - | [types.ts:131](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L131) |
+| <a id="tablename"></a> `tableName?` | `string` | - | [types.ts:132](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L132) |
+| <a id="append"></a> `append?` | `string` | - | [types.ts:133](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L133) |
+| <a id="forupdate"></a> `forUpdate?` | `boolean` | Lock the selected rows EXCLUSIVELY (` FOR UPDATE`). Mutually exclusive with [forShare](#forshare). | [types.ts:135](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L135) |
+| <a id="forshare"></a> `forShare?` | `boolean` | Lock the selected rows for SHARE (` FOR SHARE`): concurrent readers may take the same shared lock, writers block until this transaction ends. The read-side twin of [forUpdate](#forupdate) (and mutually exclusive with it). PostgreSQL / MySQL only — SQLite parses no locking clause. | [types.ts:141](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L141) |
+| <a id="join"></a> `join?` | `string` | JOIN clause to add to the query. Can include parameters using ? placeholders. **Example** `join: 'JOIN unnest(?::int[]) AS _keys(id) ON t.id = _keys.id'` | [types.ts:148](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L148) |
+| <a id="joinparams"></a> `joinParams?` | `unknown`[] | Parameters for the JOIN clause (prepended to condition params). | [types.ts:152](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L152) |
+| <a id="cte"></a> `cte?` | \{ `name`: `string`; `sql`: `string`; `params`: `unknown`[]; \} | CTE (Common Table Expression) to prepend to the query. Used for window functions like ROW_NUMBER() or complex subqueries. The SQL should use ? placeholders for parameters. **Example** `cte: { name: 'ranked', sql: 'SELECT *, ROW_NUMBER() OVER (PARTITION BY user_id) AS _rn FROM posts WHERE user_id IN (?, ?)', params: [1, 2] }` | [types.ts:164](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L164) |
+| `cte.name` | `string` | - | [types.ts:165](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L165) |
+| `cte.sql` | `string` | - | [types.ts:166](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L166) |
+| `cte.params` | `unknown`[] | - | [types.ts:167](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L167) |

package/docs/api/interfaces/SqlCondition.md

@@ -1,4 +1,4 @@
-[**litedbmodel v1.0.1**](../README.md)
+[**litedbmodel v2.2.4**](../README.md)
 
 ***
 
@@ -6,7 +6,7 @@
 
 # Interface: SqlCondition\<M\>
 
-Defined in: SqlFragment.ts:48
+Defined in: [SqlFragment.ts:48](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L48)
 
 A SQL condition with embedded parameter values.
 Used for Pattern B (value-embedded) conditions and value-free conditions (IS NULL).
@@ -21,7 +21,7 @@ Used for Pattern B (value-embedded) conditions and value-free conditions (IS NUL
 
 | Property | Modifier | Type | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="_tag"></a> `_tag` | `readonly` | `"SqlCondition"` | SqlFragment.ts:49 |
-| <a id="sql"></a> `sql` | `readonly` | `string` | SqlFragment.ts:50 |
-| <a id="params"></a> `params` | `readonly` | readonly `unknown`[] | SqlFragment.ts:51 |
-| <a id="__modeltype"></a> `__modelType?` | `readonly` | `M` | SqlFragment.ts:52 |
+| <a id="_tag"></a> `_tag` | `readonly` | `"SqlCondition"` | [SqlFragment.ts:49](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L49) |
+| <a id="sql"></a> `sql` | `readonly` | `string` | [SqlFragment.ts:50](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L50) |
+| <a id="params"></a> `params` | `readonly` | readonly `unknown`[] | [SqlFragment.ts:51](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L51) |
+| <a id="__modeltype"></a> `__modelType?` | `readonly` | `M` | [SqlFragment.ts:52](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L52) |

package/docs/api/interfaces/SqlFragment.md

@@ -1,4 +1,4 @@
-[**litedbmodel v1.0.1**](../README.md)
+[**litedbmodel v2.2.4**](../README.md)
 
 ***
 
@@ -6,7 +6,7 @@
 
 # Interface: SqlFragment
 
-Defined in: SqlFragment.ts:21
+Defined in: [SqlFragment.ts:21](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L21)
 
 A general SQL fragment with parameterized values.
 Used for withQuery, QUERY, and execute.
@@ -15,6 +15,6 @@ Used for withQuery, QUERY, and execute.
 
 | Property | Modifier | Type | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="_tag"></a> `_tag` | `readonly` | `"SqlFragment"` | SqlFragment.ts:22 |
-| <a id="sql"></a> `sql` | `readonly` | `string` | SqlFragment.ts:23 |
-| <a id="params"></a> `params` | `readonly` | readonly `unknown`[] | SqlFragment.ts:24 |
+| <a id="_tag"></a> `_tag` | `readonly` | `"SqlFragment"` | [SqlFragment.ts:22](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L22) |
+| <a id="sql"></a> `sql` | `readonly` | `string` | [SqlFragment.ts:23](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L23) |
+| <a id="params"></a> `params` | `readonly` | readonly `unknown`[] | [SqlFragment.ts:24](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L24) |

package/docs/api/interfaces/SqlTypedFragment.md

@@ -1,4 +1,4 @@
-[**litedbmodel v1.0.1**](../README.md)
+[**litedbmodel v2.2.4**](../README.md)
 
 ***
 
@@ -6,7 +6,7 @@
 
 # Interface: SqlTypedFragment\<V, M\>
 
-Defined in: SqlFragment.ts:34
+Defined in: [SqlFragment.ts:34](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L34)
 
 A typed SQL fragment that preserves the Column's value type.
 Used as the first element of a condition tuple (Pattern A).
@@ -22,8 +22,8 @@ Used as the first element of a condition tuple (Pattern A).
 
 | Property | Modifier | Type | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="_tag"></a> `_tag` | `readonly` | `"SqlTypedFragment"` | SqlFragment.ts:35 |
-| <a id="sql"></a> `sql` | `readonly` | `string` | SqlFragment.ts:36 |
-| <a id="params"></a> `params` | `readonly` | readonly `unknown`[] | SqlFragment.ts:37 |
-| <a id="__valuetype"></a> `__valueType?` | `readonly` | `V` | SqlFragment.ts:38 |
-| <a id="__modeltype"></a> `__modelType?` | `readonly` | `M` | SqlFragment.ts:39 |
+| <a id="_tag"></a> `_tag` | `readonly` | `"SqlTypedFragment"` | [SqlFragment.ts:35](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L35) |
+| <a id="sql"></a> `sql` | `readonly` | `string` | [SqlFragment.ts:36](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L36) |
+| <a id="params"></a> `params` | `readonly` | readonly `unknown`[] | [SqlFragment.ts:37](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L37) |
+| <a id="__valuetype"></a> `__valueType?` | `readonly` | `V` | [SqlFragment.ts:38](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L38) |
+| <a id="__modeltype"></a> `__modelType?` | `readonly` | `M` | [SqlFragment.ts:39](https://github.com/foo-ogawa/litedbmodel/blob/main/src/SqlFragment.ts#L39) |

package/docs/api/interfaces/TransactionOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v1.0.1**](../README.md)
+[**litedbmodel v2.2.4**](../README.md)
 
 ***
 
@@ -6,14 +6,14 @@
 
 # Interface: TransactionOptions
 
-Defined in: types.ts:242
+Defined in: [types.ts:266](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L266)
 
 ## Properties
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="retryonerror"></a> `retryOnError?` | `boolean` | - | types.ts:243 |
-| <a id="retrylimit"></a> `retryLimit?` | `number` | - | types.ts:244 |
-| <a id="retryduration"></a> `retryDuration?` | `number` | - | types.ts:245 |
-| <a id="rollbackonly"></a> `rollbackOnly?` | `boolean` | If true, always rollback instead of commit (useful for preview/dry-run) | types.ts:247 |
-| <a id="usewriteraftertransaction"></a> `useWriterAfterTransaction?` | `boolean` | Override global useWriterAfterTransaction for this transaction. If true, subsequent reads will use writer connection for writerStickyDuration. **Default** `Uses global setting (true by default)` | types.ts:253 |
+| <a id="retryonerror"></a> `retryOnError?` | `boolean` | - | [types.ts:267](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L267) |
+| <a id="retrylimit"></a> `retryLimit?` | `number` | - | [types.ts:268](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L268) |
+| <a id="retryduration"></a> `retryDuration?` | `number` | - | [types.ts:269](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L269) |
+| <a id="rollbackonly"></a> `rollbackOnly?` | `boolean` | If true, always rollback instead of commit (useful for preview/dry-run) | [types.ts:271](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L271) |
+| <a id="usewriteraftertransaction"></a> `useWriterAfterTransaction?` | `boolean` | Override global useWriterAfterTransaction for this transaction. If true, subsequent reads will use writer connection for writerStickyDuration. **Default** `Uses global setting (true by default)` | [types.ts:277](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L277) |

package/docs/api/interfaces/UpdateManyOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v1.0.1**](../README.md)
+[**litedbmodel v2.2.4**](../README.md)
 
 ***
 
@@ -6,7 +6,7 @@
 
 # Interface: UpdateManyOptions
 
-Defined in: types.ts:210
+Defined in: [types.ts:234](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L234)
 
 Options for updateMany operation.
 
@@ -14,5 +14,5 @@ Options for updateMany operation.
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="keycolumns"></a> `keyColumns` | \| [`Column`](Column.md)\<`unknown`, `unknown`\> \| [`Column`](Column.md)\<`unknown`, `unknown`\>[] | Columns that identify each row (used in WHERE/JOIN clause). Must uniquely identify rows (primary key or unique constraint). | types.ts:215 |
-| <a id="returning"></a> `returning?` | `boolean` | If true, return PkeyResult with affected primary keys. If false (default), return null for better performance. | types.ts:220 |
+| <a id="keycolumns"></a> `keyColumns` | \| [`Column`](Column.md)\<`unknown`, `unknown`\> \| [`Column`](Column.md)\<`unknown`, `unknown`\>[] | Columns that identify each row (used in WHERE/JOIN clause). Must uniquely identify rows (primary key or unique constraint). | [types.ts:239](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L239) |
+| <a id="returning"></a> `returning?` | `boolean` | If true, return PkeyResult with affected primary keys. If false (default), return null for better performance. | [types.ts:244](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L244) |

package/docs/api/interfaces/UpdateOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v1.0.1**](../README.md)
+[**litedbmodel v2.2.4**](../README.md)
 
 ***
 
@@ -6,11 +6,11 @@
 
 # Interface: UpdateOptions
 
-Defined in: types.ts:189
+Defined in: [types.ts:213](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L213)
 
 ## Properties
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="tablename"></a> `tableName?` | `string` | - | types.ts:190 |
-| <a id="returning"></a> `returning?` | `boolean` | If true, return PkeyResult with affected primary keys. If false (default), return null for better performance. | types.ts:195 |
+| <a id="tablename"></a> `tableName?` | `string` | - | [types.ts:214](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L214) |
+| <a id="returning"></a> `returning?` | `boolean` | If true, return PkeyResult with affected primary keys. If false (default), return null for better performance. | [types.ts:219](https://github.com/foo-ogawa/litedbmodel/blob/main/src/types.ts#L219) |