@livestore/livestore 0.4.0-dev.18 → 0.4.0-dev.19

package/docs/api/livestore/classes/SqliteDbWrapper/index.md

@@ -0,0 +1,538 @@
+# SqliteDbWrapper
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:33](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L33)
+
+This class is mostly adding result caching around a SqliteDb which is used to speed up
+SQLite queries when used through the reactivity graph.
+
+## Implements
+
+- [`SqliteDb`](/api/livestore/interfaces/sqlitedb/)
+
+## Constructors
+
+### Constructor
+
+> **new SqliteDbWrapper**(`__namedParameters`): `SqliteDbWrapper`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:45](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L45)
+
+#### Parameters
+
+##### \_\_namedParameters
+
+###### db
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/)
+
+###### otel
+
+\{ `rootSpanContext`: `Context`; `tracer`: `Tracer`; \}
+
+###### otel.rootSpanContext
+
+`Context`
+
+###### otel.tracer
+
+`Tracer`
+
+#### Returns
+
+`SqliteDbWrapper`
+
+## Properties
+
+### \_tag
+
+> **\_tag**: `"SqliteDb"`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:34](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L34)
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`_tag`](/api/livestore/interfaces/sqlitedb/#_tag)
+
+***
+
+### debugInfo
+
+> **debugInfo**: `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:43](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L43)
+
+#### events
+
+> **events**: `BoundArray`\<readonly \[`string`, `any`\]\>
+
+#### queryFrameCount
+
+> **queryFrameCount**: `number`
+
+#### queryFrameDuration
+
+> **queryFrameDuration**: `number`
+
+#### slowQueries
+
+> **slowQueries**: `BoundArray`\<\{ `bindValues`: `any`; `durationMs`: `number`; `queriedTables`: `ReadonlySet`\<`string`\>; `queryStr`: `string`; `rowsCount`: `undefined` \| `number`; `startTimePerfNow`: `number`; \}\>
+
+***
+
+### execute()
+
+> **execute**: \{(`queryStr`, `bindValues?`, `options?`): `void`; (`queryBuilder`, `options?`): `void`; \}
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:227](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L227)
+
+#### Call Signature
+
+> (`queryStr`, `bindValues?`, `options?`): `void`
+
+##### Parameters
+
+###### queryStr
+
+`string`
+
+###### bindValues?
+
+[`PreparedBindValues`](/api/livestore/type-aliases/preparedbindvalues/)
+
+###### options?
+
+###### onRowsChanged?
+
+(`rowsChanged`) => `void`
+
+##### Returns
+
+`void`
+
+#### Call Signature
+
+> (`queryBuilder`, `options?`): `void`
+
+##### Parameters
+
+###### queryBuilder
+
+[`Any`](/api/livestore/livestore/namespaces/querybuilder/type-aliases/any/)
+
+###### options?
+
+###### onRowsChanged?
+
+(`rowsChanged`) => `void`
+
+##### Returns
+
+`void`
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`execute`](/api/livestore/interfaces/sqlitedb/#execute)
+
+***
+
+### select()
+
+> **select**: \{\<`T`\>(`queryStr`, `bindValues?`): readonly `T`[]; \<`T`\>(`queryBuilder`): `T`; \}
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:229](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L229)
+
+#### Call Signature
+
+> \<`T`\>(`queryStr`, `bindValues?`): readonly `T`[]
+
+##### Type Parameters
+
+###### T
+
+`T`
+
+##### Parameters
+
+###### queryStr
+
+`string`
+
+###### bindValues?
+
+[`PreparedBindValues`](/api/livestore/type-aliases/preparedbindvalues/)
+
+##### Returns
+
+readonly `T`[]
+
+#### Call Signature
+
+> \<`T`\>(`queryBuilder`): `T`
+
+##### Type Parameters
+
+###### T
+
+`T`
+
+##### Parameters
+
+###### queryBuilder
+
+[`QueryBuilder`](/api/livestore/type-aliases/querybuilder/)\<`T`, `any`, `any`\>
+
+##### Returns
+
+`T`
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`select`](/api/livestore/interfaces/sqlitedb/#select)
+
+## Accessors
+
+### debug
+
+#### Get Signature
+
+> **get** **debug**(): `SqliteDebugInfo`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:67](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L67)
+
+Debug information (currently not persisted and only available at runtime)
+
+##### Returns
+
+`SqliteDebugInfo`
+
+Debug information (currently not persisted and only available at runtime)
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`debug`](/api/livestore/interfaces/sqlitedb/#debug)
+
+***
+
+### metadata
+
+#### Get Signature
+
+> **get** **metadata**(): `any`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:70](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L70)
+
+##### Returns
+
+`any`
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`metadata`](/api/livestore/interfaces/sqlitedb/#metadata)
+
+## Methods
+
+### cachedExecute()
+
+> **cachedExecute**(`queryStr`, `bindValues?`, `options?`): `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:162](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L162)
+
+#### Parameters
+
+##### queryStr
+
+`string`
+
+##### bindValues?
+
+[`PreparedBindValues`](/api/livestore/type-aliases/preparedbindvalues/)
+
+##### options?
+
+###### hasNoEffects?
+
+`boolean`
+
+###### onRowsChanged?
+
+(`rowsChanged`) => `void`
+
+###### otelContext?
+
+`Context`
+
+###### writeTables?
+
+`ReadonlySet`\<`string`\>
+
+#### Returns
+
+`object`
+
+##### durationMs
+
+> **durationMs**: `number`
+
+***
+
+### cachedSelect()
+
+> **cachedSelect**\<`T`\>(`queryStr`, `bindValues?`, `options?`): readonly `T`[]
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:231](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L231)
+
+#### Type Parameters
+
+##### T
+
+`T` = `any`
+
+#### Parameters
+
+##### queryStr
+
+`string`
+
+##### bindValues?
+
+[`PreparedBindValues`](/api/livestore/type-aliases/preparedbindvalues/)
+
+##### options?
+
+###### otelContext?
+
+`Context`
+
+###### queriedTables?
+
+`ReadonlySet`\<`string`\>
+
+###### skipCache?
+
+`boolean`
+
+#### Returns
+
+readonly `T`[]
+
+***
+
+### close()
+
+> **close**(): `void`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:79](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L79)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`close`](/api/livestore/interfaces/sqlitedb/#close)
+
+***
+
+### destroy()
+
+> **destroy**(): `void`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:82](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L82)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`destroy`](/api/livestore/interfaces/sqlitedb/#destroy)
+
+***
+
+### export()
+
+> **export**(): `Uint8Array`\<`ArrayBuffer`\>
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:302](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L302)
+
+#### Returns
+
+`Uint8Array`\<`ArrayBuffer`\>
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`export`](/api/livestore/interfaces/sqlitedb/#export)
+
+***
+
+### getTablesUsed()
+
+> **getTablesUsed**(`query`): `Set`\<`string`\>
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:134](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L134)
+
+#### Parameters
+
+##### query
+
+`string`
+
+#### Returns
+
+`Set`\<`string`\>
+
+***
+
+### import()
+
+> **import**(`data`): `void`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:76](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L76)
+
+#### Parameters
+
+##### data
+
+`Uint8Array`\<`ArrayBuffer`\> | [`SqliteDb`](/api/livestore/interfaces/sqlitedb/)\<`any`, `any`\>
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`import`](/api/livestore/interfaces/sqlitedb/#import)
+
+***
+
+### makeChangeset()
+
+> **makeChangeset**(`data`): `SqliteDbChangeset`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:88](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L88)
+
+#### Parameters
+
+##### data
+
+`Uint8Array`\<`ArrayBuffer`\>
+
+#### Returns
+
+`SqliteDbChangeset`
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`makeChangeset`](/api/livestore/interfaces/sqlitedb/#makechangeset)
+
+***
+
+### prepare()
+
+> **prepare**(`queryStr`): [`PreparedStatement`](/api/livestore/interfaces/preparedstatement/)
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:73](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L73)
+
+#### Parameters
+
+##### queryStr
+
+`string`
+
+#### Returns
+
+[`PreparedStatement`](/api/livestore/interfaces/preparedstatement/)
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`prepare`](/api/livestore/interfaces/sqlitedb/#prepare)
+
+***
+
+### rollback()
+
+> **rollback**(`changeset`): `void`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:129](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L129)
+
+#### Parameters
+
+##### changeset
+
+`Uint8Array`\<`ArrayBuffer`\>
+
+#### Returns
+
+`void`
+
+***
+
+### session()
+
+> **session**(): `SqliteDbSession`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:85](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L85)
+
+#### Returns
+
+`SqliteDbSession`
+
+#### Implementation of
+
+[`SqliteDb`](/api/livestore/interfaces/sqlitedb/).[`session`](/api/livestore/interfaces/sqlitedb/#session)
+
+***
+
+### txn()
+
+> **txn**\<`TRes`\>(`callback`): `TRes`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:92](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L92)
+
+#### Type Parameters
+
+##### TRes
+
+`TRes`
+
+#### Parameters
+
+##### callback
+
+() => `TRes`
+
+#### Returns
+
+`TRes`
+
+***
+
+### withChangeset()
+
+> **withChangeset**\<`TRes`\>(`callback`): `object`
+
+Defined in: [submodules/livestore/packages/@livestore/livestore/src/SqliteDbWrapper.ts:113](https://github.com/livestorejs/livestore/blob/e27f6dd63400fece0f2344d09d3e47f57ecc98e7/packages/@livestore/livestore/src/SqliteDbWrapper.ts#L113)
+
+#### Type Parameters
+
+##### TRes
+
+`TRes`
+
+#### Parameters
+
+##### callback
+
+() => `TRes`
+
+#### Returns
+
+`object`
+
+##### changeset
+
+> **changeset**: \{ `_tag`: `"sessionChangeset"`; `data`: `Uint8Array`\<`ArrayBuffer`\>; `debug`: `any`; \} \| \{ `_tag`: `"no-op"`; \}
+
+##### result
+
+> **result**: `TRes`