com.netflix.astyanax.MutationBatchManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of astyanax-cassandra Show documentation

astyanax-cassandra

There is a newer version: 3.9.0

/**
 * Copyright 2013 Netflix, 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.netflix.astyanax;

import com.netflix.astyanax.connectionpool.exceptions.ConnectionException;

/**
 * The mutation manager enables different recipes or entity managers to use
 * the same mutation for bulk operations.  In addition a mutation manager 
 * can be used to implement write ahead semantics for 'atomic' mutations.
 * 
 * The mutation manager is expected to be thread safe such that all mutations
 * in the same thread go to the same mutation batch.  This also means that
 * getMutationBatch(), the mutations and the final commit() must occur within
 * the same thread.
 * 
 * @author elandau
 *
 */
public interface MutationBatchManager {
    /**
     * Get or create a new mutation batch.
     * 
     * @return
     */
    public MutationBatch getSharedMutationBatch();
    
    /**
     * Get a one time mutation batch
     * @return
     */
    public MutationBatch getNewMutationBatch();
    
    /**
     * Commit all mutations on the batch
     * @throws ConnectionException
     */
    public void commitSharedMutationBatch() throws ConnectionException ;
    
    /**
     * Discard all mutations on the batch
     */
    public void discard();
}