com.yandex.ydb.jdbc.settings.YdbOperationProperty Maven / Gradle / Ivy

Go to download
package com.yandex.ydb.jdbc.settings;

import java.sql.Connection;
import java.time.Duration;
import java.util.Collection;

import javax.annotation.Nullable;

import com.yandex.ydb.jdbc.impl.QueryType;

public class YdbOperationProperty extends AbstractYdbProperty {
    private static final PropertiesCollector> PROPERTIES = new PropertiesCollector<>();

    public static final YdbOperationProperty JOIN_DURATION =
            new YdbOperationProperty<>(
                    "joinDuration",
                    "Default timeout for all YDB operations",
                    "5m",
                    Duration.class,
                    PropertyConverter.durationValue());

    public static final YdbOperationProperty KEEP_IN_QUERY_CACHE =
            new YdbOperationProperty<>(
                    "keepInQueryCache",
                    "Keep all queries in cache",
                    "false",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty QUERY_TIMEOUT =
            new YdbOperationProperty<>(
                    "queryTimeout",
                    "Default timeout for all YDB data queries, scheme and explain operations",
                    "0s",
                    Duration.class,
                    PropertyConverter.durationValue());

    public static final YdbOperationProperty SCAN_QUERY_TIMEOUT =
            new YdbOperationProperty<>(
                    "scanQueryTimeout",
                    "Default timeout for all YDB scan queries",
                    "1m",
                    Duration.class,
                    PropertyConverter.durationValue());

    public static final YdbOperationProperty FAIL_ON_TRUNCATED_RESULT =
            new YdbOperationProperty<>(
                    "failOnTruncatedResult",
                    "Throw an exception when received truncated result",
                    "true",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty SESSION_TIMEOUT =
            new YdbOperationProperty<>(
                    "sessionTimeout",
                    "Default timeout to create a session",
                    "5s",
                    Duration.class,
                    PropertyConverter.durationValue());

    public static final YdbOperationProperty DEADLINE_TIMEOUT =
            new YdbOperationProperty<>(
                    "deadlineTimeout",
                    "Deadline timeout for all operations",
                    "0s",
                    Duration.class,
                    PropertyConverter.durationValue());

    public static final YdbOperationProperty AUTOCOMMIT =
            new YdbOperationProperty<>(
                    "autoCommit",
                    "Auto commit all operations",
                    "false",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty TRANSACTION_LEVEL =
            new YdbOperationProperty<>(
                    "transactionLevel",
                    "Default transaction isolation level",
                    String.valueOf(Connection.TRANSACTION_SERIALIZABLE),
                    Integer.class,
                    PropertyConverter.integerValue());

    //

    // Some JDBC driver specific options

    public static final YdbOperationProperty AUTO_PREPARED_BATCHES =
            new YdbOperationProperty<>("autoPreparedBatches",
                    "Automatically detect list of tuples or structs in prepared statement and support #addBatch, " +
                            "only when alwaysPrepareDataQuery is true",
                    "true",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty ENFORCE_SQL_V1 =
            new YdbOperationProperty<>("enforceSqlV1",
                    "Enforce SQL v1 grammar by adding --!syntax_v1 in the beginning of each SQL statement",
                    "true",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty ENFORCE_VARIABLE_PREFIX =
            new YdbOperationProperty<>("enforceVariablePrefix",
                    "Enforce variable prefixes, add $ symbol to all named variables when absent",
                    "true",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty CACHE_CONNECTIONS_IN_DRIVER =
            new YdbOperationProperty<>("cacheConnectionsInDriver",
                    "Cache YDB connections in YdbDriver, cached by combination or url and properties",
                    "true",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty DETECT_SQL_OPERATIONS =
            new YdbOperationProperty<>("detectSqlOperations",
                    "Detect and execute SQL operation based on available prefixes in body: " +
                            QueryType.prefixes(),
                    "true",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty ALWAYS_PREPARE_DATAQUERY =
            new YdbOperationProperty<>("alwaysPrepareDataQuery",
                    "Always execute #prepareDataQuery when creating PreparedStatements",
                    "true",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty TRANSFORM_STANDARD_JDBC_QUERIES =
            new YdbOperationProperty<>("transformStandardJdbcQueries",
                    "Make a transformation of standard JDBC queries with '?' symbols into standard YQL with declare",
                    "false",
                    Boolean.class,
                    PropertyConverter.booleanValue());

    public static final YdbOperationProperty TRANSFORMED_JDBC_QUERIES_CACHE =
            new YdbOperationProperty<>("transformedJdbcQueriesCache",
                    "Cache size for transformed JDBC queries, only when transformStandardJdbcQueries is true",
                    "0",
                    Integer.class,
                    PropertyConverter.integerValue());


    protected YdbOperationProperty(String name,
                                   String description,
                                   @Nullable String defaultValue,
                                   Class type,
                                   PropertyConverter converter) {
        super(name, description, defaultValue, type, converter, (op, value) -> {
        });
        PROPERTIES.register(this);
    }

    public static Collection> properties() {
        return PROPERTIES.properties();
    }
}