io.tarantool.driver.api.metadata.TarantoolIndexPartMetadata 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.api.metadata;

/**
 * Represents Tarantool index part metadata
 *
 * @author Sergey Volgin
 */
public interface TarantoolIndexPartMetadata {
    /**
     * Get field index in space format
     *
     * @return field index starts with 0
     */
    int getFieldIndex();

    /**
     * Get field type
     *
     * @return field type
     */
    String getFieldType();

    /**
     * Get path inside field (for "JSON-path" indexes)
     *
     * @return path inside field (may be null)
     */
    T getPath();
}