You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "fsk119 (via GitHub)" <gi...@apache.org> on 2025/09/25 03:20:38 UTC

[PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

fsk119 opened a new pull request, #27037:
URL: https://github.com/apache/flink/pull/27037

   <!--
   *Thank you very much for contributing to Apache Flink - we are happy that you want to help us improve Flink. To help the community review your contribution in the best possible way, please go through the checklist below, which will get the contribution into a shape in which it can be best reviewed.*
   
   *Please understand that we do not do this to make contributions to Flink a hassle. In order to uphold a high standard of quality for code contributions, while at the same time managing a large number of contributions, we need contributors to prepare the contributions well, and give reviewers enough contextual information for the review. Please also understand that contributions that do not follow this guide will take longer to review and thus typically be picked up with lower priority by the community.*
   
   ## Contribution Checklist
   
     - Make sure that the pull request corresponds to a [JIRA issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are made for typos in JavaDoc or documentation files, which need no JIRA issue.
     
     - Name the pull request in the form "[FLINK-XXXX] [component] Title of the pull request", where *FLINK-XXXX* should be replaced by the actual issue number. Skip *component* if you are unsure about which is the best component.
     Typo fixes that have no associated JIRA issue should be named following this pattern: `[hotfix] [docs] Fix typo in event time introduction` or `[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
   
     - Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
     
     - Make sure that the change passes the automated tests, i.e., `mvn clean verify` passes. You can set up Azure Pipelines CI to do that following [this guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
   
     - Each pull request should address only one issue, not mix up code from multiple issues.
     
     - Each commit in the pull request has a meaningful commit message (including the JIRA id)
   
     - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
   
   
   **(The sections below can be removed for hotfixes of typos)**
   -->
   
   ## What is the purpose of the change
   
   *Add VECTOR_SEARCH connector API.*
   
   ## Does this pull request potentially affect one of the following parts:
   
     - Dependencies (does it add or upgrade a dependency): (yes / **no**)
     - The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (**yes** / no)
     - The serializers: (yes / **no** / don't know)
     - The runtime per-record code paths (performance sensitive): (yes / **no** / don't know)
     - Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes / **no** / don't know)
     - The S3 file system connector: (yes / **no** / don't know)
   
   ## Documentation
   
     - Does this pull request introduce a new feature? (**yes** / no)
     - If yes, how is the feature documented? (**not applicable** / docs / JavaDocs / not documented)
   


-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "fsk119 (via GitHub)" <gi...@apache.org>.
fsk119 merged PR #27037:
URL: https://github.com/apache/flink/pull/27037


-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401830131


##########
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

Review Comment:
   nits:
   does only support -> only supports
   I would remove the work currently. 
   I would remove "Further abilities are not supported." I think this is implied by the only word prior
   



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401865689


##########
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
+     * implementation class.
+     */
+    @PublicEvolving
+    interface VectorSearchContext extends DynamicTableSource.Context {
+
+        /**
+         * 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.
+         *
+         * <p>For example, given a table with data type {@code ROW < i INT, s STRING, r ROW < i2
+         * INT, s2 STRING > >}, this method would return {@code [[0], [2, 1]]} when {@code i} and
+         * {@code s2} are used for performing a lookup.
+         *
+         * @return array of key index paths
+         */
+        int[][] getSearchColumns();
+
+        /**
+         * Runtime config provided to provider. The config can be used by planner or vector search

Review Comment:
   nit:
   provider -> the provider



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401852168


##########
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

Review Comment:
   nit:
   VectorSearchRuntimeProvider is a base interface that should be extended (is this true) by child interfaces for specialized Vector Searches.
   



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401865689


##########
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
+     * implementation class.
+     */
+    @PublicEvolving
+    interface VectorSearchContext extends DynamicTableSource.Context {
+
+        /**
+         * 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.
+         *
+         * <p>For example, given a table with data type {@code ROW < i INT, s STRING, r ROW < i2
+         * INT, s2 STRING > >}, this method would return {@code [[0], [2, 1]]} when {@code i} and
+         * {@code s2} are used for performing a lookup.
+         *
+         * @return array of key index paths
+         */
+        int[][] getSearchColumns();
+
+        /**
+         * Runtime config provided to provider. The config can be used by planner or vector search

Review Comment:
   nits:
   provider -> the provider
   planner -> the planner



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401836935


##########
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

Review Comment:
   nit: 
   those key fields -> the search fields 



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "lihaosky (via GitHub)" <gi...@apache.org>.
lihaosky commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2427547877


##########
flink-table/flink-table-common/src/main/java/org/apache/flink/table/functions/AsyncVectorSearchFunction.java:
##########
@@ -0,0 +1,66 @@
+/*
+ * 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.functions;
+
+import org.apache.flink.annotation.PublicEvolving;
+import org.apache.flink.table.api.TableException;
+import org.apache.flink.table.data.GenericRowData;
+import org.apache.flink.table.data.RowData;
+
+import java.util.Collection;
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * A wrapper class of {@link AsyncTableFunction} for asynchronous vector search.
+ *
+ * <p>The output type of this table function is fixed as {@link RowData}.
+ */
+@PublicEvolving
+public abstract class AsyncVectorSearchFunction extends AsyncTableFunction<RowData> {
+
+    /**
+     * Asynchronously search result based on input row to find topK matched rows.
+     *
+     * @param topK - The number of topK matched rows to return.
+     * @param queryData - A {@link RowData} that wraps input for search function.
+     * @return A collection of all searched results.
+     */
+    public abstract CompletableFuture<Collection<RowData>> asyncVectorSearch(
+            int topK, RowData queryData);
+
+    /** Invokes {@link #asyncVectorSearch} and chains futures. */
+    public void eval(CompletableFuture<Collection<RowData>> future, Object... args) {
+        int topK = (int) args[0];
+        GenericRowData argsData = GenericRowData.of(args[1]);

Review Comment:
   Looks `getSearchColumns` can return multiple keys, why is only `args[1]` passed?



##########
flink-table/flink-table-common/src/main/java/org/apache/flink/table/connector/source/VectorSearchTableSource.java:
##########
@@ -0,0 +1,118 @@
+/*
+ * 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 searches 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} only supports
+ * emitting insert-only changes (see also {@link RowKind}).
+ *
+ * <p>In the last step, the planner will call {@link #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 {@link
+ * VectorSearchTableSource.VectorSearchContext#getSearchColumns()}. The values for those search
+ * fields are passed at runtime.
+ */
+@PublicEvolving
+public interface VectorSearchTableSource extends DynamicTableSource {
+
+    /**
+     * Returns a {@code VectorSearchRuntimeProvider}. VectorSearchRuntimeProvider is a base
+     * interface that should be extended (is this true) by child interfaces for specialized vector
+     * searches.
+     *
+     * <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 for the planner to create 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 for the planner to create 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
+     * implementation class.
+     */
+    @PublicEvolving
+    interface VectorSearchContext extends DynamicTableSource.Context {
+
+        /**
+         * 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.
+         *
+         * <p>For example, given a table with data type {@code ROW < i INT, s STRING, r ROW < i2
+         * INT, s2 STRING > >}, this method would return {@code [[0], [2, 1]]} when {@code i} and

Review Comment:
   QQ: why it's `[2, 1]`, is 2 for r and 1 for s2 in r? If so, why not `[1, 1]`?



##########
flink-table/flink-table-common/src/main/java/org/apache/flink/table/functions/VectorSearchFunction.java:
##########
@@ -0,0 +1,62 @@
+/*
+ * 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.functions;
+
+import org.apache.flink.annotation.PublicEvolving;
+import org.apache.flink.table.data.GenericRowData;
+import org.apache.flink.table.data.RowData;
+import org.apache.flink.util.FlinkRuntimeException;
+
+import java.io.IOException;
+import java.util.Collection;
+
+/**
+ * A wrapper class of {@link TableFunction} for synchronous vector search.
+ *
+ * <p>The output type of this table function is fixed as {@link RowData}.
+ */
+@PublicEvolving
+public abstract class VectorSearchFunction extends TableFunction<RowData> {
+
+    /**
+     * Synchronously search result based on input row to find topK matched rows.
+     *
+     * @param topK - The number of topK results to return.
+     * @param queryData - A {@link RowData} that wraps input for vector search function.
+     * @return A collection of predicted results.
+     */
+    public abstract Collection<RowData> vectorSearch(int topK, RowData queryData)
+            throws IOException;
+
+    /** Invoke {@link #vectorSearch} and handle exceptions. */
+    public final void eval(Object... args) {
+        int topK = (int) args[0];
+        GenericRowData argsData = GenericRowData.of(args[1]);

Review Comment:
   ditto



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "fsk119 (via GitHub)" <gi...@apache.org>.
fsk119 commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2427674593


##########
flink-table/flink-table-common/src/main/java/org/apache/flink/table/connector/source/VectorSearchTableSource.java:
##########
@@ -0,0 +1,118 @@
+/*
+ * 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 searches 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} only supports
+ * emitting insert-only changes (see also {@link RowKind}).
+ *
+ * <p>In the last step, the planner will call {@link #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 {@link
+ * VectorSearchTableSource.VectorSearchContext#getSearchColumns()}. The values for those search
+ * fields are passed at runtime.
+ */
+@PublicEvolving
+public interface VectorSearchTableSource extends DynamicTableSource {
+
+    /**
+     * Returns a {@code VectorSearchRuntimeProvider}. VectorSearchRuntimeProvider is a base
+     * interface that should be extended (is this true) by child interfaces for specialized vector
+     * searches.
+     *
+     * <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 for the planner to create 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 for the planner to create 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
+     * implementation class.
+     */
+    @PublicEvolving
+    interface VectorSearchContext extends DynamicTableSource.Context {
+
+        /**
+         * 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.
+         *
+         * <p>For example, given a table with data type {@code ROW < i INT, s STRING, r ROW < i2
+         * INT, s2 STRING > >}, this method would return {@code [[0], [2, 1]]} when {@code i} and

Review Comment:
   yes. It's 2 for r and 1 for s2, but I don't understand what's the meaning of [1,1]



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "fsk119 (via GitHub)" <gi...@apache.org>.
fsk119 commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2415498354


##########
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)}

Review Comment:
   yes, it is. Vector search is similar to lookup join.



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401832100


##########
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)}

Review Comment:
   Is it always the last step. It might be safer to ay after having ... then the planner will



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401861481


##########
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:
   I am not sure what the returned instances are here, the provider or what it provides?



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401869051


##########
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
+     * implementation class.
+     */
+    @PublicEvolving
+    interface VectorSearchContext extends DynamicTableSource.Context {
+
+        /**
+         * 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.
+         *
+         * <p>For example, given a table with data type {@code ROW < i INT, s STRING, r ROW < i2
+         * INT, s2 STRING > >}, this method would return {@code [[0], [2, 1]]} when {@code i} and
+         * {@code s2} are used for performing a lookup.
+         *
+         * @return array of key index paths
+         */
+        int[][] getSearchColumns();
+
+        /**
+         * Runtime config provided to provider. The config can be used by 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.
+         */
+        ReadableConfig runtimeConfig();
+    }
+
+    /**
+     * Provides actual runtime implementation for reading the data.
+     *
+     * <p>There exist different interfaces for runtime implementation which is why {@link

Review Comment:
   nit:
   exist -> exists



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401854119


##########
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

Review Comment:
   nit:
   by the planner for -> for the planner to



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401833359


##########
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

Review Comment:
   nit:
   for obtaining a provider of runtime implementation -> to obtain the runtime implementation provider



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "fsk119 (via GitHub)" <gi...@apache.org>.
fsk119 commented on PR #27037:
URL: https://github.com/apache/flink/pull/27037#issuecomment-3400312010

   The failed test is not related to the PR. Merging...


-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "fsk119 (via GitHub)" <gi...@apache.org>.
fsk119 commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2415495859


##########
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)}.

Review Comment:
   I think it means the context is avaliable in method `getSearchRuntimeProvider(VectorSearchContext)` and the connector developer should get these information in the above method.



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401859595


##########
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)}.

Review Comment:
   I am not sure what "Methods should be called in " means. Maybe "classes needing access to the Vector search information should use {@link #getSearchRuntimeProvider(VectorSearchContext)}"



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401846375


##########
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.

Review Comment:
   nit:
   Returns a provider of runtime implementation for reading the data. -> Returns a SearchRuntimeProvider



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "davidradl (via GitHub)" <gi...@apache.org>.
davidradl commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2401826097


##########
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

Review Comment:
   nits: 
   search ->searches
   during -> at



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "lihaosky (via GitHub)" <gi...@apache.org>.
lihaosky commented on code in PR #27037:
URL: https://github.com/apache/flink/pull/27037#discussion_r2427705924


##########
flink-table/flink-table-common/src/main/java/org/apache/flink/table/connector/source/VectorSearchTableSource.java:
##########
@@ -0,0 +1,118 @@
+/*
+ * 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 searches 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} only supports
+ * emitting insert-only changes (see also {@link RowKind}).
+ *
+ * <p>In the last step, the planner will call {@link #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 {@link
+ * VectorSearchTableSource.VectorSearchContext#getSearchColumns()}. The values for those search
+ * fields are passed at runtime.
+ */
+@PublicEvolving
+public interface VectorSearchTableSource extends DynamicTableSource {
+
+    /**
+     * Returns a {@code VectorSearchRuntimeProvider}. VectorSearchRuntimeProvider is a base
+     * interface that should be extended (is this true) by child interfaces for specialized vector
+     * searches.
+     *
+     * <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 for the planner to create 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 for the planner to create 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
+     * implementation class.
+     */
+    @PublicEvolving
+    interface VectorSearchContext extends DynamicTableSource.Context {
+
+        /**
+         * 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.
+         *
+         * <p>For example, given a table with data type {@code ROW < i INT, s STRING, r ROW < i2
+         * INT, s2 STRING > >}, this method would return {@code [[0], [2, 1]]} when {@code i} and

Review Comment:
   Nevermind, I missed s column 😅 



-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "fsk119 (via GitHub)" <gi...@apache.org>.
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [FLINK-38423][table-api] Add VECTOR_SEARCH connector API [flink]

Posted by "flinkbot (via GitHub)" <gi...@apache.org>.
flinkbot commented on PR #27037:
URL: https://github.com/apache/flink/pull/27037#issuecomment-3331938065

   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "ee7427350f048bde21219a9783857bc96d9a3af7",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "ee7427350f048bde21219a9783857bc96d9a3af7",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * ee7427350f048bde21219a9783857bc96d9a3af7 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run azure` re-run the last Azure build
   </details>


-- 
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: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org