dominikriemer commented on code in PR #3559: URL: https://github.com/apache/streampipes/pull/3559#discussion_r2034019818
########## streampipes-extensions/streampipes-sinks-databases-jvm/src/main/java/org/apache/streampipes/sinks/databases/jvm/milvus/MilvusSink.java: ########## @@ -0,0 +1,380 @@ +/* + * 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.streampipes.sinks.databases.jvm.milvus; + +import org.apache.streampipes.commons.exceptions.SpRuntimeException; +import org.apache.streampipes.extensions.api.pe.context.EventSinkRuntimeContext; +import org.apache.streampipes.model.DataSinkType; +import org.apache.streampipes.model.extensions.ExtensionAssetType; +import org.apache.streampipes.model.graph.DataSinkDescription; +import org.apache.streampipes.model.runtime.Event; +import org.apache.streampipes.model.schema.EventProperty; +import org.apache.streampipes.model.schema.EventPropertyNested; +import org.apache.streampipes.model.schema.EventPropertyPrimitive; +import org.apache.streampipes.model.schema.EventSchema; +import org.apache.streampipes.model.schema.PropertyScope; +import org.apache.streampipes.sdk.builder.DataSinkBuilder; +import org.apache.streampipes.sdk.builder.StreamRequirementsBuilder; +import org.apache.streampipes.sdk.helpers.EpRequirements; +import org.apache.streampipes.sdk.helpers.Labels; +import org.apache.streampipes.sdk.helpers.Locales; +import org.apache.streampipes.sdk.helpers.Options; +import org.apache.streampipes.wrapper.params.compat.SinkParams; +import org.apache.streampipes.wrapper.standalone.StreamPipesDataSink; + +import com.google.gson.Gson; +import com.google.gson.JsonObject; +import io.milvus.param.Constant; +import io.milvus.pool.MilvusClientV2Pool; +import io.milvus.pool.PoolConfig; +import io.milvus.v2.client.ConnectConfig; +import io.milvus.v2.client.MilvusClientV2; +import io.milvus.v2.common.DataType; +import io.milvus.v2.common.IndexParam; +import io.milvus.v2.service.collection.request.AddFieldReq; +import io.milvus.v2.service.collection.request.CreateCollectionReq; +import io.milvus.v2.service.collection.request.DescribeCollectionReq; +import io.milvus.v2.service.collection.request.HasCollectionReq; +import io.milvus.v2.service.collection.response.DescribeCollectionResp; +import io.milvus.v2.service.database.request.CreateDatabaseReq; +import io.milvus.v2.service.vector.request.InsertReq; + +import java.time.Duration; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class MilvusSink extends StreamPipesDataSink { + public static final String MILVUS_URI_KEY = "milvus_uri"; + public static final String MILVUS_TOKEN_KEY = "milvus_token"; + + public static final String MILVUS_DBNAME_KEY = "milvus_dbname"; + public static final String DATABASE_REPLICA_NUMBER_KEY = "database_replica_number"; + + public static final String COLLECTION_NAME_KEY = "collection_name"; + + public static final String VECTOR_KEY = "vector"; + public static final String DIMENSION = "dimension"; + public static final String METRIC_TYPE = "metric_type"; + + public static final String INDEX = "index"; + + public static final String PRIMARY = "primary"; + + public DataType vectorDataType; + + public final Gson gson = new Gson(); + + public MilvusClientV2Pool pool; + public MilvusClientV2 client; + String vector; + String primary; + String collectionName; + Integer dimension; + IndexParam.MetricType metricType; + IndexParam indexParam; + CreateCollectionReq.CollectionSchema collectionSchema; + + public static final String BYTE = "http://www.w3.org/2001/XMLSchema#byte";; Review Comment: There is an `Xsd` class in `org.apache.streampipes.vocabulary` which provide these variables, could you reuse these? ########## streampipes-extensions/streampipes-sinks-databases-jvm/src/main/java/org/apache/streampipes/sinks/databases/jvm/milvus/MilvusSink.java: ########## @@ -0,0 +1,380 @@ +/* + * 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.streampipes.sinks.databases.jvm.milvus; + +import org.apache.streampipes.commons.exceptions.SpRuntimeException; +import org.apache.streampipes.extensions.api.pe.context.EventSinkRuntimeContext; +import org.apache.streampipes.model.DataSinkType; +import org.apache.streampipes.model.extensions.ExtensionAssetType; +import org.apache.streampipes.model.graph.DataSinkDescription; +import org.apache.streampipes.model.runtime.Event; +import org.apache.streampipes.model.schema.EventProperty; +import org.apache.streampipes.model.schema.EventPropertyNested; +import org.apache.streampipes.model.schema.EventPropertyPrimitive; +import org.apache.streampipes.model.schema.EventSchema; +import org.apache.streampipes.model.schema.PropertyScope; +import org.apache.streampipes.sdk.builder.DataSinkBuilder; +import org.apache.streampipes.sdk.builder.StreamRequirementsBuilder; +import org.apache.streampipes.sdk.helpers.EpRequirements; +import org.apache.streampipes.sdk.helpers.Labels; +import org.apache.streampipes.sdk.helpers.Locales; +import org.apache.streampipes.sdk.helpers.Options; +import org.apache.streampipes.wrapper.params.compat.SinkParams; +import org.apache.streampipes.wrapper.standalone.StreamPipesDataSink; + +import com.google.gson.Gson; +import com.google.gson.JsonObject; +import io.milvus.param.Constant; +import io.milvus.pool.MilvusClientV2Pool; +import io.milvus.pool.PoolConfig; +import io.milvus.v2.client.ConnectConfig; +import io.milvus.v2.client.MilvusClientV2; +import io.milvus.v2.common.DataType; +import io.milvus.v2.common.IndexParam; +import io.milvus.v2.service.collection.request.AddFieldReq; +import io.milvus.v2.service.collection.request.CreateCollectionReq; +import io.milvus.v2.service.collection.request.DescribeCollectionReq; +import io.milvus.v2.service.collection.request.HasCollectionReq; +import io.milvus.v2.service.collection.response.DescribeCollectionResp; +import io.milvus.v2.service.database.request.CreateDatabaseReq; +import io.milvus.v2.service.vector.request.InsertReq; + +import java.time.Duration; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class MilvusSink extends StreamPipesDataSink { + public static final String MILVUS_URI_KEY = "milvus_uri"; + public static final String MILVUS_TOKEN_KEY = "milvus_token"; + + public static final String MILVUS_DBNAME_KEY = "milvus_dbname"; + public static final String DATABASE_REPLICA_NUMBER_KEY = "database_replica_number"; + + public static final String COLLECTION_NAME_KEY = "collection_name"; + + public static final String VECTOR_KEY = "vector"; + public static final String DIMENSION = "dimension"; + public static final String METRIC_TYPE = "metric_type"; + + public static final String INDEX = "index"; + + public static final String PRIMARY = "primary"; + + public DataType vectorDataType; + + public final Gson gson = new Gson(); + + public MilvusClientV2Pool pool; + public MilvusClientV2 client; + String vector; + String primary; + String collectionName; + Integer dimension; + IndexParam.MetricType metricType; + IndexParam indexParam; + CreateCollectionReq.CollectionSchema collectionSchema; + + public static final String BYTE = "http://www.w3.org/2001/XMLSchema#byte";; + public static final String SHORT = "http://www.w3.org/2001/XMLSchema#short";; + public static final String LONG = "http://www.w3.org/2001/XMLSchema#long";; + public static final String INT = "http://www.w3.org/2001/XMLSchema#integer";; + public static final String FLOAT = "http://www.w3.org/2001/XMLSchema#float";; + public static final String DOUBLE = "http://www.w3.org/2001/XMLSchema#double";; + public static final String BOOLEAN = "http://www.w3.org/2001/XMLSchema#boolean";; + public static final String STRING = "http://www.w3.org/2001/XMLSchema#string";; + + + private static final Map<String, DataType> INDEX_MAP = new HashMap<>() { + { + put("BinaryVector", DataType.BinaryVector); + put("FloatVector", DataType.FloatVector); + } + }; + + private static final Map<String, IndexParam.MetricType> METRIC_TYPE_MAP = new HashMap<>() { + { + put("L2", IndexParam.MetricType.L2); + put("IP", IndexParam.MetricType.IP); + put("COSINE", IndexParam.MetricType.COSINE); + put("HAMMING", IndexParam.MetricType.HAMMING); + put("JACCARD", IndexParam.MetricType.JACCARD); + put("BM25", IndexParam.MetricType.BM25); + } + }; + + @Override + public DataSinkDescription declareModel() { + return DataSinkBuilder + .create("org.apache.streampipes.sinks.databases.jvm.milvus", 0) + .withLocales(Locales.EN) + .withAssets(ExtensionAssetType.DOCUMENTATION, ExtensionAssetType.ICON). + category(DataSinkType.DATABASE) + .requiredTextParameter(Labels.withId(MILVUS_URI_KEY)) + .requiredTextParameter(Labels.withId(MILVUS_TOKEN_KEY), "root:Milvus") + .requiredTextParameter(Labels.withId(MILVUS_DBNAME_KEY)) + .requiredTextParameter(Labels.withId(DATABASE_REPLICA_NUMBER_KEY), "2") + .requiredTextParameter(Labels.withId(COLLECTION_NAME_KEY)) + .requiredTextParameter(Labels.withId(PRIMARY), "id") + .requiredIntegerParameter(Labels.withId(DIMENSION), 2) + .requiredStream(StreamRequirementsBuilder + .create() + .requiredPropertyWithUnaryMapping(EpRequirements.anyProperty(), + Labels.withId(VECTOR_KEY), + PropertyScope.NONE) + .build()) + .requiredSingleValueSelection(Labels.withId(INDEX), + Options.from(INDEX_MAP.keySet().toArray(new String[0]))) + .requiredSingleValueSelection(Labels.withId(METRIC_TYPE), + Options.from(METRIC_TYPE_MAP.keySet().toArray(new String[0]))) + .build(); + } + + @Override + public void onInvocation(SinkParams parameters, + EventSinkRuntimeContext runtimeContext) throws SpRuntimeException { + var extractor = parameters.extractor(); + final String uri = extractor.singleValueParameter(MILVUS_URI_KEY, String.class); + final String token = extractor.singleValueParameter(MILVUS_TOKEN_KEY, String.class); + + ConnectConfig connectConfig = ConnectConfig.builder() + .uri(uri) + .token(token) + .build(); + + PoolConfig poolConfig = PoolConfig.builder() + .maxIdlePerKey(10) // max idle clients per key + .maxTotalPerKey(20) // max total(idle + active) clients per key + .maxTotal(100) // max total clients for all keys + .maxBlockWaitDuration(Duration.ofSeconds(5L)) // getClient() will wait 5 seconds if no idle client available + .minEvictableIdleDuration(Duration.ofSeconds(10L)) // if number + .build(); + + try { + pool = new MilvusClientV2Pool(poolConfig, connectConfig); + client = pool.getClient("client_name"); + //create a dataBase + final String dbName = parameters.extractor().singleValueParameter(MILVUS_DBNAME_KEY, String.class); + final String dbReplicaNum = + parameters.extractor().singleValueParameter(DATABASE_REPLICA_NUMBER_KEY, String.class); + Map<String, String> properties = new HashMap<>(); + properties.put(Constant.DATABASE_REPLICA_NUMBER, dbReplicaNum); + try { + CreateDatabaseReq createDatabaseReq = CreateDatabaseReq.builder() + .databaseName(dbName) + .properties(properties) + .build(); + client.createDatabase(createDatabaseReq); + client.useDatabase(dbName); + } catch (Exception ignored) { + //todo add log + } finally { + client.useDatabase(dbName); + } + + this.vector = parameters.extractor().mappingPropertyValue(VECTOR_KEY).substring(4); + this.vectorDataType = INDEX_MAP.get(parameters.extractor().selectedSingleValue(INDEX, String.class)); + this.primary = parameters.extractor().singleValueParameter(PRIMARY, String.class); + this.dimension = Integer.valueOf(parameters.extractor().singleValueParameter(DIMENSION, String.class)); + this.metricType = METRIC_TYPE_MAP.get(parameters.extractor().selectedSingleValue(METRIC_TYPE, String.class)); + this.collectionName = parameters.extractor().singleValueParameter(COLLECTION_NAME_KEY, String.class); + + // check whether collection test exists + HasCollectionReq hasCollectionReq = HasCollectionReq.builder() + .collectionName(this.collectionName) + .build(); + Boolean resp = client.hasCollection(hasCollectionReq); + if (resp) { + DescribeCollectionReq describeCollectionReq = DescribeCollectionReq.builder() + .collectionName(this.collectionName) + .build(); + System.out.println("collection name" + this.collectionName); Review Comment: `System.out` can be replaced by logging ########## streampipes-extensions/streampipes-sinks-databases-jvm/src/main/java/org/apache/streampipes/sinks/databases/jvm/milvus/MilvusSink.java: ########## @@ -0,0 +1,380 @@ +/* + * 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.streampipes.sinks.databases.jvm.milvus; + +import org.apache.streampipes.commons.exceptions.SpRuntimeException; +import org.apache.streampipes.extensions.api.pe.context.EventSinkRuntimeContext; +import org.apache.streampipes.model.DataSinkType; +import org.apache.streampipes.model.extensions.ExtensionAssetType; +import org.apache.streampipes.model.graph.DataSinkDescription; +import org.apache.streampipes.model.runtime.Event; +import org.apache.streampipes.model.schema.EventProperty; +import org.apache.streampipes.model.schema.EventPropertyNested; +import org.apache.streampipes.model.schema.EventPropertyPrimitive; +import org.apache.streampipes.model.schema.EventSchema; +import org.apache.streampipes.model.schema.PropertyScope; +import org.apache.streampipes.sdk.builder.DataSinkBuilder; +import org.apache.streampipes.sdk.builder.StreamRequirementsBuilder; +import org.apache.streampipes.sdk.helpers.EpRequirements; +import org.apache.streampipes.sdk.helpers.Labels; +import org.apache.streampipes.sdk.helpers.Locales; +import org.apache.streampipes.sdk.helpers.Options; +import org.apache.streampipes.wrapper.params.compat.SinkParams; +import org.apache.streampipes.wrapper.standalone.StreamPipesDataSink; + +import com.google.gson.Gson; +import com.google.gson.JsonObject; +import io.milvus.param.Constant; +import io.milvus.pool.MilvusClientV2Pool; +import io.milvus.pool.PoolConfig; +import io.milvus.v2.client.ConnectConfig; +import io.milvus.v2.client.MilvusClientV2; +import io.milvus.v2.common.DataType; +import io.milvus.v2.common.IndexParam; +import io.milvus.v2.service.collection.request.AddFieldReq; +import io.milvus.v2.service.collection.request.CreateCollectionReq; +import io.milvus.v2.service.collection.request.DescribeCollectionReq; +import io.milvus.v2.service.collection.request.HasCollectionReq; +import io.milvus.v2.service.collection.response.DescribeCollectionResp; +import io.milvus.v2.service.database.request.CreateDatabaseReq; +import io.milvus.v2.service.vector.request.InsertReq; + +import java.time.Duration; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class MilvusSink extends StreamPipesDataSink { + public static final String MILVUS_URI_KEY = "milvus_uri"; + public static final String MILVUS_TOKEN_KEY = "milvus_token"; + + public static final String MILVUS_DBNAME_KEY = "milvus_dbname"; + public static final String DATABASE_REPLICA_NUMBER_KEY = "database_replica_number"; + + public static final String COLLECTION_NAME_KEY = "collection_name"; + + public static final String VECTOR_KEY = "vector"; + public static final String DIMENSION = "dimension"; + public static final String METRIC_TYPE = "metric_type"; + + public static final String INDEX = "index"; + + public static final String PRIMARY = "primary"; + + public DataType vectorDataType; + + public final Gson gson = new Gson(); + + public MilvusClientV2Pool pool; + public MilvusClientV2 client; + String vector; + String primary; + String collectionName; + Integer dimension; + IndexParam.MetricType metricType; + IndexParam indexParam; + CreateCollectionReq.CollectionSchema collectionSchema; + + public static final String BYTE = "http://www.w3.org/2001/XMLSchema#byte";; + public static final String SHORT = "http://www.w3.org/2001/XMLSchema#short";; + public static final String LONG = "http://www.w3.org/2001/XMLSchema#long";; + public static final String INT = "http://www.w3.org/2001/XMLSchema#integer";; + public static final String FLOAT = "http://www.w3.org/2001/XMLSchema#float";; + public static final String DOUBLE = "http://www.w3.org/2001/XMLSchema#double";; + public static final String BOOLEAN = "http://www.w3.org/2001/XMLSchema#boolean";; + public static final String STRING = "http://www.w3.org/2001/XMLSchema#string";; + + + private static final Map<String, DataType> INDEX_MAP = new HashMap<>() { + { + put("BinaryVector", DataType.BinaryVector); + put("FloatVector", DataType.FloatVector); + } + }; + + private static final Map<String, IndexParam.MetricType> METRIC_TYPE_MAP = new HashMap<>() { + { + put("L2", IndexParam.MetricType.L2); + put("IP", IndexParam.MetricType.IP); + put("COSINE", IndexParam.MetricType.COSINE); + put("HAMMING", IndexParam.MetricType.HAMMING); + put("JACCARD", IndexParam.MetricType.JACCARD); + put("BM25", IndexParam.MetricType.BM25); + } + }; + + @Override + public DataSinkDescription declareModel() { + return DataSinkBuilder + .create("org.apache.streampipes.sinks.databases.jvm.milvus", 0) + .withLocales(Locales.EN) + .withAssets(ExtensionAssetType.DOCUMENTATION, ExtensionAssetType.ICON). + category(DataSinkType.DATABASE) + .requiredTextParameter(Labels.withId(MILVUS_URI_KEY)) + .requiredTextParameter(Labels.withId(MILVUS_TOKEN_KEY), "root:Milvus") + .requiredTextParameter(Labels.withId(MILVUS_DBNAME_KEY)) + .requiredTextParameter(Labels.withId(DATABASE_REPLICA_NUMBER_KEY), "2") + .requiredTextParameter(Labels.withId(COLLECTION_NAME_KEY)) + .requiredTextParameter(Labels.withId(PRIMARY), "id") + .requiredIntegerParameter(Labels.withId(DIMENSION), 2) + .requiredStream(StreamRequirementsBuilder + .create() + .requiredPropertyWithUnaryMapping(EpRequirements.anyProperty(), + Labels.withId(VECTOR_KEY), + PropertyScope.NONE) + .build()) + .requiredSingleValueSelection(Labels.withId(INDEX), + Options.from(INDEX_MAP.keySet().toArray(new String[0]))) + .requiredSingleValueSelection(Labels.withId(METRIC_TYPE), + Options.from(METRIC_TYPE_MAP.keySet().toArray(new String[0]))) + .build(); + } + + @Override + public void onInvocation(SinkParams parameters, + EventSinkRuntimeContext runtimeContext) throws SpRuntimeException { + var extractor = parameters.extractor(); + final String uri = extractor.singleValueParameter(MILVUS_URI_KEY, String.class); + final String token = extractor.singleValueParameter(MILVUS_TOKEN_KEY, String.class); + + ConnectConfig connectConfig = ConnectConfig.builder() + .uri(uri) + .token(token) + .build(); + + PoolConfig poolConfig = PoolConfig.builder() + .maxIdlePerKey(10) // max idle clients per key + .maxTotalPerKey(20) // max total(idle + active) clients per key + .maxTotal(100) // max total clients for all keys + .maxBlockWaitDuration(Duration.ofSeconds(5L)) // getClient() will wait 5 seconds if no idle client available + .minEvictableIdleDuration(Duration.ofSeconds(10L)) // if number + .build(); + + try { + pool = new MilvusClientV2Pool(poolConfig, connectConfig); + client = pool.getClient("client_name"); + //create a dataBase + final String dbName = parameters.extractor().singleValueParameter(MILVUS_DBNAME_KEY, String.class); + final String dbReplicaNum = + parameters.extractor().singleValueParameter(DATABASE_REPLICA_NUMBER_KEY, String.class); + Map<String, String> properties = new HashMap<>(); + properties.put(Constant.DATABASE_REPLICA_NUMBER, dbReplicaNum); + try { + CreateDatabaseReq createDatabaseReq = CreateDatabaseReq.builder() + .databaseName(dbName) + .properties(properties) + .build(); + client.createDatabase(createDatabaseReq); + client.useDatabase(dbName); + } catch (Exception ignored) { + //todo add log Review Comment: Can you add some logging here? You can throw a `SpRuntimeException` so that any problems when creating the database connection will show up in the UI. -- 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: dev-unsubscr...@streampipes.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
