@isdk/kvsqlite/docs/classes/KVSqliteCollection.md

SQlite(>=3.45.0) key/value Document store

[**@isdk/kvsqlite**](../README.md)

***

[@isdk/kvsqlite](../globals.md) / KVSqliteCollection

# Class: KVSqliteCollection

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1052](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1052)

## Constructors

### new KVSqliteCollection()

> **new KVSqliteCollection**(`name`, `db`, `options`): [`KVSqliteCollection`](KVSqliteCollection.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1160](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1160)

Constructs a new instance of KVSqliteCollection.

This constructor initializes a new collection in the database with the specified name and options.
It handles the creation of the table if it does not already exist, sets up fields, and prepares SQL statements for various operations.

#### Parameters

##### name

`string`

The name of the collection.

##### db

[`KVSqlite`](KVSqlite.md)

The KVSqlite database instance.

##### options

[`IKVCreateOptions`](../interfaces/IKVCreateOptions.md) = `{}`

Optional settings for the collection, including fields, FTS configuration, and JSONB usage.

#### Returns

[`KVSqliteCollection`](KVSqliteCollection.md)

## Properties

### db

> `protected` **db**: [`KVSqlite`](KVSqlite.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1160](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1160)

The KVSqlite database instance.

***

### jsonb

> **jsonb**: `string`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1065](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1065)

***

### name

> **name**: `string`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1160](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1160)

The name of the collection.

***

### preAdd

> **preAdd**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1053](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1053)

***

### preAll

> **preAll**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1063](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1063)

***

### preAllLimit

> **preAllLimit**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1064](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1064)

***

### preCount

> **preCount**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1059](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1059)

***

### preCountW

> **preCountW**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1060](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1060)

***

### preDel

> **preDel**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1057](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1057)

***

### preDelAll

> **preDelAll**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1058](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1058)

***

### preExists

> **preExists**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1055](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1055)

***

### preGet

> **preGet**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1056](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1056)

***

### preSearchKey

> **preSearchKey**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1061](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1061)

***

### preSearchKeyAll

> **preSearchKeyAll**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1062](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1062)

***

### preUpdate

> **preUpdate**: `Statement`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1054](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1054)

## Methods

### \_set()

> **\_set**(`obj`, `options`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1215](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1215)

#### Parameters

##### obj

[`IKVObjItem`](../interfaces/IKVObjItem.md)

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

***

### \_setExtend()

> **\_setExtend**(`docId`, `key`, `value`, `options`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1287](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1287)

#### Parameters

##### docId

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

##### key

`string`

##### value

`any`

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

***

### buildWhereClause()

> **buildWhereClause**(`filter`, `options`?): `string`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1823](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1823)

Builds a SQL WHERE clause from the provided filter conditions.

This function converts a record of filter conditions into a SQL WHERE clause string.

#### Parameters

##### filter

`Record`\<`string`, `any`\>

A record of key-value pairs representing the filter conditions.

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings including field information mappings.

#### Returns

`string`

A string representing the SQL WHERE clause.

***

### bulkDocs()

> **bulkDocs**(`objs`, `options`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1340](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1340)

Inserts or updates multiple documents in a transaction.

This function performs a bulk operation to insert or update multiple documents in the table.
It executes the operations within a transaction to ensure atomicity.

#### Parameters

##### objs

[`IKVObjItem`](../interfaces/IKVObjItem.md)[]

An array of objects representing the documents to insert or update.

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings for the operation.

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

An array of results from the insert or update operations.

***

### count()

> **count**(`query`?): `number`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1529](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1529)

Counts the number of records in the collection based on the provided query.

This function returns the count of records that match the specified query.
If the query is an object, it constructs a SQL WHERE clause from the query object.

#### Parameters

##### query?

An optional string or object representing the query conditions.

`string` | `Record`\<`string`, `any`\>

#### Returns

`number`

The number of records matching the query.

***

### createIndex()

> **createIndex**(`index`, `options`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1669](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1669)

#### Parameters

##### index

[`IKVIndexOptions`](../interfaces/IKVIndexOptions.md)

##### options?

[`IKVCreateOptions`](../interfaces/IKVCreateOptions.md)

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

***

### createIndexAndTriggerForAutoTimestamp()

> **createIndexAndTriggerForAutoTimestamp**(`fields`): `void`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1067](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1067)

