Package io.milvus.param.collection

Class LoadCollectionParam.Builder

    • Method Detail

      • withDatabaseName

        public LoadCollectionParam.Builder withDatabaseName​(String databaseName)
        Sets the database name. database name can be nil.
        Parameters:
        databaseName - database name
        Returns:
        Builder

      • withCollectionName

        public LoadCollectionParam.Builder withCollectionName​(String collectionName)
        Sets the collection name. Collection name cannot be empty or null.
        Parameters:
        collectionName - collection name
        Returns:
        Builder

      • withSyncLoad

        public LoadCollectionParam.Builder withSyncLoad​(Boolean syncLoad)
        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.

        Parameters:
        syncLoad - Boolean.TRUE is sync mode, Boolean.FALSE is not
        Returns:
        Builder

      • withSyncLoadWaitingInterval

        public LoadCollectionParam.Builder withSyncLoadWaitingInterval​(Long milliseconds)
        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.
        Parameters:
        milliseconds - interval
        Returns:
        Builder
        See Also:
        Constant

      • withSyncLoadWaitingTimeout

        public LoadCollectionParam.Builder withSyncLoadWaitingTimeout​(Long seconds)
        Sets timeout value for the sync mode. Timeout value must be greater than zero, and cannot be greater than Constant.MAX_WAITING_LOADING_TIMEOUT.
        Parameters:
        seconds - time out value for sync mode
        Returns:
        Builder
        See Also:
        Constant

      • withReplicaNumber

        public LoadCollectionParam.Builder withReplicaNumber​(Integer replicaNumber)
        Specify replica number to load, replica number must be greater than 0, default value is 1
        Parameters:
        replicaNumber - replica number
        Returns:
        Builder

      • withRefresh

        public LoadCollectionParam.Builder withRefresh​(Boolean refresh)
        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.
        Parameters:
        refresh - Boolean.TRUE is refresh mode, Boolean.FALSE is not
        Returns:
        Builder

      • withResourceGroups

        public LoadCollectionParam.Builder withResourceGroups​(List<String> resourceGroups)
        Specify the target resource groups to load the replicas. If not specified, the replicas will be loaded into the default resource group.
        Parameters:
        resourceGroups - a List of String
        Returns:
        Builder

      • withLoadFields

        public LoadCollectionParam.Builder withLoadFields​(List<String> loadFields)
        Specify load fields list needed during this load. If not specified, all the fields will be loaded.
        Parameters:
        loadFields - a List of String
        Returns:
        Builder

      • withSkipLoadDynamicField

        public LoadCollectionParam.Builder withSkipLoadDynamicField​(Boolean skip)
        Specify load fields list needed during this load. If not specified, all the fields will be loaded. Default is False.
        Parameters:
        skip - Boolean.TRUE skip dynamic field, Boolean.FALSE is not
        Returns:
        Builder