com.yugabyte.data.jdbc.core.YsqlOperations Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-yugabytedb-ysql Show documentation
Spring Data support for YugabyteDB YSQL.
The newest version!
/*
 * Copyright (c) Yugabyte, 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.yugabyte.data.jdbc.core;

import java.sql.SQLException;

import org.springframework.data.jdbc.core.JdbcAggregateOperations;

/**
 * Specifies Database operations one can perform on YugabyteDB Distributed SQL, 
 * based on an Domain Type.
 *
 * @author Nikhil Chandrappa
 */
public interface YsqlOperations extends JdbcAggregateOperations {
	
	/**
	 * Counts the number of objects of a given type.
	 * 
	 * Method uses below transaction isolation level for count(*) queries, 
	 * Transaction BEGIN ISOLATION LEVEL SERIALIZABLE READ ONLY DEFERRABLE 
	 * 
	 * @param domainType the type of the aggregates to be counted.
	 * @return the number of instances stored in the YugabyteDB cluster. Guaranteed to be not {@code null}.
	 */
	long count(Class domainType, QueryOptions queryOptions) throws SQLException;

//	/**
//	 * Load an aggregate from the database.
//	 *
//	 * @param id the id of the domain to load. Must not be {@code null}.
//	 * @param domainType the type of the aggregate root. Must not be {@code null}.
//	 * @param  the type of the aggregate root.
//	 * @param determines whether data can be read from follower copies.
//	 * @return the loaded aggregate. Might return {@code null}.
//	 */
//	@Nullable
//	 T findById(Object id, Class domainType, Boolean readFromFollower);
//
//	/**
//	 * Load all aggregates of a given type that are identified by the given ids.
//	 *
//	 * @param ids of the aggregate roots identifying the aggregates to load. Must not be {@code null}.
//	 * @param domainType the type of the aggregate roots. Must not be {@code null}.
//	 * @param  the type of the aggregate roots. Must not be {@code null}.
//	 * @param determines whether data can be read from follower copies.
//	 * @return Guaranteed to be not {@code null}.
//	 */
//	 Iterable findAllById(Iterable ids, Class domainType, Boolean readFromFollower);
//
//	/**
//	 * Load all aggregates of a given type.
//	 *
//	 * @param domainType the type of the aggregate roots. Must not be {@code null}.
//	 * @param  the type of the aggregate roots. Must not be {@code null}.
//	 * @param determines whether data can be read from follower copies.
//	 * @return Guaranteed to be not {@code null}.
//	 */
//	 Iterable findAll(Class domainType, Boolean readFromFollower);
//
//	/**
//	 * Load all aggregates of a given type, sorted.
//	 *
//	 * @param domainType the type of the aggregate roots. Must not be {@code null}.
//	 * @param  the type of the aggregate roots. Must not be {@code null}.
//	 * @param sort the sorting information. Must not be {@code null}.
//	 * @param determines whether data can be read from follower copies.
//	 * @return Guaranteed to be not {@code null}.
//	 * @since 2.0
//	 */
//	 Iterable findAll(Class domainType, Sort sort, Boolean readFromFollower);
//
//	/**
//	 * Load a page of (potentially sorted) aggregates of a given type.
//	 *
//	 * @param domainType the type of the aggregate roots. Must not be {@code null}.
//	 * @param  the type of the aggregate roots. Must not be {@code null}.
//	 * @param pageable the pagination information. Must not be {@code null}.
//	 * @param determines whether data can be read from follower copies.
//	 * @return Guaranteed to be not {@code null}.
//	 * @since 2.0
//	 */
//	 Page findAll(Class domainType, Pageable pageable, Boolean readFromFollower);

}