@isdk/kvsqlite
Version:
SQlite(>=3.45.0) key/value Document store
114 lines (57 loc) • 2.7 kB
Markdown
[**/kvsqlite**](../README.md)
***
[/kvsqlite](../globals.md) / IKVFieldOption
# Interface: IKVFieldOption
Defined in: [packages/kvsqlite/src/kvsqlite.ts:130](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L130)
## Properties
### constraint?
> `optional` **constraint**: `string`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:137](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L137)
***
### default?
> `optional` **default**: `any`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:135](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L135)
***
### foreignKey?
> `optional` **foreignKey**: `object`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:138](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L138)
#### 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/kvsqlite.ts:145](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L145)
#### name
> **name**: `string`
#### partial?
> `optional` **partial**: `boolean`
#### unique?
> `optional` **unique**: `boolean`
***
### name?
> `optional` **name**: `string`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:131](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L131)
***
### notNull?
> `optional` **notNull**: `boolean`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:133](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L133)
***
### primary?
> `optional` **primary**: `boolean`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:134](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L134)
***
### type?
> `optional` **type**: `string`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:132](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L132)
***
### unique?
> `optional` **unique**: `boolean`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:136](https://github.com/isdk/kvsqlite.js/blob/aaa49059b7aaa3e3fd2e9d8a5de94cfb1996f957/src/kvsqlite.ts#L136)