#### Parameters

##### fields

#### Returns

`void`

***

### createIndexes()

> **createIndexes**(`options`): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1694](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1694)

#### Parameters

##### options

[`IKVCreateOptions`](../interfaces/IKVCreateOptions.md)

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

***

### createJsonIndex()

> **createJsonIndex**(`indexName`, `fields`): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1648](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1648)

#### Parameters

##### indexName

`string`

##### fields

`string` | `string`[]

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

***

### createSchema()

> **createSchema**(`options`): `void`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1601](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1601)

#### Parameters

##### options

[`IKVCreateOptions`](../interfaces/IKVCreateOptions.md)

#### Returns

`void`

***

### createTable()

> **createTable**(`name`, `options`): `void`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1619](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1619)

#### Parameters

##### name

`string`

##### options

[`IKVCreateOptions`](../interfaces/IKVCreateOptions.md)

#### Returns

`void`

***

### createTableIndex()

> **createTableIndex**(`indexName`, `fields`): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1655](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1655)

#### Parameters

##### indexName

`string`

##### fields

`string` | `string`[]

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

***

### createTrigger()

> **createTrigger**(`trigger`, `options`?): `RunResult`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1705](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1705)

#### Parameters

##### trigger

[`IKVTriggerOptions`](../interfaces/IKVTriggerOptions.md)

##### options?

[`IKVCreateOptions`](../interfaces/IKVCreateOptions.md)

#### Returns

`RunResult`

***

### del()

> **del**(`_id`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md) \| [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1495](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1495)

Deletes records from the collection based on the provided ID, array of IDs, or filter conditions.

This function deletes records from the collection using the provided ID, array of IDs, or filter conditions.
It supports deleting multiple records within a transaction if an array of IDs is provided.
If a filter object is provided, it constructs a SQL WHERE clause from the filter and deletes matching records.
If no ID or filter is provided, it deletes all records in the collection.

#### Parameters

##### \_id?

An optional ID, array of IDs, or filter object representing the records to delete.

`Record`\<`string`, `any`\> | [`IKVDocumentId`](../type-aliases/IKVDocumentId.md) | [`IKVDocumentId`](../type-aliases/IKVDocumentId.md)[]

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md) \| [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

The result of the delete operation(s).

***

### delExtend()

> **delExtend**(`docId`, `aPropName`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md) \| [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1438](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1438)

Deletes an extended property for a document based on the specified property name.

This function deletes a specific property for a document using the provided document ID and property name.
If no property name is provided, it deletes the entire document.

#### Parameters

##### docId

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

The ID of the document.

##### aPropName?

`string`

An optional string representing the property name to delete.

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md) \| [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

The result of the delete operation.

***

### drop()

> **drop**(): `void`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:2127](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L2127)

Drops the current table from the database.

This function removes the table associated with the current instance from the database.

#### Returns

`void`

***

### enableFts()

> **enableFts**(`options`): `void`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1847](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1847)

#### Parameters

##### options

[`IKVCreateFtsOptions`](../interfaces/IKVCreateFtsOptions.md) = `{}`

#### Returns

`void`

***

### get()

> **get**(`_id`): [`IKVObjItem`](../interfaces/IKVObjItem.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1355](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1355)

Retrieves a document by its ID and ensures it includes the document ID.

This function fetches a document from the table using the provided document ID.
It ensures that the returned object includes the document ID as a property.

#### Parameters

##### \_id

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

The ID of the document to retrieve.

#### Returns

[`IKVObjItem`](../interfaces/IKVObjItem.md)

The retrieved document as an object with the document ID included.

***

### getEx()

> **getEx**(`_id`): `string` \| `number` \| `boolean` \| [`IKVObjItem`](../interfaces/IKVObjItem.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1374](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1374)

Retrieves a document by its ID and processes the result.

This function fetches a document from the table using the provided document ID.
It processes the result by parsing SQL fields, handling JSON values, and mapping fields as necessary.

#### Parameters

##### \_id

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

The ID of the document to retrieve.

#### Returns

`string` \| `number` \| `boolean` \| [`IKVObjItem`](../interfaces/IKVObjItem.md)

The retrieved document as an object, string, boolean, or number.

***

### getExtend()

> **getExtend**(`docId`, `aPropName`?): `any`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1403](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1403)

