rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-26 22:59:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add a section to describe scalar index (#1495)

Browse Source
This commit is contained in:
Lei Xu
2024-08-16 18:48:29 -07:00
committed by GitHub
parent 09ce6c5bb5
commit 5857cb4c6e
4 changed files with 125 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
python/python/lancedb/table.py
View File

@@ -339,9 +339,9 @@ class Table(ABC):
def create_scalar_index(
self,
column: str,
index_type: Literal["BTREE", "BITMAP", "LABEL_LIST"] = "BTREE",
*,
replace: bool = True,
index_type: Literal["BTREE", "BITMAP", "LABEL_LIST"] = "BTREE",
):
"""Create a scalar index on a column.
@@ -391,6 +391,8 @@ class Table(ABC):
or string column.
replace : bool, default True
Replace the existing index if it exists.
index_type: Literal["BTREE", "BITMAP", "LABEL_LIST"], default "BTREE"
The type of index to create.
Examples
--------
@@ -1232,9 +1234,9 @@ class LanceTable(Table):
def create_scalar_index(
self,
column: str,
index_type: Literal["BTREE", "BITMAP", "LABEL_LIST"] = "BTREE",
*,
replace: bool = True,
index_type: Literal["BTREE", "BITMAP", "LABEL_LIST"] = "BTREE",
):
self._dataset_mut.create_scalar_index(
column, index_type=index_type, replace=replace