com.couchbase.transactions.SingleQueryTransactionResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of couchbase-transactions Show documentation

Transaction Support for Couchbase on top of the Java SDK

The newest version!

/*
 * Copyright 2021 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.transactions;

import com.couchbase.client.java.query.QueryResult;
import com.couchbase.transactions.log.TransactionLogger;

/**
 * Contains the result of a single query transaction.
 */
public class SingleQueryTransactionResult {
    private final TransactionLogger log;
    private final QueryResult queryResult;
    private final boolean unstagingComplete;

    public SingleQueryTransactionResult(TransactionLogger log, QueryResult queryResult, boolean unstagingComplete) {
        this.log = log;
        this.queryResult = queryResult;
        this.unstagingComplete = unstagingComplete;
    }

    /**
     * An in-memory log of the transaction.
     */
    public TransactionLogger log() {
        return log;
    }

    /**
     * The result of the query.
     */
    public QueryResult queryResult() {
        return queryResult;
    }

    /**
     * Returns whether all documents were successfully unstaged (committed).
     *
     * This will only return true if the transaction reached the COMMIT point and then went on to reach
     * the COMPLETE point.
     *
     * It will be false for transactions that:
     * - Rolled back
     * - Were read-only
     */
    public boolean unstagingComplete() {
        return unstagingComplete;
    }
}