com.lancedb.lance.index.scalar

Class ScalarIndexParams

java.lang.Object

com.lancedb.lance.index.scalar.ScalarIndexParams

public class ScalarIndexParams
extends Object

Parameters for creating scalar indices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalarIndexParams.Builder

Method Summary

Modifier and Type	Method and Description
static ScalarIndexParams	create(String indexType) Create a new ScalarIndexParams with the given index type and no parameters.
static ScalarIndexParams	create(String indexType, String jsonParams) Create a new ScalarIndexParams with the given index type and JSON parameters.
String	getIndexType()
Optional<String>	getJsonParams()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static ScalarIndexParams create(String indexType)

Create a new ScalarIndexParams with the given index type and no parameters.

Parameters:

indexType - the index type (e.g., "btree", "zonemap", "bitmap", "inverted", "labellist", "ngram")

Returns:

ScalarIndexParams

create

public static ScalarIndexParams create(String indexType,
                                       String jsonParams)

Create a new ScalarIndexParams with the given index type and JSON parameters.

Parameters:

indexType - the index type (e.g., "btree", "zonemap", "bitmap", "inverted", "labellist", "ngram")

jsonParams - JSON string containing index-specific parameters

Returns:

ScalarIndexParams

getIndexType

public String getIndexType()

getJsonParams

public Optional<String> getJsonParams()

toString

public String toString()

Overrides:

toString in class Object