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

SQlite(>=3.45.0) key/value Document store

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

***

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

# Interface: IKVCreateFtsOptions

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

Represents options for creating an FTS (Full-Text Search) table in SQLite with additional support for multiple languages and plugins.

## Properties

### exclude?

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

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

Lists fields to be excluded from full-text search.

***

### fields?

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

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

***

### include?

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

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

Specifies fields that should be indexed in the FTS table.

***

### language?

> `optional` **language**: `string` \| [`IKVCreateFtsLanguageOptions`](IKVCreateFtsLanguageOptions.md)

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

Configures the language for full-text search.

***

### prefix?

> `optional` **prefix**: `string`

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

Configures prefix matching behavior.

***

### skipIndexed?

> `optional` **skipIndexed**: `boolean`

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

Control Inclusion of Indexed Fields in FTS Indexing

* When skipIndexed is set to true, fields that are already indexed will be automatically excluded from the FTS (Full-Text Search) indexing process by adding them to the unindexed list.
* When set to false, this behavior is disabled, and all specified fields will be included in the FTS indexing process regardless of whether they are already indexed.

defaults to `true`

***

### unIndexed?

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

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

Specifies fields that should not be indexed in the FTS table.