rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-06 03:42:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(python): document phrase queries in fts (#788)

Browse Source 
closes #769 

Add unit test and documentation on using quotes to perform a phrase
query
This commit is contained in:
Chang She
2024-01-08 21:49:31 -08:00
committed by GitHub
parent ac40d4b235
commit 121687231c
2 changed files with 33 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/src/fts.md
View File

@@ -75,6 +75,22 @@ applied on top of the full text search results. This can be invoked via the fami
table.search("puppy").limit(10).where("meta='foo'").to_list()
```
## Syntax
For full-text search you can perform either a phrase query like "the old man and the sea",
or a structured search query like "(Old AND Man) AND Sea".
Double quotes are used to disambiguate.
For example:
If you intended "they could have been dogs OR cats" as a phrase query, this actually
raises a syntax error since `OR` is a recognized operator. If you make `or` lower case,
this avoids the syntax error. However, it is cumbersome to have to remember what will
conflict with the query syntax. Instead, if you search using
`table.search('"they could have been dogs OR cats"')`, then the syntax checker avoids
checking inside the quotes.
## Configurations
By default, LanceDB configures a 1GB heap size limit for creating the index. You can