io.tarantool.driver.metadata.TarantoolMetadataOperations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cartridge-driver Show documentation

Tarantool Cartridge driver for Tarantool versions 1.10+ based on Netty framework

There is a newer version: 0.14.0

package io.tarantool.driver.metadata;

import io.tarantool.driver.exceptions.TarantoolClientException;

import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;

/**
 * Tarantool metadata operations interface (get space by name, get index by name, etc.)
 *
 * @author Alexey Kuzin
 */
public interface TarantoolMetadataOperations {
    /**
     * Refresh metadata cache
     * @return future with empty value for tracking the refresh progress
     * @throws TarantoolClientException if fetching data failed with error
     */
    CompletableFuture refresh() throws TarantoolClientException;

    /**
     * Get metadata for the space specified by name
     * @param spaceName the space name, must not be null or empty
     * @return nullable space metadata wrapped in {@link Optional}
     */
    Optional getSpaceByName(String spaceName);

    /**
     * Get metadata for index from the specified space by name
     * @param spaceId the space ID, must be greater than 0
     * @param indexName index name, must not be null or empty
     * @return nullable index metadata wrapped in {@link Optional}
     */
    Optional getIndexByName(int spaceId, String indexName);

    /**
     * Get metadata for index from the specified space by name
     * @param spaceName the space name, must not be null or empty
     * @param indexName index name, must not be null or empty
     * @return nullable index metadata wrapped in {@link Optional}
     */
    Optional getIndexByName(String spaceName, String indexName);

    /**
     * Get metadata for index from the specified space by index ID
     * @param spaceName the space name, must not be null or empty
     * @param indexId index ID, must not be  must be greater or equal than 0
     * @return nullable index metadata wrapped in {@link Optional}
     */
    Optional getIndexById(String spaceName, int indexId);

    /**
     * Get metadata for index from the specified space by index ID
     * @param spaceId the space ID, must be greater than 0
     * @param indexId index ID, must not be  must be greater or equal than 0
     * @return nullable index metadata wrapped in {@link Optional}
     */
    Optional getIndexById(int spaceId, int indexId);

    /**
     * Get metadata for the space specified by id
     * @param spaceId the space ID, must be greater than 0
     * @return nullable space metadata wrapped in {@link Optional}
     */
    Optional getSpaceById(int spaceId);

    /**
     * Get metadata for all indexes for space specified by id
     * @param spaceId the space ID, must be greater than 0
     * @return nullable map of index names to index metadata wrapped in {@link Optional}
     */
    Optional> getSpaceIndexes(int spaceId);

    /**
     * Get metadata for all indexes for space specified by name
     * @param spaceName the space name, must not be null or empty
     * @return nullable map of index names to index metadata wrapped in {@link Optional}
     */
    Optional> getSpaceIndexes(String spaceName);
}