com.arangodb.ArangoGraph Maven / Gradle / Ivy
/*
* DISCLAIMER
*
* Copyright 2016 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;
import com.arangodb.entity.EdgeDefinition;
import com.arangodb.entity.GraphEntity;
import com.arangodb.model.GraphCreateOptions;
import com.arangodb.model.ReplaceEdgeDefinitionOptions;
import com.arangodb.model.VertexCollectionCreateOptions;
import javax.annotation.concurrent.ThreadSafe;
import java.util.Collection;
/**
* Interface for operations on ArangoDB graph level.
*
* @author Mark Vollmary
* @see API Documentation
*/
@ThreadSafe
public interface ArangoGraph extends ArangoSerdeAccessor {
/**
* The the handler of the database the named graph is within
*
* @return database handler
*/
ArangoDatabase db();
/**
* The name of the collection
*
* @return collection name
*/
String name();
/**
* Checks whether the graph exists
*
* @return true if the graph exists, otherwise false
*/
boolean exists();
/**
* Creates the graph in the graph module. The creation of a graph requires the name of the graph and a definition of
* its edges.
*
* @param edgeDefinitions An array of definitions for the edge
* @return information about the graph
* @see API
* Documentation
*/
GraphEntity create(Collection edgeDefinitions);
/**
* Creates the graph in the graph module. The creation of a graph requires the name of the graph and a definition of
* its edges.
*
* @param edgeDefinitions An array of definitions for the edge
* @param options Additional options, can be null
* @return information about the graph
* @see API
* Documentation
*/
GraphEntity create(Collection edgeDefinitions, GraphCreateOptions options);
/**
* Deletes the graph from the database.
*
* @see
* API Documentation
*/
void drop();
/**
* Deletes the graph from the database.
*
* @param dropCollections Drop collections of this graph as well. Collections will only be
* dropped if they are not used in other graphs.
* @see API
* Documentation
*/
void drop(boolean dropCollections);
/**
* Retrieves general information about the graph.
*
* @return the definition content of this graph
* @see
* API Documentation
*/
GraphEntity getInfo();
/**
* Fetches all vertex collections from the graph and returns a list of collection names.
*
* @return all vertex collections within this graph
* @see API
* Documentation
*/
Collection getVertexCollections();
/**
* Adds a vertex collection to the set of collections of the graph. If the collection does not exist, it will be
* created.
*
* @param name Name of the vertex collection
* @return information about the graph
* @see API
* Documentation
*/
GraphEntity addVertexCollection(String name);
/**
* Adds a vertex collection to the set of collections of the graph. If the collection does not exist, it will be
* created.
*
* @param name Name of the vertex collection
* @param options additional options
* @return information about the graph
* @see API
* Documentation
* @since ArangoDB 3.9
*/
GraphEntity addVertexCollection(String name, VertexCollectionCreateOptions options);
/**
* Returns a {@code ArangoVertexCollection} instance for the given vertex collection name.
*
* @param name Name of the vertex collection
* @return collection handler
*/
ArangoVertexCollection vertexCollection(String name);
/**
* Returns a {@code ArangoEdgeCollection} instance for the given edge collection name.
*
* @param name Name of the edge collection
* @return collection handler
*/
ArangoEdgeCollection edgeCollection(String name);
/**
* Fetches all edge collections from the graph and returns a list of collection names.
*
* @return all edge collections within this graph
* @see API
* Documentation
*/
Collection getEdgeDefinitions();
/**
* Adds the given edge definition to the graph.
*
* @param definition The edge definition
* @return information about the graph
* @see API
* Documentation
*/
GraphEntity addEdgeDefinition(EdgeDefinition definition);
/**
* Change one specific edge definition. This will modify all occurrences of this definition in all graphs known to
* your database
*
* @param definition The edge definition
* @return information about the graph
* @see API
* Documentation
*/
GraphEntity replaceEdgeDefinition(EdgeDefinition definition);
/**
* Change one specific edge definition. This will modify all occurrences of this definition in all graphs known to
* your database
*
* @param definition The edge definition
* @param options options
* @return information about the graph
* @see API
* Documentation
*/
GraphEntity replaceEdgeDefinition(EdgeDefinition definition, ReplaceEdgeDefinitionOptions options);
}