com.github.helenusdriver.driver.Batch Maven / Gradle / Ivy
Show all versions of api Show documentation
/*
* Copyright (C) 2015-2015 The Helenus Driver Project Authors.
*
* 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.github.helenusdriver.driver;
import com.google.common.util.concurrent.AbstractFuture;
import com.google.common.util.concurrent.ListenableFuture;
/**
* The Batch interface extends the functionality of Cassandra's
* {@link com.datastax.driver.core.querybuilder.Batch} class to provide
* support for POJOs.
*
* @copyright 2015-2015 The Helenus Driver Project Authors
*
* @author The Helenus Driver Project Authors
* @version 1 - Jan 15, 2015 - paouelle - Creation
*
* @since 1.0
*/
public interface Batch
extends Statement, BatchableStatement {
/**
* Holds the max size of the batch after which we should be committing it to
* Cassandra while processing the CSV file.
*
* Note: With regard to a large number of records in a batch mutation
* there are some potential issues. Each row becomes a task in the write
* thread pool on each Cassandra replica. If a single client sends 1,000 rows
* in a mutation it will take time for the (default) 32 threads in the write
* pool to work through the mutations. While they are doing this other
* clients/requests will appear to be starved/stalled. There are also issues
* with the max message size in thrift and cql over thrift.
*
* As a rule of thumb don't go over a few hundred if you have a high number of
* concurrent writers.
*
* @author paouelle
*/
public final static int RECOMMENDED_MAX = 100;
/**
* {@inheritDoc}
*
* Gets the keyspace of the first statement in this batch.
*
* @author paouelle
*
* @return the keyspace from the first statement in this batch or
* null if the batch is empty
*
* @see com.github.helenusdriver.driver.GenericStatement#getKeyspace()
*/
@Override
public String getKeyspace();
/**
* Checks if the batch has no statements added.
*
* @author paouelle
*
* @return true if no statements were added to the batch;
* false otherwise
*/
public boolean isEmpty();
/**
* Checks the this batch has reached the recommended size for a batch in
* system with a high number of concurrent writers.
*
* @author paouelle
*
* @return true if the recommended size has been reached or
* exceeded for this batch; false otherwise
*/
public boolean hasReachedRecommendedSize();
/**
* Gets the number of statements that are part of this batch (recursively).
*
* @author paouelle
*
* @return the number of statements in this batch
*/
public int size();
/**
* Removes all statements already added to this batch.
*
* @author paouelle
*/
public void clear();
/**
* Adds a new statement to this batch.
*
* @author paouelle
*
* @param The type of result returned when executing the statement to batch
* @param The type of future result returned when executing the statement
* to batch
*
* @param statement the new statement to add
* @return this batch
* @throws NullPointerException if statement is null
* @throws IllegalArgumentException if counter and non-counter operations
* are mixed or if the statement represents a "select" statement or a
* "batch" statement
*/
public > Batch add(BatchableStatement statement);
/**
* Adds a new raw Cassandra statement to this batch.
*
* @author paouelle
*
* @param statement the new statement to add
* @return this batch
* @throws NullPointerException if statement is null
* @throws IllegalArgumentException if counter and non-counter operations
* are mixed or if the statement represents a "select" statement or a
* "batch" statement or if the statement is not of a supported class
*/
public Batch add(com.datastax.driver.core.RegularStatement statement);
/**
* Adds a new options for this BATCH statement.
*
* @author paouelle
*
* @param using the option to add
* @return the options of this BATCH statement
*/
public Options using(Using using);
/**
* Duplicates this batch statement.
*
* @author paouelle
*
* @return a new batch statement which is a duplicate of this one
*/
public Batch duplicate();
/**
* The Options interface defines the options of a BATCH statement.
*
* @copyright 2015-2015 The Helenus Driver Project Authors
*
* @author The Helenus Driver Project Authors
* @version 1 - Jan 15, 2015 - paouelle - Creation
*
* @since 1.0
*/
public interface Options
extends GenericStatement, BatchableStatement {
/**
* Adds the provided option.
*
* Note: The primary key and mandatory columns are always added to the
* BATCH statement.
*
* @author paouelle
*
* @param using a BATCH option
* @return this {@code Options} object
*/
public Options and(Using using);
/**
* Adds a new statement to the BATCH statement these options are part of.
*
* @author paouelle
*
* @param The type of result returned when executing the statement to batch
* @param The type of future result returned when executing the statement
* to batch
*
* @param statement the new statement to add
* @return this batch
* @throws NullPointerException if statement is null
* @throws IllegalArgumentException if counter and non-counter operations
* are mixed or if the statement represents a "select" statement or a
* "batch" statement or if the statement is not of a supported class
*/
public > Batch add(BatchableStatement statement);
/**
* Adds a new raw Cassandra statement to the BATCH statement these options
* are part of.
*
* @author paouelle
*
* @param statement the new statement to add
* @return this batch
* @throws NullPointerException if statement is null
* @throws IllegalArgumentException if counter and non-counter operations
* are mixed or if the statement represents a "select" statement or a
* "batch" statement
*/
public Batch add(com.datastax.driver.core.RegularStatement statement);
}
}