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

SQlite(>=3.45.0) key/value Document store

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

***

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

# Interface: IKVFieldOption

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

## Properties

### constraint?

> `optional` **constraint**: `string`

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

***

### default?

> `optional` **default**: `any`

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

***

### foreignKey?

> `optional` **foreignKey**: `object`

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

#### isJson?

> `optional` **isJson**: `boolean`

#### onDelete?

> `optional` **onDelete**: `"CASCADE"` \| `"SET NULL"` \| `"SET DEFAULT"` \| `"NO ACTION"`

#### onUpdate?

> `optional` **onUpdate**: `"CASCADE"` \| `"SET NULL"` \| `"SET DEFAULT"` \| `"NO ACTION"`

#### reference

> **reference**: `string`

#### referenceField?

> `optional` **referenceField**: `string`

***

### index?

> `optional` **index**: `object`

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

#### name

> **name**: `string`

#### partial?

> `optional` **partial**: `boolean`

#### unique?

> `optional` **unique**: `boolean`

***

### name?

> `optional` **name**: `string`

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

***

### notNull?

> `optional` **notNull**: `boolean`

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

***

### primary?

> `optional` **primary**: `boolean`

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

***

### type?

> `optional` **type**: `string`

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

***

### unique?

> `optional` **unique**: `boolean`

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