com.couchbase.client.java.transactions.config.TransactionsQueryConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
The official Couchbase Java SDK
There is a newer version: 3.7.6
/*
 * Copyright 2022 Couchbase, Inc.
 *
 * 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.couchbase.client.java.transactions.config;

import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.java.query.QueryScanConsistency;

import java.util.Optional;
import java.util.function.Consumer;

import static com.couchbase.client.core.util.Validators.notNull;

/**
 * Allows setting a default query configuration for all transactions.
 */
public class TransactionsQueryConfig {
    private TransactionsQueryConfig() {}

    /**
     * Returns a new TransactionsQueryConfig.Builder.
     *
     * @deprecated Instead of creating a new builder, please use
     * {@link TransactionsConfig.Builder#queryConfig(Consumer)}
     * and configure the builder passed to the consumer.
     */
    @Deprecated
    public static TransactionsQueryConfig.Builder builder() {
        return new TransactionsQueryConfig.Builder();
    }

    /**
     * Customizes the default consistency guarantees for all queries inside this transaction.
     * 
     * Tuning the scan consistency allows to trade data "freshness" for latency and vice versa. By default
     * {@link QueryScanConsistency#REQUEST_PLUS} is used for any queries inside a transaction, which means that the
     * indexer will wait until any indexes used are consistent with all mutations at the time of the query.
     * If this level of consistency is not required, use {@link QueryScanConsistency#NOT_BOUNDED} which will execute
     * the query immediately with whatever data are in the index.
     * 

     * @param scanConsistency the index scan consistency to be used.
     * @return a builder with the value set
     * @deprecated Instead of creating a new builder, please use
     * {@link TransactionsConfig.Builder#queryConfig(Consumer)}
     * and configure the builder passed to the consumer.
     */
    @Deprecated
    public static Builder scanConsistency(QueryScanConsistency scanConsistency) {
        return builder().scanConsistency(scanConsistency);
    }

    public static class Builder {
        private Optional scanConsistency = Optional.empty();

        /**
         * Customizes the default consistency guarantees for all queries inside this transaction.
         * 

         * Tuning the scan consistency allows to trade data "freshness" for latency and vice versa. By default
         * {@link QueryScanConsistency#REQUEST_PLUS} is used for any queries inside a transaction, which means that the
         * indexer will wait until any indexes used are consistent with all mutations at the time of the query.
         * If this level of consistency is not required, use {@link QueryScanConsistency#NOT_BOUNDED} which will execute
         * the query immediately with whatever data are in the index.
         * 
         * @param scanConsistency the index scan consistency to be used.
         * @return this, for chaining purposes.
         */
        public Builder scanConsistency(QueryScanConsistency scanConsistency) {
            notNull(scanConsistency, "scanConsistency");
            this.scanConsistency = Optional.of(scanConsistency);
            return this;
        }

        @Stability.Internal
        Optional scanConsistency() {
            return scanConsistency;
        }
    }
}