io.tarantool.driver.protocol.TarantoolIndexQueryFactory 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.protocol;

import io.tarantool.driver.exceptions.TarantoolClientException;
import io.tarantool.driver.exceptions.TarantoolIndexNotFoundException;
import io.tarantool.driver.metadata.TarantoolIndexMetadata;
import io.tarantool.driver.metadata.TarantoolMetadataOperations;

import java.util.Optional;

/**
 * A factory for index query used in select request and other requests to Tarantool server
 *
 * @author Alexey Kuzin
 */
public class TarantoolIndexQueryFactory {

    private final TarantoolMetadataOperations metadataOperations;

    /**
     * Basic constructor.
     * @param metadataOperations a configured {@link TarantoolMetadataOperations} instance
     */
    public TarantoolIndexQueryFactory(TarantoolMetadataOperations metadataOperations) {
        this.metadataOperations = metadataOperations;
    }

    /**
     * Create a query for primary index
     * @return new {@link TarantoolIndexQuery} instance
     */
    public TarantoolIndexQuery primary() {
        return new TarantoolIndexQuery();
    }

    /**
     * Create a query for index by its name
     * @param spaceId ID of Tarantool space
     * @param indexName the index name
     * @return new {@link TarantoolIndexQuery} instance
     * @throws TarantoolClientException if failed to retrieve metadata from the Tarantool server
     */
    public TarantoolIndexQuery byName(int spaceId, String indexName) throws TarantoolClientException {
        Optional meta = metadataOperations.getIndexByName(spaceId, indexName);
        if (!meta.isPresent()) {
            throw new TarantoolIndexNotFoundException(spaceId, indexName);
        }
        return new TarantoolIndexQuery(meta.get().getIndexId());
    }

    /**
     * Create a query for index by its name
     *
     * @param spaceName name of Tarantool space
     * @param indexName the index name
     * @return new {@link TarantoolIndexQuery} instance
     * @throws TarantoolClientException if failed to retrieve metadata from the Tarantool cluster
     */
    public TarantoolIndexQuery byName(String spaceName, String indexName)
            throws TarantoolClientException {
        Optional meta = metadataOperations.getIndexByName(spaceName, indexName);
        if (!meta.isPresent()) {
            throw new TarantoolIndexNotFoundException(spaceName, indexName);
        }
        return new TarantoolIndexQuery(meta.get().getIndexId());
    }
}