com.hazelcast.config.SqlConfig Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hazelcast-all Show documentation
There is a newer version: 5.0-BETA-1
/*
 * Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hazelcast.config;

import com.hazelcast.sql.SqlStatement;

import java.util.Objects;

import static com.hazelcast.internal.util.Preconditions.checkNotNegative;
import static com.hazelcast.internal.util.Preconditions.checkPositive;

/**
 * SQL service configuration.
 */
public class SqlConfig {
    /** Default number of threads responsible for execution of SQL statements. */
    public static final int DEFAULT_EXECUTOR_POOL_SIZE = -1;

    /** Default timeout in milliseconds that is applied to statements without explicit timeout. */
    public static final int DEFAULT_STATEMENT_TIMEOUT_MILLIS = 0;

    /** Number of threads responsible for execution of SQL statements. */
    private int executorPoolSize = DEFAULT_EXECUTOR_POOL_SIZE;

    /** Timeout in milliseconds that is applied to statements without an explicit timeout. */
    private long statementTimeoutMillis = DEFAULT_STATEMENT_TIMEOUT_MILLIS;

    /**
     * Gets the number of threads responsible for execution of SQL statements.
     *
     * @return number of threads responsible for execution of SQL statements
     */
    public int getExecutorPoolSize() {
        return executorPoolSize;
    }

    /**
     * Sets the number of threads responsible for execution of SQL statements.
     * 
     * The default value {@code -1} sets the pool size equal to the number of CPU cores, and should be good enough
     * for most workloads.
     * 

     * Setting the value to less than the number of CPU cores will limit the degree of parallelism of the SQL subsystem. This
     * may be beneficial if you would like to prioritize other CPU-intensive workloads on the same machine.
     * 

     * It is not recommended to set the value of this parameter higher than the number of CPU cores because it may decrease
     * the system's overall performance due to excessive context switches.
     * 

     * Defaults to {@code -1}.
     *
     * @param executorPoolSize number of threads responsible for execution of SQL statements
     * @return this instance for chaining
     */
    public SqlConfig setExecutorPoolSize(int executorPoolSize) {
        if (executorPoolSize < DEFAULT_EXECUTOR_POOL_SIZE || executorPoolSize == 0) {
            checkPositive(executorPoolSize, "Executor pool size should be positive or -1: " + executorPoolSize);
        }

        this.executorPoolSize = executorPoolSize;

        return this;
    }

    /**
     * Gets the timeout in milliseconds that is applied to statements without an explicit timeout.
     *
     * @return timeout in milliseconds
     */
    public long getStatementTimeoutMillis() {
        return statementTimeoutMillis;
    }

    /**
     * Sets the timeout in milliseconds that is applied to statements without an explicit timeout.
     * 

     * It is possible to set a timeout through the {@link SqlStatement#setTimeoutMillis(long)} method. If the statement
     * timeout is not set, then the value of this parameter will be used.
     * 

     * Zero value means no timeout. Negative values are prohibited.
     * 
     * Defaults to {@link #DEFAULT_STATEMENT_TIMEOUT_MILLIS}.
     *
     * @see SqlStatement#setTimeoutMillis(long)
     * @param statementTimeoutMillis timeout in milliseconds
     * @return this instance for chaining
     */
    public SqlConfig setStatementTimeoutMillis(long statementTimeoutMillis) {
        checkNotNegative(statementTimeoutMillis, "Timeout cannot be negative");

        this.statementTimeoutMillis = statementTimeoutMillis;

        return this;
    }

    @Override
    public String toString() {
        return "SqlConfig{"
            + "executorPoolSize=" + executorPoolSize
            + ", statementTimeoutMillis=" + statementTimeoutMillis
            + '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        SqlConfig sqlConfig = (SqlConfig) o;
        return executorPoolSize == sqlConfig.executorPoolSize && statementTimeoutMillis == sqlConfig.statementTimeoutMillis;
    }

    @Override
    public int hashCode() {
        return Objects.hash(executorPoolSize, statementTimeoutMillis);
    }
}