Package com.hazelcast.vector

Interface VectorCollectionService

All Superinterfaces:
com.hazelcast.internal.services.ManagedService, com.hazelcast.internal.memory.Measurable, com.hazelcast.internal.services.RemoteService
public interface VectorCollectionService extends com.hazelcast.internal.services.ManagedService, com.hazelcast.internal.services.RemoteService, com.hazelcast.internal.memory.Measurable

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    SERVICE_NAME
    service name

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    attachStorage(com.hazelcast.vector.impl.storage.VectorCollectionStorage collectionStorage)
    Attaches previously created storage to the service and makes it visible via getStorage(java.lang.String, int) or getStorageOrNull(java.lang.String, int).
    com.hazelcast.vector.impl.storage.VectorCollectionStorage
    createStorage(String vectorCollectionName, int partitionId)
    Creates VectorCollectionStorage but does not make it visible to others via getStorage(java.lang.String, int) or getStorageOrNull(java.lang.String, int).
    Set<String>
    getAllExistingVectorCollectionNames()
     
    com.hazelcast.vector.impl.query.Searcher
    getSearcher(String vectorCollectionName, com.hazelcast.vector.SearchOptions options)
    Provides searcher instance for given collection and options.
    com.hazelcast.vector.impl.stats.LocalVectorCollectionStatsImpl
    getStatistics(String vectorCollectionName)
    Provides statistics object instance for given vector collection.
    com.hazelcast.vector.impl.storage.VectorCollectionStorage
    getStorage(String vectorCollectionName, int partitionId)
    Returns storage for vector collection partition, creating it if needed
    com.hazelcast.vector.impl.storage.VectorCollectionStorage
    getStorageOrNull(String vectorCollectionName, int partitionId)
    Returns storage for vector collection partition or null if the collection or partition does not exist.
    long
    heapBytesUsed(String vectorCollectionName)
    Returns the estimated number of bytes used on the JVM heap by the designated collection.
    long
    localSize(String vectorCollectionName)
     

    Methods inherited from interface com.hazelcast.internal.services.ManagedService

    init, reset, shutdown

    Methods inherited from interface com.hazelcast.internal.memory.Measurable

    heapBytesUsed

    Methods inherited from interface com.hazelcast.internal.services.RemoteService

    createDistributedObject, createDistributedObject, destroyDistributedObject, destroyDistributedObject

  • Field Details

  • Method Details

    • getStorage

      @Nonnull com.hazelcast.vector.impl.storage.VectorCollectionStorage getStorage(String vectorCollectionName, int partitionId)
      Returns storage for vector collection partition, creating it if needed

    • getStorageOrNull

      @Nullable com.hazelcast.vector.impl.storage.VectorCollectionStorage getStorageOrNull(String vectorCollectionName, int partitionId)
      Returns storage for vector collection partition or null if the collection or partition does not exist.

    • createStorage

      @Nonnull com.hazelcast.vector.impl.storage.VectorCollectionStorage createStorage(String vectorCollectionName, int partitionId)
      Creates VectorCollectionStorage but does not make it visible to others via getStorage(java.lang.String, int) or getStorageOrNull(java.lang.String, int).
      See Also:

    • attachStorage

      void attachStorage(@Nonnull com.hazelcast.vector.impl.storage.VectorCollectionStorage collectionStorage)
      Attaches previously created storage to the service and makes it visible via getStorage(java.lang.String, int) or getStorageOrNull(java.lang.String, int).
      See Also:

    • getSearcher

      @Nonnull com.hazelcast.vector.impl.query.Searcher getSearcher(String vectorCollectionName, com.hazelcast.vector.SearchOptions options)
      Provides searcher instance for given collection and options. This method may reuse the same instance if that is safe.

    • getStatistics

      @Nonnull com.hazelcast.vector.impl.stats.LocalVectorCollectionStatsImpl getStatistics(String vectorCollectionName)
      Provides statistics object instance for given vector collection. The instance is shared by all partitions. This method is intended to be used for updating the statistics. It is cheap but returned object does not have up-to-date on-demand calculated statistics (eg. size of heap usage).

    • heapBytesUsed

      long heapBytesUsed(String vectorCollectionName)
      Returns the estimated number of bytes used on the JVM heap by the designated collection.
      Parameters:
      vectorCollectionName - name of the collection for which heap usage estimation is requested
      Returns:
      estimated number of bytes used on the JVM heap
      See Also:
      • Measurable.heapBytesUsed()

    • localSize

      long localSize(String vectorCollectionName)
      Returns:
      number of entries owned by this member

    • getAllExistingVectorCollectionNames

      @Nonnull Set<String> getAllExistingVectorCollectionNames()
      Returns:
      names of known existing VectorCollections