@isdk/kvsqlite/docs/interfaces/IKVSetOptions.md

SQlite(>=3.45.0) key/value Document store

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

***

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

# Interface: IKVSetOptions

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

## Extends

- `Options`.[`IKVSerdeOptions`](IKVSerdeOptions.md)

## Indexable

\[`name`: `string`\]: `any`

## Properties

### collection?

> `optional` **collection**: `string`

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

***

### collections?

> `optional` **collections**: (`string` \| [`IKVCreateOptions`](IKVCreateOptions.md) \| [`IKVCreateExOptions`](IKVCreateExOptions.md))[]

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

***

### deserialize()?

> `optional` **deserialize**: (`val`) => `any`

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

#### Parameters

##### val

`string`

#### Returns

`any`

#### Inherited from

[`IKVSerdeOptions`](IKVSerdeOptions.md).[`deserialize`](IKVSerdeOptions.md#deserialize)

***

### dictPath?

> `optional` **dictPath**: `string`

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

***

### fieldInfos?

> `optional` **fieldInfos**: `Required`\<[`IKVFieldOptions`](IKVFieldOptions.md)\>

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

***

### fieldNames?

> `optional` **fieldNames**: `string`[]

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

***

### fileMustExist?

> `optional` **fileMustExist**: `boolean`

Defined in: node\_modules/.pnpm/@types+better-sqlite3@7.6.12/node\_modules/@types/better-sqlite3/index.d.ts:111

#### Inherited from

`Database.Options.fileMustExist`

***

### ftsQueryStyle?

> `optional` **ftsQueryStyle**: `string` \| `boolean`

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

***

### id?

> `optional` **id**: `string`

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

***

### ignoreExists?

> `optional` **ignoreExists**: `boolean`

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

***

### location?

> `optional` **location**: `string`

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

***

### mapped?

> `optional` **mapped**: `boolean`

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

***

### nativeBinding?

> `optional` **nativeBinding**: `string`

Defined in: node\_modules/.pnpm/@types+better-sqlite3@7.6.12/node\_modules/@types/better-sqlite3/index.d.ts:114

#### Inherited from

`Database.Options.nativeBinding`

***

### order?

> `optional` **order**: `"ASC"` \| `"DESC"`

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

***

### overwrite?

> `optional` **overwrite**: `boolean`

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

***

### page?

> `optional` **page**: `number`

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

***

### query?

> `optional` **query**: `any`

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

***

### readonly?

> `optional` **readonly**: `boolean`

Defined in: node\_modules/.pnpm/@types+better-sqlite3@7.6.12/node\_modules/@types/better-sqlite3/index.d.ts:110

#### Inherited from

`Database.Options.readonly`

***

### serialize()?

> `optional` **serialize**: (`val`) => `string`

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

#### Parameters

##### val

`any`

#### Returns

`string`

#### Inherited from

[`IKVSerdeOptions`](IKVSerdeOptions.md).[`serialize`](IKVSerdeOptions.md#serialize)

***

### singleValue?

> `optional` **singleValue**: `boolean`

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

***

### size?

> `optional` **size**: `number`

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

***

### sort?

> `optional` **sort**: `string` \| `string`[]

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

***

### timeout?

> `optional` **timeout**: `number`

Defined in: node\_modules/.pnpm/@types+better-sqlite3@7.6.12/node\_modules/@types/better-sqlite3/index.d.ts:112

#### Inherited from

`Database.Options.timeout`

***

### usingJsonb?

> `optional` **usingJsonb**: `boolean`

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

***

### verbose()?

> `optional` **verbose**: (`message`?, ...`additionalArgs`) => `void`

Defined in: node\_modules/.pnpm/@types+better-sqlite3@7.6.12/node\_modules/@types/better-sqlite3/index.d.ts:113

#### Parameters

##### message?

`unknown`

##### additionalArgs?

...`unknown`[]

#### Returns

`void`

#### Inherited from

`Database.Options.verbose`