org.jnosql.diana.arangodb.document.ArangoDBDocumentCollectionManagerAsync Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arangodb-driver Show documentation

The Eclipse JNoSQL communication layer, Diana, to AranboDB

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.arangodb.document;


import org.jnosql.diana.api.ExecuteAsyncQueryException;
import org.jnosql.diana.api.document.DocumentCollectionManagerAsync;
import org.jnosql.diana.api.document.DocumentEntity;

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

/**
 * The ArandoDB implementation of {@link DocumentCollectionManagerAsync}. It does not support to TTL methods:
 * {@link DocumentCollectionManagerAsync#insert(DocumentEntity, java.time.Duration)}
 * {@link DocumentCollectionManagerAsync#insert(DocumentEntity, java.time.Duration, Consumer)}
 */
public interface ArangoDBDocumentCollectionManagerAsync extends DocumentCollectionManagerAsync {

    /**
     * Executes AQL, finds {@link DocumentEntity} from select asynchronously
     * FOR u IN users FILTER u.status == @status RETURN u 
     *
     * @param query    the query
     * @param values   the named queries
     * @param callBack the callback, when the process is finished will call this instance returning
     *                 the result of select within parameters
     * @throws ExecuteAsyncQueryException    when there is a async error
     * @throws UnsupportedOperationException when the database does not support this feature
     * @throws NullPointerException          when either select or callback are null
     */
    void aql(String query, Map values, Consumer> callBack) throws
            ExecuteAsyncQueryException, UnsupportedOperationException, NullPointerException;


}