upsert()
A MilvusClient interface. This method inserts new entities into a specified collection, and replaces them if the entities already exist.
R<MutationResult> upsert(UpsertParam requestParam);
UpsertParam
Use the UpsertParam.Builder
to construct an UpsertParam object
.
import io.milvus.param.UpsertParam;
UpsertParam.Builder builder = UpsertParam.newBuilder();
Methods of UpsertParam.Builder
:
Method |
Description |
Parameters |
---|---|---|
withCollectionName(String collectionName) |
Sets the target collection name. Collection name cannot be empty or null. |
collectionName: The name of the collection to insert data into. |
withDatabaseName(String databaseName) |
Sets the database name. database name can be null for default database. |
databaseName: The database name. |
withPartitionName(String partitionName) |
Sets the target partition name(optional). |
partitionName: The name of the partition to insert data into. |
withFields(List<InsertParam.Field> fields) |
Sets the column-based data to be inserted. The fields list cannot be empty. |
fields: A list of Field objects, each representing a field. |
withRows(List<gson.JsonObject> rows) |
Sets the row-based data to be inserted. The row list cannot be empty. |
rows: A list of gson.JsonObject objects, each representing a row in key-value format. |
build() |
Constructs an InsertParam object. |
N/A |
notes
In Java SDK versions v2.3.7 or earlier versions, the input is a fastjson.JSONObject
. But fastjson
is not recommended to use now because of its unsafe deserialization vulnerability. Therefore, replace fastjson
with gson
if you use the Java SDK of v2.3.8 or later releases.
The UpsertParam.Builder.build()
can throw the following exceptions:
- ParamException: error if the parameter is invalid.
Returns
This method catches all the exceptions and returns an R<MutationResult>
object.
If the API fails on the server side, it returns the error code and message from the server.
If the API fails by RPC exception, it returns
R.Status.Unknown
and the error message of the exception.If the API succeeds, it returns a valid
MutationResult
held by theR
template. You can useMutationResultWrapper
to get the returned information.
Example
import io.milvus.param.*;
import io.milvus.response.MutationResultWrapper;
import io.milvus.grpc.MutationResult;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
List<List<Float>> vectors = generateFloatVectors(1);
List<JsonObject> rows = new ArrayList<>();
JsonObject row = new JsonObject();
row.addProperty("id", (long)i);
row.add("vector", gson.toJsonTree(vectors.get(0)));
rows.add(row);
UpsertParam param = UpsertParam.newBuilder()
.withCollectionName(COLLECTION_NAME)
.withRows(rows)
.build();
R<MutationResult> response = client.upsert(param);
if (response.getStatus() != R.Status.Success.getCode()) {
System.out.println(response.getMessage());
}
MutationResultWrapper wrapper = new MutationResultWrapper(response.getData());
System.out.println(wrapper.getInsertCount() + " rows upserted");