com.tigrisdata.db.client.TransactionSession Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022 Tigris Data, 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.tigrisdata.db.client;

import com.tigrisdata.db.client.error.TigrisException;
import com.tigrisdata.db.type.TigrisCollectionType;

/** Transaction Session */
public interface TransactionSession {
  /**
   * Return an instance of {@link TransactionTigrisCollection}
   *
   * @param collectionTypeClass Class type of the collection
   * @param  type of the collection that is of type {@link TigrisCollectionType}
   * @return an instance of {@link TransactionTigrisCollection}
   */
   TransactionTigrisCollection getCollection(
      Class collectionTypeClass);

  /**
   * Creates or updates collections under current database in transactional session.
   *
   * @param schema schema of the collection
   * @param collectionOptions collection option
   * @return the instance of {@link CreateOrUpdateCollectionsResponse} from server
   * @throws TigrisException in case of an error.
   */
  CreateOrUpdateCollectionsResponse createOrUpdateCollections(
      TigrisSchema schema, CollectionOptions collectionOptions) throws TigrisException;

  /**
   * Commits the current ongoing transaction
   *
   * @return an instance of {@link CommitTransactionResponse} from server
   * @throws TigrisException in case of an error
   */
  CommitTransactionResponse commit() throws TigrisException;

  /**
   * Rolls back the current ongoing transaction
   *
   * @return an instance of {@link RollbackTransactionResponse} from server
   * @throws TigrisException in case of an error
   */
  RollbackTransactionResponse rollback() throws TigrisException;
}