# FtsOptions

Artifact: [androidx.room3:room3-common](https://developer.android.com/jetpack/androidx/releases/room3) [View Source](https://cs.android.com/search?q=file:androidx/room3/FtsOptions.kt+class:androidx.room3.FtsOptions) Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

*** ** * ** ***


```
public static class FtsOptions
```

<br />

*** ** * ** ***

Available option values that can be used with `https://developer.android.com/reference/androidx/room3/Fts3`, `https://developer.android.com/reference/androidx/room3/Fts4`\&`https://developer.android.com/reference/androidx/room3/Fts5`.

## Summary

| ### Nested types |
|---|
| `public enum https://developer.android.com/reference/androidx/room3/FtsOptions.Detail extends https://developer.android.com/reference/java/lang/Enum.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/room3/FtsOptions.Detail>` |
| `public enum https://developer.android.com/reference/androidx/room3/FtsOptions.MatchInfo extends https://developer.android.com/reference/java/lang/Enum.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/room3/FtsOptions.MatchInfo>` |
| `public enum https://developer.android.com/reference/androidx/room3/FtsOptions.Order extends https://developer.android.com/reference/java/lang/Enum.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/room3/FtsOptions.Order>` |

| ### Constants |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/room3/FtsOptions#TOKENIZER_ASCII()` The name of the tokenizer which assumes all characters outside the ASCII codepoint range (0-127) are to be treated as token characters. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/room3/FtsOptions#TOKENIZER_ICU()` The name of a tokenizer implemented by the ICU library. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/room3/FtsOptions#TOKENIZER_PORTER()` The name of the tokenizer based on the Porter Stemming Algorithm. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/room3/FtsOptions#TOKENIZER_SIMPLE()` The name of the default tokenizer used on FTS3 and FTS4 tables. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/room3/FtsOptions#TOKENIZER_TRIGRAM()` The name of the tokenizer that implements a trigram tokenizer that indexes every three-character sequence in the input text. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/room3/FtsOptions#TOKENIZER_UNICODE61()` The name of the tokenizer that classifies all unicode characters as either "separator" or "token" characters according to rules in Unicode Version 6.1. |

| ### Public fields |
|---|---|
| `static @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/room3/FtsOptions` | `https://developer.android.com/reference/androidx/room3/FtsOptions#INSTANCE()` |

## Constants

### TOKENIZER_ASCII

Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

```
public static final @NonNull String TOKENIZER_ASCII
```

The name of the tokenizer which assumes all characters outside the ASCII codepoint range (0-127) are to be treated as token characters.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizer()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizerArgs()` |   |

### TOKENIZER_ICU

Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

```
public static final @NonNull String TOKENIZER_ICU
```

The name of a tokenizer implemented by the ICU library.

Not available in certain Android builds (e.g. vendor).

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/room3/Fts4#tokenizer()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts4#tokenizerArgs()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizer()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizerArgs()` |   |

### TOKENIZER_PORTER

Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

```
public static final @NonNull String TOKENIZER_PORTER
```

The name of the tokenizer based on the Porter Stemming Algorithm.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/room3/Fts4#tokenizer()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts4#tokenizerArgs()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizer()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizerArgs()` |   |

### TOKENIZER_SIMPLE

Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

```
public static final @NonNull String TOKENIZER_SIMPLE
```

The name of the default tokenizer used on FTS3 and FTS4 tables.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/room3/Fts4#tokenizer()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts4#tokenizerArgs()` |   |

### TOKENIZER_TRIGRAM

Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

```
public static final @NonNull String TOKENIZER_TRIGRAM
```

The name of the tokenizer that implements a trigram tokenizer that indexes every three-character sequence in the input text.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizer()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizerArgs()` |   |

### TOKENIZER_UNICODE61

Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

```
public static final @NonNull String TOKENIZER_UNICODE61
```

The name of the tokenizer that classifies all unicode characters as either "separator" or "token" characters according to rules in Unicode Version 6.1.

| See also |
|---|---|
| `https://developer.android.com/reference/androidx/room3/Fts4#tokenizer()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts4#tokenizerArgs()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizer()` |   |
| `https://developer.android.com/reference/androidx/room3/Fts5#tokenizerArgs()` |   |

## Public fields

### INSTANCE

Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/room3#3.0.0)

```
public static @NonNull FtsOptions INSTANCE
```