com.tigrisdata.db.client.TigrisDatabase 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;

import java.util.List;
import java.util.Optional;
import java.util.function.Predicate;

/** TigrisDB Database */
public interface TigrisDatabase {

  /**
   * Return list of collection info
   *
   * @return list of {@link CollectionInfo}
   * @throws TigrisException in case of an error.
   */
  List listCollections() throws TigrisException;

  /**
   * Creates or updates collections
   *
   * @param collectionModelTypes an array of collection model classes
   * @return response
   * @throws TigrisException in case of an error.
   */
  CreateOrUpdateCollectionsResponse createOrUpdateCollections(
      Class... collectionModelTypes) throws TigrisException;

  /**
   * Creates or updates collections by scanning classpath packages and applying user's filter
   * (optionally) The alternate method {@link TigrisDatabase#createOrUpdateCollections(Class[])} is
   * recommended where user specifies fixed list of classes to avoid classpath scan at runtime.
   *
   * @param packagesToScan an array of Java packages to scan for collection model.
   * @param filter optional filter to filter out classes from scanned set of classes
   * @return response
   * @throws TigrisException in case of an error.
   */
  CreateOrUpdateCollectionsResponse createOrUpdateCollections(
      String[] packagesToScan, Optional>> filter)
      throws TigrisException;

  /**
   * Drops the collection.
   *
   * @param collectionName name of the collection
   * @return the instance of {@link DropCollectionResponse} from server
   * @throws TigrisException in case of an error.
   */
  DropCollectionResponse dropCollection(String collectionName) throws TigrisException;

  /**
   * Return an instance of {@link TigrisCollection}
   *
   * @param collectionTypeClass Class type of the collection
   * @param  type of the collection that is of type {@link TigrisCollectionType}
   * @return an instance of {@link TigrisCollection}
   */
   TigrisCollection getCollection(Class collectionTypeClass);

  /**
   * Begins the transaction on current database
   *
   * @param transactionOptions options
   * @return transaction aware instance of {@link TransactionSession}
   * @throws TigrisException in case of an error
   */
  TransactionSession beginTransaction(TransactionOptions transactionOptions) throws TigrisException;

  /**
   * @return description of database and its collections.
   * @throws TigrisException in case of an error.
   */
  DatabaseDescription describe() throws TigrisException;

  /** @return name of the current database */
  String name();
}