io.tarantool.driver.proxy.ProxyOperationsMapping 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.proxy;

/**
 * Provides methods for function names in a Tarantool instance or a Tarantool Cartridge role for CRUD operations.
 *
 * @author Sergey Volgin
 */
public interface ProxyOperationsMapping {

    String CRUD_PREFIX = "crud.";
    String SCHEMA_FUNCTION = "cartridge.get_schema";
    String DELETE_FUNCTION = CRUD_PREFIX + "delete";
    String INSERT_FUNCTION = CRUD_PREFIX + "insert";
    String REPLACE_FUNCTION = CRUD_PREFIX + "replace";
    String SELECT_FUNCTION = CRUD_PREFIX + "select";
    String UPDATE_FUNCTION = CRUD_PREFIX + "update";
    String UPSERT_UPSERT = CRUD_PREFIX + "upsert";

    /**
     * Get API function name for getting the spaces and indexes schema. The default value is
     * crud_get_schama.
     *
     * See 
     * the DDL module API for details on the desired schema metadata format.
     *
     * @return a callable API function name
     */
    default String getGetSchemaFunctionName() {
        return SCHEMA_FUNCTION;
    }

    /**
     * Get API function name for performing the delete operation. The default value is crud_delete.
     *
     * @return a callable API function name
     */
    default String getDeleteFunctionName() {
        return DELETE_FUNCTION;
    }

    /**
     * Get API function name for performing the insert operation. The default value is crud_insert.
     *
     * @return a callable API function name
     */
    default String getInsertFunctionName() {
        return INSERT_FUNCTION;
    }

    /**
     * Get API function name for performing the replace operation. The default value is crud_replace.
     *
     * @return a callable API function name
     */
    default String getReplaceFunctionName() {
        return REPLACE_FUNCTION;
    }

    /**
     * Get API function name for performing the select operation. The default value is crud_select.
     *
     * @return a callable API function name
     */
    default String getSelectFunctionName() {
        return SELECT_FUNCTION;
    }

    /**
     * Get API function name for performing the update operation. The default value is crud_update.
     *
     * @return a callable API function name
     */
    default String getUpdateFunctionName() {
        return UPDATE_FUNCTION;
    }

    /**
     * Get API function name for performing the upsert operation. The default value is crud_upsert.
     *
     * @return a callable API function name
     */
    default String getUpsertFunctionName() {
        return UPSERT_UPSERT;
    }
}