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

Interface VectorSearchTableSource

All Superinterfaces:

DynamicTableSource

@PublicEvolving
public interface VectorSearchTableSource
extends DynamicTableSource

A DynamicTableSource that searches rows of an external storage system by one or more vectors during runtime.

Compared to ScanTableSource, the source does not have to read the entire table and can lazily fetch individual values from a (possibly continuously changing) external table when necessary.

Note: Compared to ScanTableSource, a VectorSearchTableSource only supports emitting insert-only changes (see also RowKind).

In the last step, the planner will call getSearchRuntimeProvider(VectorSearchContext) to obtain a provider of runtime implementation. The search fields that are required to perform a search are derived from a query by the planner and will be provided in the given VectorSearchTableSource.VectorSearchContext.getSearchColumns(). The values for those search fields are passed at runtime.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	VectorSearchTableSource.VectorSearchContext	Context for creating runtime implementation via a VectorSearchTableSource.VectorSearchRuntimeProvider.
static interface	VectorSearchTableSource.VectorSearchRuntimeProvider	Provides actual runtime implementation for reading the data.

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.source.DynamicTableSource

DynamicTableSource.Context, DynamicTableSource.DataStructureConverter

Method Summary

Modifier and Type	Method	Description
VectorSearchTableSource.VectorSearchRuntimeProvider	getSearchRuntimeProvider(VectorSearchTableSource.VectorSearchContext context)	Returns a VectorSearchRuntimeProvider.

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

asSummaryString, copy

Method Detail

getSearchRuntimeProvider

VectorSearchTableSource.VectorSearchRuntimeProvider getSearchRuntimeProvider(VectorSearchTableSource.VectorSearchContext context)

Returns a VectorSearchRuntimeProvider. VectorSearchRuntimeProvider is a base interface that should be extended (is this true) by child interfaces for specialized vector searches.

There exist different interfaces for runtime implementation which is why VectorSearchTableSource.VectorSearchRuntimeProvider serves as the base interface.

Independent of the provider interface, a source implementation can work on either arbitrary objects or internal data structures (see org.apache.flink.table.data for more information).

The given VectorSearchTableSource.VectorSearchContext offers utilities for the planner to create runtime implementation with minimal dependencies to internal data structures.

See Also:

VectorSearchFunctionProvider, AsyncVectorSearchFunctionProvider