Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.arangodb.springframework.core.ArangoOperations Maven / Gradle / Ivy
/*
* DISCLAIMER
*
* Copyright 2017 ArangoDB GmbH, Cologne, Germany
*
* 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.
*
* Copyright holder is ArangoDB GmbH, Cologne, Germany
*/
package com.arangodb.springframework.core;
import java.util.Map;
import java.util.Optional;
import org.springframework.dao.DataAccessException;
import com.arangodb.ArangoCursor;
import com.arangodb.ArangoDB;
import com.arangodb.entity.ArangoDBVersion;
import com.arangodb.entity.DocumentEntity;
import com.arangodb.entity.MultiDocumentEntity;
import com.arangodb.entity.UserEntity;
import com.arangodb.model.AqlQueryOptions;
import com.arangodb.model.CollectionCreateOptions;
import com.arangodb.model.DocumentCreateOptions;
import com.arangodb.model.DocumentDeleteOptions;
import com.arangodb.model.DocumentReadOptions;
import com.arangodb.model.DocumentReplaceOptions;
import com.arangodb.model.DocumentUpdateOptions;
import com.arangodb.springframework.core.convert.ArangoConverter;
/**
* @author Mark Vollmary
*
*/
public interface ArangoOperations {
/**
* Give direct access to the underlying driver
*
* @return main access object of the driver
*/
ArangoDB driver();
/**
* Returns the server name and version number.
*
* @return the server version, number
* @throws DataAccessException
*/
ArangoDBVersion getVersion() throws DataAccessException;
/**
* Create a cursor and return the first results
*
* @param query
* contains the query string to be executed
* @param bindVars
* key/value pairs representing the bind parameters, can be null
* @param options
* Additional options, can be null
* @param entityClass
* The entity type of the result
* @return cursor of the results
* @throws DataAccessException
*/
ArangoCursor query(String query, Map bindVars, AqlQueryOptions options, Class entityClass)
throws DataAccessException;
/**
* Create a cursor and return the first results. For queries without bind parameters.
*
* @param query
* contains the query string to be executed
* @param options
* Additional options, can be null
* @param entityClass
* The entity type of the result
* @return cursor of the results
* @throws DataAccessException
*/
ArangoCursor query(String query, AqlQueryOptions options, Class entityClass) throws DataAccessException;
/**
* Removes multiple document
*
* @param values
* The keys of the documents or the documents themselves
* @param entityClass
* The entity type of the documents
* @param options
* Additional options, can be null
* @return information about the documents
* @throws DataAccessException
*/
MultiDocumentEntity delete(
Iterable values,
Class entityClass,
DocumentDeleteOptions options) throws DataAccessException;
/**
* Removes multiple document
*
* @param values
* The keys of the documents or the documents themselves
* @param entityClass
* The entity type of the documents
* @return information about the documents
* @throws DataAccessException
*/
MultiDocumentEntity delete(Iterable values, Class entityClass)
throws DataAccessException;
/**
* Removes a document
*
* @param id
* The id or key of the document
* @param entityClass
* The entity type of the document
* @param options
* Additional options, can be null
* @return information about the document
* @throws DataAccessException
*/
DocumentEntity delete(String id, Class entityClass, DocumentDeleteOptions options) throws DataAccessException;
/**
* Removes a document
*
* @param id
* The id or key of the document
* @param entityClass
* The entity type of the document
* @return information about the document
* @throws DataAccessException
*/
DocumentEntity delete(String id, Class entityClass) throws DataAccessException;
/**
* Partially updates documents, the documents to update are specified by the _key attributes in the objects on
* values. Vales must contain a list of document updates with the attributes to patch (the patch documents). All
* attributes from the patch documents will be added to the existing documents if they do not yet exist, and
* overwritten in the existing documents if they do exist there.
*
* @param
*
* @param values
* A list of documents
* @param entityClass
* The entity type of the documents
* @param options
* Additional options, can be null
* @return information about the documents
* @throws DataAccessException
*/
MultiDocumentEntity update(
Iterable values,
Class entityClass,
DocumentUpdateOptions options) throws DataAccessException;
/**
* Partially updates documents, the documents to update are specified by the _key attributes in the objects on
* values. Vales must contain a list of document updates with the attributes to patch (the patch documents). All
* attributes from the patch documents will be added to the existing documents if they do not yet exist, and
* overwritten in the existing documents if they do exist there.
*
* @param
*
* @param values
* A list of documents
* @param entityClass
* The entity type of the documents
* @return information about the documents
* @throws DataAccessException
*/
MultiDocumentEntity update(Iterable values, Class entityClass)
throws DataAccessException;
/**
* Partially updates the document identified by document id or key. The value must contain a document with the
* attributes to patch (the patch document). All attributes from the patch document will be added to the existing
* document if they do not yet exist, and overwritten in the existing document if they do exist there.
*
* @param id
* The id or key of the document
* @param value
* A representation of a single document
* @param options
* Additional options, can be null
* @return information about the document
* @throws DataAccessException
*/
DocumentEntity update(String id, T value, DocumentUpdateOptions options) throws DataAccessException;
/**
* Partially updates the document identified by document id or key. The value must contain a document with the
* attributes to patch (the patch document). All attributes from the patch document will be added to the existing
* document if they do not yet exist, and overwritten in the existing document if they do exist there.
*
* @param id
* The id or key of the document
* @param value
* A representation of a single document
* @return information about the document
* @throws DataAccessException
*/
DocumentEntity update(String id, T value) throws DataAccessException;
/**
* Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
* specified by the _key attributes in the documents in values.
*
* @param
*
* @param values
* A List of documents
* @param entityClass
* The entity type of the documents
* @param options
* Additional options, can be null
* @return information about the documents
* @throws DataAccessException
*/
MultiDocumentEntity replace(
Iterable values,
Class entityClass,
DocumentReplaceOptions options) throws DataAccessException;
/**
* Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
* specified by the _key attributes in the documents in values.
*
* @param
*
* @param values
* A List of documents
* @param entityClass
* The entity type of the documents
* @param options
* Additional options, can be null
* @return information about the documents
* @throws DataAccessException
*/
MultiDocumentEntity replace(Iterable values, Class entityClass)
throws DataAccessException;
/**
* Replaces the document with key with the one in the body, provided there is such a document and no precondition is
* violated
*
* @param id
* The id or key of the document
* @param value
* A representation of a single document (POJO, VPackSlice or String for Json)
* @param options
* Additional options, can be null
* @return information about the document
* @throws DataAccessException
*/
DocumentEntity replace(String id, T value, DocumentReplaceOptions options) throws DataAccessException;
/**
* Replaces the document with key with the one in the body, provided there is such a document and no precondition is
* violated
*
* @param id
* The id or key of the document
* @param value
* A representation of a single document (POJO, VPackSlice or String for Json)
* @return information about the document
* @throws DataAccessException
*/
DocumentEntity replace(String id, T value) throws DataAccessException;
Optional find(String id, Class entityClass, DocumentReadOptions options) throws DataAccessException;
Optional find(String id, Class entityClass) throws DataAccessException;
/**
* Reads all documents from a collection
*
* @param entityClass
* The entity class which represents the collection
* @return the documents
* @throws DataAccessException
*/
Iterable findAll(Class entityClass) throws DataAccessException;
/**
* Reads multiple documents
*
* @param ids
* The ids or keys of the documents
* @param entityClass
* The entity type of the documents
* @return the documents
* @throws DataAccessException
*/
Iterable find(final Iterable ids, final Class entityClass) throws DataAccessException;
/**
* Creates new documents from the given documents, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
*
* @param
*
* @param values
* A List of documents
* @param entityClass
* The entity type of the documents
* @param options
* Additional options, can be null
* @return information about the documents
* @throws DataAccessException
*/
MultiDocumentEntity insert(
Iterable values,
Class entityClass,
DocumentCreateOptions options) throws DataAccessException;
/**
* Creates new documents from the given documents, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
*
* @param
*
* @param values
* A List of documents
* @param entityClass
* The entity type of the documents
* @return information about the documents
* @throws DataAccessException
*/
MultiDocumentEntity insert(Iterable values, Class entityClass)
throws DataAccessException;
/**
* Creates a new document from the given document, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
*
* @param value
* A representation of a single document
* @param options
* Additional options, can be null
* @return information about the document
*/
DocumentEntity insert(T value, DocumentCreateOptions options) throws DataAccessException;
/**
* Creates a new document from the given document, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
*
* @param value
* A representation of a single document
* @return information about the document
*/
DocumentEntity insert(T value) throws DataAccessException;
/**
* Creates a new document from the given document, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
*
* @param collectionName
* Name of the collection in which the new document should be inserted
* @param value
* A representation of a single document
* @param options
* Additional options, can be null
* @return information about the document
* @throws DataAccessException
*/
DocumentEntity insert(String collectionName, Object value, DocumentCreateOptions options)
throws DataAccessException;
/**
* Creates a new document from the given document, unless there is already a document with the _key given. If no
* _key is given, a new unique _key is generated automatically.
*
* @param collectionName
* Name of the collection in which the new document should be inserted
* @param value
* A representation of a single document
* @return information about the document
* @throws DataAccessException
*/
DocumentEntity insert(String collectionName, Object value) throws DataAccessException;
public enum UpsertStrategy {
REPLACE, UPDATE
}
/**
* Creates a new document from the given document, unless there is already a document with the id given. In that
* case it updates or replaces the document, depending on the chosen strategy.
*
* @param value
* A representation of a single document
* @param strategy
* The strategy to use when not inserting the document
* @throws DataAccessException
*/
void upsert(T value, UpsertStrategy strategy) throws DataAccessException;
/**
* Creates new documents from the given documents, unless there already exists. In that case it updates or replaces
* the documents, depending on the chosen strategy.
*
* @param value
* A List of documents
* @param strategy
* The strategy to use when not inserting the document
* @throws DataAccessException
*/
void upsert(Iterable value, UpsertStrategy strategy) throws DataAccessException;
/**
* Checks whether the document exists by reading a single document head
*
* @param id
* The id or key of the document
* @param entityClass
* The entity type of the document
* @return true if the document exists, false if not
* @throws DataAccessException
*/
boolean exists(String id, Class entityClass) throws DataAccessException;
/**
* Drop an existing database
*
* @throws DataAccessException
*/
void dropDatabase() throws DataAccessException;
/**
* Returns the operations interface for a collection. If the collection does not exists, it is created
* automatically.
*
* @param entityClass
* The entity type representing the collection
* @return {@link CollectionOperations}
* @throws DataAccessException
*/
CollectionOperations collection(Class entityClass) throws DataAccessException;
/**
* Returns the operations interface for a collection. If the collection does not exists, it is created
* automatically.
*
* @param name
* The name of the collection
* @return {@link CollectionOperations}
* @throws DataAccessException
*/
CollectionOperations collection(String name) throws DataAccessException;
/**
* Returns the operations interface for a collection. If the collection does not exists, it is created
* automatically.
*
* @param name
* The name of the collection
* @param options
* Additional options for collection creation, can be null
* @return {@link CollectionOperations}
* @throws DataAccessException
*/
CollectionOperations collection(String name, CollectionCreateOptions options) throws DataAccessException;
/**
* Return the operations interface for a user. The user is not created automatically if it does not exists.
*
* @param username
* The name of the user
* @return {@link UserOperations}
*/
UserOperations user(String username);
/**
* Fetches data about all users. You can only execute this call if you have access to the _system database.
*
* @return informations about all users
* @throws DataAccessException
*/
Iterable getUsers() throws DataAccessException;
ArangoConverter getConverter();
}