Retrieves the value of an extended property for a document based on the specified property name.

This function fetches the value of a specific property for a document using the provided document ID and property name.
If no property name is provided, it retrieves the entire document.

#### Parameters

##### docId

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

The ID of the document.

##### aPropName?

`string`

An optional string representing the property name to retrieve.

#### Returns

`any`

The value of the specified property or the entire document if no property name is provided.

***

### getExtends()

> **getExtends**(`docId`, `aPropName`?, `options`?): [`IKVObjItem`](../interfaces/IKVObjItem.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1457](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1457)

Retrieves extended properties for a document based on the specified property names or patterns.

This function fetches properties for a document using the provided document ID and property names or patterns.
It supports retrieving single or multiple properties and can return either a single value or an object containing all properties.

#### Parameters

##### docId

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

The ID of the document.

##### aPropName?

An optional string or array of strings representing the property names or patterns.

`string` | `string`[]

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings including whether to return a single value.

#### Returns

[`IKVObjItem`](../interfaces/IKVObjItem.md)

The retrieved extends properties as an object or a single value if `singleValue` is true.

***

### getSchema()

> **getSchema**(): `any`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1595](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1595)

#### Returns

`any`

***

### isExists()

> **isExists**(`_id`): `boolean`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1516](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1516)

Checks if a record with the specified ID exists in the table.

This function returns a boolean indicating whether a record with the given ID exists.

#### Parameters

##### \_id

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

The ID of the record to check.

#### Returns

`boolean`

A boolean indicating whether the record exists.

***

### isExistsExtend()

> **isExistsExtend**(`docId`, `aPropName`?): `boolean`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1421](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1421)

Checks if an extended property exists for a document based on the specified property name.

This function checks if a specific property exists for a document using the provided document ID and property name.
If no property name is provided, it checks for the existence of the entire document.

#### Parameters

##### docId

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

The ID of the document.

##### aPropName?

`string`

An optional string representing the property name to check.

#### Returns

`boolean`

A boolean indicating whether the property exists.

***

### list()

> **list**(`query`?, `options`?): [`IKVObjItem`](../interfaces/IKVObjItem.md)[]

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1553](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1553)

Lists records from the table based on the provided query and options.

This function retrieves records from the table, applying optional filters, sorting, pagination,
and field selection. It supports both string queries and object-based query options.

#### Parameters

##### query?

A string or object representing the query conditions.

`string` | [`IKVSetOptions`](../interfaces/IKVSetOptions.md)

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings including size, page, sort order, and field names.

#### Returns

[`IKVObjItem`](../interfaces/IKVObjItem.md)[]

An array of objects representing the listed records.

***

### renameField()

> **renameField**(`oldName`, `newName`, `options`?): `undefined` \| `RunResult`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1718](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1718)

#### Parameters

##### oldName

`string`

##### newName

`string` | [`IKVFieldOption`](../interfaces/IKVFieldOption.md)

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

#### Returns

`undefined` \| `RunResult`

***

### search()

> **search**(`filter`, `options`?): [`IKVObjItem`](../interfaces/IKVObjItem.md)[]

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1808](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1808)

Searches for records based on the provided filter conditions.

This function constructs a SQL WHERE clause using the provided filter and options,
and then performs the search using the constructed WHERE clause.

#### Parameters

##### filter

`Record`\<`string`, `any`\>

A record of key-value pairs representing the filter conditions.

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings including field information mappings.

#### Returns

[`IKVObjItem`](../interfaces/IKVObjItem.md)[]

The result of the search operation.

***

### searchEx()

> **searchEx**(`query`, `options`?): [`IKVObjItem`](../interfaces/IKVObjItem.md)[]

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1749](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1749)

Executes an advanced search query on the database.

This function constructs and executes a SQL query based on the provided query string or object,
options for sorting, pagination, and field selection.

#### Parameters

##### query

A string or record of key-value pairs representing the search query.

`string` | `Record`\<`string`, `string`\>

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings including field information mappings, sorting, pagination, and field names.

#### Returns

[`IKVObjItem`](../interfaces/IKVObjItem.md)[]

An array of objects representing the search results.

***

### searchFts()

> **searchFts**(`query`, `options`?): `object`[]

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1987](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1987)

Searches the full-text search (FTS) index for records matching the provided query.

