io.milvus.param.collection.LoadCollectionParam Maven / Gradle / Ivy
Show all versions of milvus-sdk-java Show documentation
/*
* 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 io.milvus.param.collection;
import io.milvus.exception.ParamException;
import io.milvus.param.Constant;
import io.milvus.param.ParamUtils;
import lombok.Getter;
import lombok.NonNull;
import lombok.ToString;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
/**
* Parameters for loadCollection interface.
*/
@Getter
@ToString
public class LoadCollectionParam {
private final String databaseName;
private final String collectionName;
private final boolean syncLoad;
private final long syncLoadWaitingInterval;
private final long syncLoadWaitingTimeout;
private final int replicaNumber;
private final boolean refresh;
private final List resourceGroups;
private final List loadFields;
private final boolean skipLoadDynamicField;
public LoadCollectionParam(@NonNull Builder builder) {
this.databaseName = builder.databaseName;
this.collectionName = builder.collectionName;
this.syncLoad = builder.syncLoad;
this.syncLoadWaitingInterval = builder.syncLoadWaitingInterval;
this.syncLoadWaitingTimeout = builder.syncLoadWaitingTimeout;
this.replicaNumber = builder.replicaNumber;
this.refresh = builder.refresh;
this.resourceGroups = builder.resourceGroups;
this.loadFields = builder.loadFields;
this.skipLoadDynamicField = builder.skipLoadDynamicField;
}
public static Builder newBuilder() {
return new Builder();
}
/**
* Builder for {@link LoadCollectionParam} class.
*/
public static final class Builder {
private String databaseName;
private String collectionName;
// syncLoad:
// Default behavior is sync loading, loadCollection() return after collection finish loading.
private Boolean syncLoad = Boolean.TRUE;
// syncLoadWaitingDuration:
// When syncLoad is ture, loadCollection() will wait until collection finish loading,
// this value control the waiting interval. Unit: millisecond. Default value: 500 milliseconds.
private Long syncLoadWaitingInterval = 500L;
// syncLoadWaitingTimeout:
// When syncLoad is ture, loadCollection() will wait until collection finish loading,
// this value control the waiting timeout. Unit: second. Default value: 60 seconds.
private Long syncLoadWaitingTimeout = 60L;
// replicaNumber:
// The replica number to load
private Integer replicaNumber = 0;
// refresh:
// This flag must be set to FALSE when first time call the loadCollection().
// After loading a collection, call loadCollection() again with refresh=TRUE,
// the server will look for new segments that are not loaded yet and tries to load them up.
private Boolean refresh = Boolean.FALSE;
// resourceGroups:
// Specify the target resource groups to load the replicas.
// If not specified, the replicas will be loaded into the default resource group.
private List resourceGroups = new ArrayList<>();
// loadFields:
// Specify load fields list needed during this load.
// If not specified, all the fields will be loaded.
private List loadFields = new ArrayList<>();
// skipLoadDynamicField:
// Specify whether this load shall skip dynamic schema field.
private Boolean skipLoadDynamicField = Boolean.FALSE;
private Builder() {
}
/**
* Sets the database name. database name can be nil.
*
* @param databaseName database name
* @return Builder
*/
public Builder withDatabaseName(String databaseName) {
this.databaseName = databaseName;
return this;
}
/**
* Sets the collection name. Collection name cannot be empty or null.
*
* @param collectionName collection name
* @return Builder
*/
public Builder withCollectionName(@NonNull String collectionName) {
this.collectionName = collectionName;
return this;
}
/**
* Enable sync mode for load action.
* With sync mode enabled, the client keeps waiting until all segments of the collection successfully loaded.
*
* If sync mode disabled, client returns at once after the loadCollection() is called.
*
* @param syncLoad Boolean.TRUE is sync mode, Boolean.FALSE is not
* @return Builder
*/
public Builder withSyncLoad(@NonNull Boolean syncLoad) {
this.syncLoad = syncLoad;
return this;
}
/**
* Sets waiting interval in sync mode. With sync mode enabled, the client will constantly check collection load state by interval.
* Interval must be greater than zero, and cannot be larger than Constant.MAX_WAITING_LOADING_INTERVAL.
*
* @param milliseconds interval
* @return Builder
* @see Constant
*/
public Builder withSyncLoadWaitingInterval(@NonNull Long milliseconds) {
this.syncLoadWaitingInterval = milliseconds;
return this;
}
/**
* Sets timeout value for the sync mode.
* Timeout value must be greater than zero, and cannot be greater than Constant.MAX_WAITING_LOADING_TIMEOUT.
*
* @param seconds time out value for sync mode
* @return Builder
* @see Constant
*/
public Builder withSyncLoadWaitingTimeout(@NonNull Long seconds) {
this.syncLoadWaitingTimeout = seconds;
return this;
}
/**
* Specify replica number to load, replica number must be greater than 0, default value is 1
*
* @param replicaNumber replica number
* @return Builder
*/
public Builder withReplicaNumber(@NonNull Integer replicaNumber) {
this.replicaNumber = replicaNumber;
return this;
}
/**
* Whether to enable refresh mode.
* Refresh mode renews the segment list of this collection before loading.
* This flag must be set to FALSE when first time call the loadCollection().
* After loading a collection, call loadCollection() again with refresh=TRUE,
* the server will look for new segments that are not loaded yet and tries to load them up.
*
* @param refresh Boolean.TRUE is refresh mode, Boolean.FALSE is not
* @return Builder
*/
public Builder withRefresh(@NonNull Boolean refresh) {
this.refresh = refresh;
return this;
}
/**
* Specify the target resource groups to load the replicas.
* If not specified, the replicas will be loaded into the default resource group.
*
* @param resourceGroups a List of {@link String}
* @return Builder
*/
public Builder withResourceGroups(@NonNull List resourceGroups) {
this.resourceGroups.addAll(resourceGroups);
return this;
}
/**
* Specify load fields list needed during this load.
* If not specified, all the fields will be loaded.
*
* @param loadFields a List of {@link String}
* @return Builder
*/
public Builder withLoadFields(@NonNull List loadFields) {
loadFields.forEach((field)->{
if (!this.loadFields.contains(field)) {
this.loadFields.add(field);
}
});
return this;
}
/**
* Specify load fields list needed during this load. If not specified, all the fields will be loaded.
* Default is False.
*
* @param skip Boolean.TRUE skip dynamic field, Boolean.FALSE is not
* @return Builder
*/
public Builder withSkipLoadDynamicField(@NonNull Boolean skip) {
this.skipLoadDynamicField = skip;
return this;
}
/**
* Verifies parameters and creates a new {@link LoadCollectionParam} instance.
*
* @return {@link LoadCollectionParam}
*/
public LoadCollectionParam build() throws ParamException {
ParamUtils.CheckNullEmptyString(collectionName, "Collection name");
if (Objects.equals(syncLoad, Boolean.TRUE)) {
if (syncLoadWaitingInterval <= 0) {
throw new ParamException("Sync load waiting interval must be larger than zero");
} else if (syncLoadWaitingInterval > Constant.MAX_WAITING_LOADING_INTERVAL) {
throw new ParamException("Sync load waiting interval cannot be larger than "
+ Constant.MAX_WAITING_LOADING_INTERVAL.toString() + " milliseconds");
}
if (syncLoadWaitingTimeout <= 0) {
throw new ParamException("Sync load waiting timeout must be larger than zero");
} else if (syncLoadWaitingTimeout > Constant.MAX_WAITING_LOADING_TIMEOUT) {
throw new ParamException("Sync load waiting timeout cannot be larger than "
+ Constant.MAX_WAITING_LOADING_TIMEOUT.toString() + " seconds");
}
}
if (replicaNumber < 0) {
throw new ParamException("Replica number can't be negative");
}
return new LoadCollectionParam(this);
}
}
}