Skip to content

Commit ab5a8b1

Browse files
authored
Update README.md
1 parent 97f5c94 commit ab5a8b1

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,9 +358,28 @@ class ViewModel {
358358
}
359359
```
360360

361+
## FTS5
362+
FTS5 is supported but has some additional requirements.
363+
To generate usable structs Otter needs type information even though they not valid FTS arguments.
364+
FTS 5 currently is the only virtual table module supported at this time.
365+
```sql
366+
CREATE VIRTUAL TABLE searchIndex USING fts5 (
367+
id INTEGER NOT NULL,
368+
text TEXT
369+
);
370+
371+
SELECT * FROM searchIndex
372+
WHERE foo MATCH 'search terms'
373+
ORDER BY rank;
374+
```
375+
376+
> [!NOTE]
377+
> All types and not `NOT NULL` constraints will be removed from the final migration.
378+
361379
## Upcoming Features
362380
* Support for multiple statements in a single query
363381
* Kotlin library/generation
382+
* Custom functions
364383

365384
## Contributions
366385
Contributions are welcome and encouraged! Feel free to make a PR or open an issue. If the change is large please open an issue first to make sure the change is desired.

0 commit comments

Comments
 (0)