Vector Search Scenario

.gitignore

@@ -256,9 +256,13 @@ nbdist/
 # Avoid ignoring PolySqlParser jar file (.jar files are usually ignored)
 !/libs/PolySqlParser-1.0.jar
 
+# vectorbench CLI path
 /results.csv
+/results-pg.csv
+/recall-groundtruth.csv
+/recall.csv
 
 # humble video libraries
 libhumblevideo-0.dll
 libhumblevideo.dylib
-libhumblevideo.so
+libhumblevideo.so

src/main/java/org/polypheny/simpleclient/cli/Main.java

@@ -42,6 +42,7 @@ public static void main( String[] args ) throws SQLException {
         builder.withCommands( ComsCommand.class );
         builder.withCommands( GavelCommand.class );
         builder.withCommands( KnnCommand.class );
+        builder.withCommands( VectorCommand.class );
         builder.withCommands( MultimediaCommand.class );
         builder.withCommands( GraphCommand.class );
         builder.withCommands( DocBenchCommand.class );

src/main/java/org/polypheny/simpleclient/cli/VectorCommand.java

@@ -0,0 +1,123 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019-2026 The Polypheny Project
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package org.polypheny.simpleclient.cli;
+
+import com.github.rvesse.airline.HelpOption;
+import com.github.rvesse.airline.annotations.AirlineModule;
+import com.github.rvesse.airline.annotations.Arguments;
+import com.github.rvesse.airline.annotations.Command;
+import com.github.rvesse.airline.annotations.Option;
+import lombok.extern.slf4j.Slf4j;
+import org.polypheny.simpleclient.executor.Executor.ExecutorFactory;
+import org.polypheny.simpleclient.executor.PolyphenyDbJdbcExecutor.PolyphenyDbJdbcExecutorFactory;
+import org.polypheny.simpleclient.main.VectorBenchScenario;
+import java.sql.SQLException;
+import java.util.List;
+
+@Slf4j
+@Command(name = "vector", description = "Mode for quick testing of Polypheny-DB using the vector benchmark.")
+public class VectorCommand implements CliRunnable {
+
+    @AirlineModule
+    private HelpOption<VectorCommand> help;
+
+    @Arguments(description = "Task { schema | data | groundtruth | index | workload | warmup | recall } and multiplier.")
+    private List<String> args;
+
+
+    @Option(name = { "-pdb", "--polyphenydb" }, title = "IP or Hostname", arity = 1, description = "IP or Hostname of the Polypheny-DB server (default: 127.0.0.1).")
+    public static String polyphenyDbHost = "127.0.0.1";
+
+
+    @Option(name = { "--writeCSV" }, arity = 0, description = "Write a CSV file containing execution times for all executed queries (default: false).")
+    public boolean writeCsv = false;
+
+
+    @Option(name = { "--queryList" }, arity = 0, description = "Dump all queries into a file (default: false).")
+    public boolean dumpQueryList = false;
+
+
+    @Override
+    public int run() throws SQLException {
+
+        if ( args == null || args.size() < 1 ) {
+            System.err.println( "Missing task" );
+            System.exit( 1 );
+        }
+
+        int multiplier = 1;
+        if ( args.size() > 1 ) {
+            multiplier = Integer.parseInt( args.get( 1 ) );
+            if ( multiplier < 1 ) {
+                System.err.println( "Multiplier needs to be a integer > 0!" );
+                System.exit( 1 );
+            }
+        }
+
+        ExecutorFactory executorFactory;
+        executorFactory = new PolyphenyDbJdbcExecutorFactory( polyphenyDbHost, false );
+        boolean usePostgres = VectorBenchScenario.isPostgresMode();
+        String task = args.getFirst();
+
+        try {
+            if ( task.equalsIgnoreCase( "data" ) ) {
+                if ( usePostgres ) VectorBenchScenario.pgData( multiplier, true );
+                else VectorBenchScenario.data( executorFactory, multiplier, true );
+            } else if ( task.equalsIgnoreCase( "workload" ) ) {
+                if ( usePostgres ) VectorBenchScenario.pgWorkload( multiplier, true, writeCsv, dumpQueryList );
+                else VectorBenchScenario.workload( executorFactory, multiplier, true, writeCsv, dumpQueryList );
+            } else if ( args.getFirst().equalsIgnoreCase( "schema" ) ) {
+                if ( usePostgres ) VectorBenchScenario.pgSchema( true );
+                else VectorBenchScenario.schema( executorFactory, true );
+            } else if ( task.equalsIgnoreCase( "index" ) ) {
+                if ( usePostgres ) VectorBenchScenario.pgIndex( true );
+                else VectorBenchScenario.index( executorFactory, true );
+            } else if ( task.equalsIgnoreCase( "groundtruth" ) ) {
+                if ( usePostgres ) VectorBenchScenario.pgGroundTruth();
+                else VectorBenchScenario.groundTruth( executorFactory );
+            } else if ( task.equalsIgnoreCase( "recall" ) ) {
+                if ( usePostgres ) VectorBenchScenario.pgRecall();
+                else VectorBenchScenario.recall( executorFactory );
+            } else if ( args.getFirst().equalsIgnoreCase( "warmup" ) ) {
+                if ( usePostgres ) VectorBenchScenario.pgWarmup( multiplier, true, dumpQueryList );
+                else VectorBenchScenario.warmup( executorFactory, multiplier, true, dumpQueryList );
+            } else {
+                System.err.println( "Unknown task: " + args.getFirst() );
+            }
+        } catch ( Throwable t ) {
+            log.error( "Exception while executing VectorBench!", t );
+            System.exit( 1 );
+        }
+
+        try {
+            Thread.sleep( 2000 );
+        } catch ( InterruptedException e ) {
+            throw new RuntimeException( "Unexpected interrupt", e );
+        }
+
+        return 0;
+    }
+
+}

src/main/java/org/polypheny/simpleclient/executor/JdbcExecutor.java

@@ -108,6 +108,9 @@ public long executeQuery( Query query ) throws ExecutorException {
                         case ARRAY_REAL:
                             preparedStatement.setArray( entry.getKey(), connection.createArrayOf( "REAL", (Object[]) entry.getValue().right ) );
                             break;
+                        case ARRAY_BOOLEAN:
+                            preparedStatement.setArray( entry.getKey(), connection.createArrayOf( "BOOLEAN", (Object[]) entry.getValue().right ) );
+                            break;
                         case BYTE_ARRAY:
                             preparedStatement.setBytes( entry.getKey(), (byte[]) entry.getValue().right );
                             break;
@@ -156,6 +159,23 @@ public long executeQuery( Query query ) throws ExecutorException {
     }
 
 
+    /**
+     * Executes the given query and returns the values of the first column of the result set (e.g. the ids of a
+     * top-k nearest-neighbor query). Used for recall measurement where the actual returned rows are needed.
+     */
+    public List<Long> executeQueryAndGetIds( Query query ) throws ExecutorException {
+        List<Long> ids = new ArrayList<>();
+        try ( ResultSet resultSet = executeStatement.executeQuery( query.getSql() ) ) {
+            while ( resultSet.next() ) {
+                ids.add( resultSet.getLong( 1 ) );
+            }
+        } catch ( SQLException e ) {
+            throw new ExecutorException( e );
+        }
+        return ids;
+    }
+
+
     @Override
     public long executeQueryAndGetNumber( Query query ) throws ExecutorException {
         try {
@@ -254,6 +274,9 @@ protected void executeInsertListAsPreparedBatch( List<BatchableInsert> queryList
                         case ARRAY_REAL:
                             preparedStatement.setArray( entry.getKey(), connection.createArrayOf( "REAL", (Object[]) entry.getValue().right ) );
                             break;
+                        case ARRAY_BOOLEAN:
+                            preparedStatement.setArray( entry.getKey(), connection.createArrayOf( "BOOLEAN", (Object[]) entry.getValue().right) );
+                            break;
                         case BYTE_ARRAY:
                             preparedStatement.setBytes( entry.getKey(), (byte[]) entry.getValue().right );
                             break;

src/main/java/org/polypheny/simpleclient/executor/PolyphenyDbExecutor.java

@@ -122,13 +122,18 @@ default String deployMonetDb( boolean deployStoresUsingDocker ) throws ExecutorE
 
 
     default String deployPostgres( boolean deployStoresUsingDocker ) throws ExecutorException {
+        return deployPostgres( deployStoresUsingDocker, "pgvector & PostGIS" );
+    }
+
+
+    default String deployPostgres( boolean deployStoresUsingDocker, String imageVariant ) throws ExecutorException {
         String config;
         String name;
         if ( deployStoresUsingDocker ) {
             name = "postgres" + storeCounter.getAndIncrement();
             if ( PolyphenyVersionSwitch.getInstance().useNewAdapterDeployParameters ) {
                 int dockerInstanceId = getDockerInstanceId();
-                config = "{\"mode\":\"docker\",\"instanceId\":\"" + dockerInstanceId + "\",\"maxConnections\":\"25\"}";
+                config = "{\"mode\":\"docker\",\"instanceId\":\"" + dockerInstanceId + "\",\"maxConnections\":\"25\",\"imageVariant\":\"" + imageVariant + "\"}";
             } else {
                 config = "{\"port\":\"" + nextPort.getAndIncrement() + "\",\"maxConnections\":\"25\",\"password\":\"postgres\",\"mode\":\"docker\",\"instanceId\":\"0\"}";
             }
@@ -345,7 +350,7 @@ public PolyphenyDbInstance( PolyphenyControlConnector polyphenyControlConnector,
                             if ( !config.deployStoresUsingDocker ) {
                                 PostgresInstance.reset();
                             }
-                            executor.deployPostgres( config.deployStoresUsingDocker );
+                            executor.deployPostgres( config.deployStoresUsingDocker, config.postgresImageVariant );
                             break;
                         case "monetdb":
                             if ( !config.deployStoresUsingDocker ) {

src/main/java/org/polypheny/simpleclient/main/ChronosAgent.java

@@ -83,6 +83,9 @@
 import org.polypheny.simpleclient.scenario.graph.GraphBenchConfig;
 import org.polypheny.simpleclient.scenario.knnbench.KnnBench;
 import org.polypheny.simpleclient.scenario.knnbench.KnnBenchConfig;
+import org.polypheny.simpleclient.scenario.vectorbench.PgVectorBench;
+import org.polypheny.simpleclient.scenario.vectorbench.VectorBench;
+import org.polypheny.simpleclient.scenario.vectorbench.VectorBenchConfig;
 import org.polypheny.simpleclient.scenario.multibench.MultiBench;
 import org.polypheny.simpleclient.scenario.multibench.MultiBenchConfig;
 import org.polypheny.simpleclient.scenario.multimedia.MultimediaBench;
@@ -218,7 +221,7 @@ protected Object prepare( ChronosJob chronosJob, final File inputDirectory, fina
                 executorFactory = new SurrealDBExecutorFactory( ChronosCommand.hostname, "8989", true );
                 break;
             case "postgres":
-                dockerContainerName = DockerLauncher.launch( "postgres", "polypheny/postgres:latest", Map.of( "POSTGRES_PASSWORD", "postgres" ), List.of( 5432 ), () -> PostgresInstance.tryConnect( ChronosCommand.hostname ) );
+                dockerContainerName = DockerLauncher.launch( "postgres", "polypheny/postgres-pgvector-postgis:17-debian", Map.of( "POSTGRES_PASSWORD", "postgres" ), List.of( 5432 ), () -> PostgresInstance.tryConnect( ChronosCommand.hostname ) );
                 executorFactory = new PostgresExecutorFactory( ChronosCommand.hostname, Boolean.parseBoolean( parsedConfig.get( "prepareStatements" ) ) );
                 break;
             case "monetdb":
@@ -253,6 +256,14 @@ protected Object prepare( ChronosJob chronosJob, final File inputDirectory, fina
                 config = new KnnBenchConfig( parsedConfig );
                 scenario = new KnnBench( executorFactory, (KnnBenchConfig) config, true, dumpQueryList );
                 break;
+            case "vectorBench":
+                config = new VectorBenchConfig( parsedConfig );
+                if ( config.system.equals( "postgres" ) ) {
+                    scenario = new PgVectorBench( executorFactory, (VectorBenchConfig) config, true, dumpQueryList );
+                } else {
+                    scenario = new VectorBench( executorFactory, (VectorBenchConfig) config, true, dumpQueryList );
+                }
+                break;
             case "multimedia":
                 config = new MultimediaConfig( parsedConfig );
                 scenario = new MultimediaBench( executorFactory, (MultimediaConfig) config, true, dumpQueryList );

src/main/java/org/polypheny/simpleclient/main/CsvWriter.java

@@ -55,7 +55,7 @@ public void appendToCsv( String query, long measuredTime ) {
     }
 
 
-    private void writeLine( String[] entries ) {
+    private synchronized void writeLine( String[] entries ) {
         try {
             String line = String.join( ",", entries );
             writer.write( line );