org.jnosql.diana.cassandra.column.CassandraColumnFamilyManagerAsync Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-driver Show documentation
The Eclipse JNoSQL communication layer, Diana, to Cassandra
There is a newer version: 0.0.9
/*
 *  Copyright (c) 2017 Otávio Santana and others
 *   All rights reserved. This program and the accompanying materials
 *   are made available under the terms of the Eclipse Public License v1.0
 *   and Apache License v2.0 which accompanies this distribution.
 *   The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 *   and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
 *
 *   You may elect to redistribute this code under either of these licenses.
 *
 *   Contributors:
 *
 *   Otavio Santana
 */
package org.jnosql.diana.cassandra.column;


import com.datastax.driver.core.ConsistencyLevel;
import com.datastax.driver.core.Statement;
import org.jnosql.diana.api.ExecuteAsyncQueryException;
import org.jnosql.diana.api.column.ColumnDeleteQuery;
import org.jnosql.diana.api.column.ColumnEntity;
import org.jnosql.diana.api.column.ColumnFamilyManagerAsync;
import org.jnosql.diana.api.column.ColumnQuery;

import java.time.Duration;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;

/**
 * The implementation of {@link ColumnFamilyManagerAsync} whose implements all methods and also has support to CQL and
 * consistencyLevel.
 * {@link CassandraColumnFamilyManagerAsync#save(ColumnEntity, ConsistencyLevel)}
 * {@link CassandraColumnFamilyManagerAsync#save(ColumnEntity, Duration, ConsistencyLevel)}
 * {@link CassandraColumnFamilyManagerAsync#delete(ColumnDeleteQuery, ConsistencyLevel)}
 * {@link CassandraColumnFamilyManagerAsync#delete(ColumnDeleteQuery, ConsistencyLevel, Consumer)}
 * {@link CassandraColumnFamilyManagerAsync#cql(String, Consumer)}
 * {@link CassandraColumnFamilyManagerAsync#select(ColumnQuery, ConsistencyLevel, Consumer)}
 */
public interface CassandraColumnFamilyManagerAsync extends ColumnFamilyManagerAsync {


    /**
     * Save the entity with ConsistencyLevel
     *
     * @param entity the entity
     * @param level  {@link ConsistencyLevel}
     */
    void save(ColumnEntity entity, ConsistencyLevel level) throws ExecuteAsyncQueryException, UnsupportedOperationException;

    /**
     * Save the entity with ConsistencyLevel
     *
     * @param entities the entities
     * @param level    {@link ConsistencyLevel}
     */
    void save(Iterable entities, ConsistencyLevel level) throws ExecuteAsyncQueryException, UnsupportedOperationException;

    /**
     * Save the entity with ConsistencyLevel
     *
     * @param callBack the callback
     * @param entity   the entity
     * @param level    {@link ConsistencyLevel}
     * @throws ExecuteAsyncQueryException when there is async error
     */
    void save(ColumnEntity entity, ConsistencyLevel level, Consumer callBack) throws ExecuteAsyncQueryException;


    /**
     * Saves the entity with ConsistencyLevel
     *
     * @param entity the entity
     * @param ttl    the ttl
     * @param level  {@link ConsistencyLevel}
     * @throws ExecuteAsyncQueryException when there is async error
     */
    void save(ColumnEntity entity, Duration ttl, ConsistencyLevel level) throws ExecuteAsyncQueryException;

    /**
     * Saves the entity with ConsistencyLevel
     *
     * @param callBack the callBack
     * @param entity   the entity
     * @param ttl      the ttl
     * @param level    {@link ConsistencyLevel}
     * @throws ExecuteAsyncQueryException  when there is async error
     */
    void save(ColumnEntity entity, Duration ttl, ConsistencyLevel level, Consumer callBack) throws ExecuteAsyncQueryException;

    /**
     * Saves the entity with ConsistencyLevel
     *
     * @param entities the entities
     * @param ttl      the ttl
     * @param level    {@link ConsistencyLevel}
     * @throws ExecuteAsyncQueryException  when there is async error
     */
    void save(Iterable entities, Duration ttl, ConsistencyLevel level) throws ExecuteAsyncQueryException;


    /**
     * Deletes an entity with consistency level
     *
     * @param query the query
     * @param level {@link ConsistencyLevel}
     * @throws NullPointerException when both query or level are null
     */
    void delete(ColumnDeleteQuery query, ConsistencyLevel level) throws NullPointerException;

    /**
     * Deletes an entity with consistencyLeel and consumter
     *
     * @param query    the query
     * @param consumer the callback
     * @param level    {@link ConsistencyLevel}
     */
    void delete(ColumnDeleteQuery query, ConsistencyLevel level, Consumer consumer);


    /**
     * Find async with ConsistencyLevel
     *
     * @param query    the query
     * @param level    {@link ConsistencyLevel}
     * @param consumer the callBack
     * @throws ExecuteAsyncQueryException a thread exception
     * @throws NullPointerException       when any arguments are null
     */
    void select(ColumnQuery query, ConsistencyLevel level, Consumer> consumer)
            throws ExecuteAsyncQueryException, NullPointerException;

    /**
     * Executes CQL
     *
     * @param query    the query
     * @param consumer the callback
     * @throws ExecuteAsyncQueryException a thread exception
     */
    void cql(String query, Consumer> consumer)
            throws ExecuteAsyncQueryException, NullPointerException;

    /**
     * Executes CQL using the provided named values.
     * E.g.: "SELECT * FROM users WHERE id = :i", Map.<String, Object>of("i", 1)"
     *
     * @param query    the query
     * @param values   values required for the execution of {@code query}
     * @param consumer the callback
     * @throws ExecuteAsyncQueryException a thread exception
     */
    void cql(String query, Map values, Consumer> consumer)
            throws ExecuteAsyncQueryException, NullPointerException;

    /**
     * Executes statement
     *
     * @param statement the query
     * @param consumer  the callback
     * @throws ExecuteAsyncQueryException a thread exception
     * @throws NullPointerException       when either statment and callback is null
     */
    void execute(Statement statement, Consumer> consumer)
            throws ExecuteAsyncQueryException, NullPointerException;

    /**
     * Executes an query and uses as {@link CassandraPrepareStatment}
     *
     * @param query the query
     * @return the CassandraPrepareStatment instance
     * @throws NullPointerException when query is null
     */
    CassandraPrepareStatment nativeQueryPrepare(String query) throws NullPointerException;

}