<?php

/**
 * Copyright 2014-Present 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.
 */

declare(strict_types=1);

namespace Couchbase;

class TransactionsQueryConfiguration
{
    private ?string $scanConsistency = null;

    /**
     * Specifies the default scan consistency level for queries.
     *
     * @param string $level
     *
     * @return TransactionsQueryConfiguration
     * @see QueryScanConsistency::REQUEST_PLUS
     * @see QueryScanConsistency::NOT_BOUNDED
     * @since 4.0.0
     */
    public function scanConsistency(string $level): TransactionsQueryConfiguration
    {
        $this->scanConsistency = $level;
        return $this;
    }

    /**
     * @return array
     * @internal
     * @since 4.0.0
     */
    public function export(): array
    {
        return [
            'scanConsistency' => $this->scanConsistency,
        ];
    }
}
