Package org.apache.flink.table.connector.source

Interface VectorSearchTableSource.VectorSearchContext

All Superinterfaces:

DynamicTableSource.Context

Enclosing interface:

VectorSearchTableSource

@PublicEvolving
public static interface VectorSearchTableSource.VectorSearchContext
extends DynamicTableSource.Context

Context for creating runtime implementation via a VectorSearchTableSource.VectorSearchRuntimeProvider.

It offers utilities for the planner to create runtime implementation with minimal dependencies to internal data structures.

Methods should be called in VectorSearchTableSource.getSearchRuntimeProvider(VectorSearchContext). Returned instances that are Serializable can be directly passed into the runtime implementation class.

Method Summary

Modifier and Type	Method	Description
int[][]	getSearchColumns()	Returns an array of key index paths that should be used during the search.
org.apache.flink.configuration.ReadableConfig	runtimeConfig()	Runtime config provided to the provider.

Methods inherited from interface org.apache.flink.table.connector.source.DynamicTableSource.Context

createDataStructureConverter, createTypeInformation, createTypeInformation

Method Detail

getSearchColumns

int[][] getSearchColumns()

Returns an array of key index paths that should be used during the search. The indices are 0-based and support composite keys within (possibly nested) structures.

For example, given a table with data type ROW < i INT, s STRING, r ROW < i2 INT, s2 STRING > >, this method would return [[0], [2, 1]] when i and s2 are used for performing a lookup.

Returns:

array of key index paths

runtimeConfig

org.apache.flink.configuration.ReadableConfig runtimeConfig()

Runtime config provided to the provider. The config can be used by the planner or vector search provider at runtime. For example, async options can be used by planner to choose async inference. Other config such as http timeout or retry can be used to configure search functions.