fsk119 commented on code in PR #27037: URL: https://github.com/apache/flink/pull/27037#discussion_r2415497089
########## flink-table/flink-table-common/src/main/java/org/apache/flink/table/connector/source/VectorSearchTableSource.java: ########## @@ -0,0 +1,117 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.table.connector.source; + +import org.apache.flink.annotation.PublicEvolving; +import org.apache.flink.configuration.ReadableConfig; +import org.apache.flink.table.connector.source.search.AsyncVectorSearchFunctionProvider; +import org.apache.flink.table.connector.source.search.VectorSearchFunctionProvider; +import org.apache.flink.types.RowKind; + +import java.io.Serializable; + +/** + * A {@link DynamicTableSource} that search rows of an external storage system by one or more + * vectors during runtime. + * + * <p>Compared to {@link 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. + * + * <p>Note: Compared to {@link ScanTableSource}, a {@link VectorSearchTableSource} does only support + * emitting insert-only changes currently (see also {@link RowKind}). Further abilities are not + * supported. + * + * <p>In the last step, the planner will call {@link #getSearchRuntimeProvider(VectorSearchContext)} + * for obtaining 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 {@link + * VectorSearchTableSource.VectorSearchContext#getSearchColumns()}. The values for those key fields + * are passed during runtime. + */ +@PublicEvolving +public interface VectorSearchTableSource extends DynamicTableSource { + + /** + * Returns a provider of runtime implementation for reading the data. + * + * <p>There exist different interfaces for runtime implementation which is why {@link + * VectorSearchRuntimeProvider} serves as the base interface. + * + * <p>Independent of the provider interface, a source implementation can work on either + * arbitrary objects or internal data structures (see {@link org.apache.flink.table.data} for + * more information). + * + * <p>The given {@link VectorSearchContext} offers utilities by the planner for creating runtime + * implementation with minimal dependencies to internal data structures. + * + * @see VectorSearchFunctionProvider + * @see AsyncVectorSearchFunctionProvider + */ + VectorSearchRuntimeProvider getSearchRuntimeProvider(VectorSearchContext context); + + // -------------------------------------------------------------------------------------------- + // Helper interfaces + // -------------------------------------------------------------------------------------------- + + /** + * Context for creating runtime implementation via a {@link VectorSearchRuntimeProvider}. + * + * <p>It offers utilities by the planner for creating runtime implementation with minimal + * dependencies to internal data structures. + * + * <p>Methods should be called in {@link #getSearchRuntimeProvider(VectorSearchContext)}. + * Returned instances that are {@link Serializable} can be directly passed into the runtime Review Comment: It means the return value by method `getSearchColumns` or `runtimeConfig` is serializable. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