This function constructs and executes a SQL query to search the FTS index of the specified collection.
It supports different query styles and options for field selection and deserialization.
Additionally, it allows filtering with regular SQL conditions via the `options.query` parameter.

#### Parameters

##### query

A string, object, or array of objects representing the search query.

`string` | `Record`\<`string`, `any`\> | `Record`\<`string`, `any`\>[]

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md) & [`IKVCreateFtsOptions`](../interfaces/IKVCreateFtsOptions.md) & `object`

Optional settings including collection name, field names, FTS query style, and deserialization options.

#### Returns

`object`[]

An array of objects representing the search results.

### Query Style Options

The ftsQueryStyle option determines how the FTS query is interpreted:

- **`false` or `undefined`**: Simple mode. The query string is wrapped in single quotes.
- **`true`**: Advanced mode. The query string is used as-is without any wrapping.
- **`string`**: Wraps the query content with the specified SQLite function, e.g., `'simple_query'`.

#### Example

```ts
searchFts("hello", { ftsQueryStyle: false });
`Gnerate SQL Condition: MATCH 'hello'`

searchFts("'apple OR banana'", { ftsQueryStyle: true });
`Gnerate SQL Condition: MATCH 'apple OR banana'`

searchFts({ $or: ["apple", "banana"] }, { ftsQueryStyle: false });
`Gnerate SQL Condition: MATCH 'apple OR banana'`

searchFts("senior | backend", { ftsQueryStyle: "replace(?, '|', 'OR')" });
`Gnerate SQL Condition: MATCH replace('senior | backend', '|', 'OR')`

// Using `options.query` with an object to generate WHERE clause
searchFts("developer", {
  query: {_id: {$like: 'fts2_%'}},
});
`Generated SQL Condition: MATCH 'developer' AND _id like 'fts2_%'`
```

***

### set()

> **set**(`docId`, `obj`?, `options`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1274](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1274)

Sets or updates a document in the table.

This function inserts or updates a document in the table using the provided document ID and object.
It supports different parameter configurations and executes the operation within a transaction to ensure atomicity.

#### Parameters

##### docId

The ID of the document or an object representing the document.

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md) | [`IKVObjItem`](../interfaces/IKVObjItem.md)

##### obj?

An optional object representing the document or options.

[`IKVSetOptions`](../interfaces/IKVSetOptions.md) | [`IKVObjItem`](../interfaces/IKVObjItem.md)

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings for the operation.

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

The result of the set operation.

***

### setExtend()

> **setExtend**(`docId`, `key`, `value`, `options`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1307](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1307)

Sets an extended property for a document in a transaction.

This function updates or inserts a specific property for a document using the provided document ID, key, and value.
It executes the operation within a transaction to ensure atomicity.

#### Parameters

##### docId

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

The ID of the document.

##### key

`string`

The key of the property to set.

##### value

`any`

The value of the property to set.

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings for the operation.

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)

The result of the set operation.

***

### setExtends()

> **setExtends**(`docId`, `aDoc`, `options`?): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1324](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1324)

Sets multiple extended properties for a document in a transaction.

This function updates or inserts multiple properties for a document using the provided document ID and an object of properties.
It executes the operations within a transaction to ensure atomicity.

#### Parameters

##### docId

[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)

The ID of the document.

##### aDoc

`any`

An object containing the properties to set.

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings for the operation.

#### Returns

[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]

An array of results from the set operations.

***

### tableInfo()

> **tableInfo**(`options`?): `undefined` \| `Required`\<[`IKVFieldOptions`](../interfaces/IKVFieldOptions.md)\>

Defined in: [packages/kvsqlite/src/kvsqlite.ts:1842](https://github.com/isdk/kvsqlite.js/blob/dc8f2509cbc300aaaddf8d9b77198aa59a096ba8/src/kvsqlite.ts#L1842)

Retrieves information about the table structure.

This function queries the database to get detailed information about the specified table,
including field names, types, constraints, and default values.

#### Parameters

##### options?

[`IKVSetOptions`](../interfaces/IKVSetOptions.md)

Optional settings including the collection name and whether to map field names.

#### Returns

`undefined` \| `Required`\<[`IKVFieldOptions`](../interfaces/IKVFieldOptions.md)\>

An object containing detailed information about the table fields.