@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/kvsqlite.ts:35](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L35)

## Extends

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

## Indexable

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

## Properties

### collection?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:38](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L38)

***

### collections?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:39](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L39)

***

### deserialize()?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:32](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L32)

#### Parameters

##### val

`string`

#### Returns

`any`

#### Inherited from

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

***

### dictPath?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:47](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L47)

***

### fieldInfos?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:56](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L56)

***

### fieldNames?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:49](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L49)

***

### 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/kvsqlite.ts:46](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L46)

***

### id?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:36](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L36)

***

### ignoreExists?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:42](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L42)

***

### location?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:37](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L37)

***

### mapped?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:55](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L55)

***

### 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/kvsqlite.ts:51](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L51)

***

### overwrite?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:40](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L40)

***

### page?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:53](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L53)

***

### query?

> `optional` **query**: `string`

Defined in: [packages/kvsqlite/src/kvsqlite.ts:54](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L54)

***

### 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/kvsqlite.ts:31](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L31)

#### Parameters

##### val

`any`

#### Returns

`string`

#### Inherited from

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

***

### singleValue?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:41](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L41)

***

### size?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:52](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L52)

***

### sort?

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

Defined in: [packages/kvsqlite/src/kvsqlite.ts:50](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L50)

***

### 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/kvsqlite.ts:48](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L48)

***

### 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`