public interface Graph
| Modifier and Type | Method and Description |
|---|---|
default Edge |
addEdge(String edgeId,
String outVertexId,
String inVertexId,
String label,
Visibility visibility,
Authorizations authorizations)
Adds an edge between two vertices.
|
default Edge |
addEdge(String outVertexId,
String inVertexId,
String label,
Visibility visibility,
Authorizations authorizations)
Adds an edge between two vertices.
|
default Edge |
addEdge(String edgeId,
Vertex outVertex,
Vertex inVertex,
String label,
Visibility visibility,
Authorizations authorizations)
Adds an edge between two vertices.
|
default Edge |
addEdge(Vertex outVertex,
Vertex inVertex,
String label,
Visibility visibility,
Authorizations authorizations)
Adds an edge between two vertices.
|
void |
addGraphEventListener(GraphEventListener graphEventListener)
Adds a graph event listener that will be called when graph events occur.
|
default Vertex |
addVertex(String vertexId,
Visibility visibility,
Authorizations authorizations,
String conceptType)
Adds a vertex to the graph.
|
default Vertex |
addVertex(Visibility visibility,
Authorizations authorizations,
String conceptType)
Adds a vertex to the graph.
|
default Iterable<Vertex> |
addVertices(Iterable<ElementBuilder<Vertex>> vertices,
Authorizations authorizations)
Adds the vertices to the graph.
|
default Authorizations |
createAuthorizations(Authorizations auths,
Collection<String> additionalAuthorizations)
Creates an authorizations object combining auths and additionalAuthorizations.
|
Authorizations |
createAuthorizations(Authorizations auths,
String... additionalAuthorizations)
Creates an authorizations object combining auths and additionalAuthorizations.
|
default Authorizations |
createAuthorizations(Collection<String> auths)
Creates an authorizations object.
|
Authorizations |
createAuthorizations(String... auths)
Creates an authorizations object.
|
default DefinePropertyBuilder |
defineProperty(String propertyName)
Creates a defines property builder.
|
void |
deleteEdge(Edge edge,
Authorizations authorizations)
Permanently deletes an edge from the graph.
|
default void |
deleteEdge(String edgeId,
Authorizations authorizations)
Permanently deletes an edge from the graph.
|
default void |
deleteElement(ElementId elementId,
Authorizations authorizations)
Deletes an element
|
default void |
deleteElements(Stream<? extends ElementId> elementIds,
Authorizations authorizations)
Deletes multiple elements
|
void |
deleteExtendedDataRow(ExtendedDataRowId id,
Authorizations authorizations)
Deletes an extended data row
|
default void |
deleteVertex(String vertexId,
Authorizations authorizations)
Permanently deletes a vertex from the graph.
|
void |
deleteVertex(Vertex vertex,
Authorizations authorizations)
Permanently deletes a vertex from the graph.
|
default Map<String,Boolean> |
doEdgesExist(Iterable<String> ids,
Authorizations authorizations)
Tests the existence of edges with the given authorizations.
|
default Map<String,Boolean> |
doEdgesExist(Iterable<String> ids,
Long endTime,
Authorizations authorizations)
Tests the existence of edges with the given authorizations.
|
default boolean |
doesEdgeExist(String edgeId,
Authorizations authorizations)
Tests the existence of a edge with the given authorizations.
|
default boolean |
doesVertexExist(String vertexId,
Authorizations authorizations)
Tests the existence of a vertex with the given authorizations.
|
default Map<String,Boolean> |
doVerticesExist(Iterable<String> ids,
Authorizations authorizations)
Tests the existence of vertices with the given authorizations.
|
void |
drop()
Drops all tables.
|
void |
dumpGraph() |
void |
ensurePropertyDefined(String name,
Value value) |
Iterable<String> |
filterEdgeIdsByAuthorization(Iterable<String> edgeIds,
String authorizationToMatch,
EnumSet<ElementFilter> filters,
Authorizations authorizations)
Filters a collection of edge ids by the authorizations of that edge, properties, etc.
|
Iterable<String> |
filterVertexIdsByAuthorization(Iterable<String> vertexIds,
String authorizationToMatch,
EnumSet<ElementFilter> filters,
Authorizations authorizations)
Filters a collection of vertex ids by the authorizations of that vertex, properties, etc.
|
Iterable<Path> |
findPaths(FindPathOptions options,
Authorizations authorizations)
Finds all paths between two vertices.
|
default Iterable<Path> |
findPaths(String sourceVertexId,
String destVertexId,
int maxHops,
Authorizations authorizations)
Deprecated.
|
default Iterable<Path> |
findPaths(String sourceVertexId,
String destVertexId,
int maxHops,
ProgressCallback progressCallback,
Authorizations authorizations)
Deprecated.
|
default Iterable<Path> |
findPaths(String sourceVertexId,
String destVertexId,
String[] labels,
int maxHops,
Authorizations authorizations)
Deprecated.
|
default Iterable<Path> |
findPaths(String sourceVertexId,
String destVertexId,
String[] labels,
int maxHops,
ProgressCallback progressCallback,
Authorizations authorizations)
Deprecated.
|
default Iterable<String> |
findRelatedEdgeIds(Iterable<String> vertexIds,
Authorizations authorizations)
Given a list of vertex ids, find all the edge ids that connect them.
|
default Iterable<String> |
findRelatedEdgeIds(Iterable<String> vertexIds,
Long endTime,
Authorizations authorizations)
Given a list of vertex ids, find all the edge ids that connect them.
|
default Iterable<String> |
findRelatedEdgeIdsForVertices(Iterable<Vertex> verticesIterable,
Authorizations authorizations)
Given a list of vertices, find all the edge ids that connect them.
|
default Iterable<String> |
findRelatedEdges(Iterable<String> vertexIds,
Authorizations authorizations)
Deprecated.
|
default Iterable<String> |
findRelatedEdges(Iterable<String> vertexIds,
Long endTime,
Authorizations authorizations)
Deprecated.
|
default Iterable<RelatedEdge> |
findRelatedEdgeSummary(Iterable<String> vertexIds,
Authorizations authorizations)
Given a list of vertex ids, find all the edges that connect them.
|
default Iterable<RelatedEdge> |
findRelatedEdgeSummary(Iterable<String> vertexIds,
Long endTime,
Authorizations authorizations)
Given a list of vertex ids, find all the edges that connect them.
|
default Iterable<RelatedEdge> |
findRelatedEdgeSummaryForVertices(Iterable<Vertex> verticesIterable,
Authorizations authorizations)
Given a list of vertices, find all the edges that connect them.
|
void |
flush()
Flushes any pending mutations to the graph.
|
FetchHints |
getDefaultFetchHints()
The default fetch hints to use if none are provided
|
default Edge |
getEdge(String edgeId,
Authorizations authorizations)
Get an edge from the graph.
|
default Edge |
getEdge(String edgeId,
FetchHints fetchHints,
Authorizations authorizations)
Get an edge from the graph.
|
default Edge |
getEdge(String edgeId,
FetchHints fetchHints,
Long endTime,
Authorizations authorizations)
Get an edge from the graph.
|
default long |
getEdgeCount(Authorizations authorizations)
Gets a count of the number of edges in the system.
|
default Iterable<Edge> |
getEdges(Authorizations authorizations)
Gets all edges on the graph.
|
default Iterable<Edge> |
getEdges(FetchHints fetchHints,
Authorizations authorizations)
Gets all edges on the graph.
|
Iterable<Edge> |
getEdges(FetchHints fetchHints,
Long endTime,
Authorizations authorizations)
Gets all edges on the graph.
|
default Iterable<Edge> |
getEdges(Iterable<String> ids,
Authorizations authorizations)
Gets all edges on the graph matching the given ids.
|
default Iterable<Edge> |
getEdges(Iterable<String> ids,
FetchHints fetchHints,
Authorizations authorizations)
Gets all edges on the graph matching the given ids.
|
default Iterable<Edge> |
getEdges(Iterable<String> ids,
FetchHints fetchHints,
Long endTime,
Authorizations authorizations)
Gets all edges on the graph matching the given ids.
|
default Iterable<Edge> |
getEdgesInRange(IdRange idRange,
Authorizations authorizations)
Gets edges from the graph in the given range.
|
default Iterable<Edge> |
getEdgesInRange(IdRange idRange,
FetchHints fetchHints,
Authorizations authorizations)
Gets edges from the graph in the given range.
|
default Iterable<Edge> |
getEdgesInRange(IdRange idRange,
FetchHints fetchHints,
Long endTime,
Authorizations authorizations)
Gets edges from the graph in the given range.
|
default Element |
getElement(ElementId elementId,
Authorizations authorizations)
Get an element from the graph.
|
default Element |
getElement(ElementId elementId,
FetchHints fetchHints,
Authorizations authorizations)
Get an element from the graph.
|
default Iterable<ExtendedDataRow> |
getExtendedData(ElementId elementId,
String tableName,
Authorizations authorizations)
Gets the specified extended data rows.
|
default Iterable<ExtendedDataRow> |
getExtendedData(ElementId elementId,
String tableName,
FetchHints fetchHints,
Authorizations authorizations)
Gets the specified extended data rows.
|
default Iterable<ExtendedDataRow> |
getExtendedData(ElementType elementType,
String elementId,
String tableName,
Authorizations authorizations)
Gets the specified extended data rows.
|
default Iterable<ExtendedDataRow> |
getExtendedData(ElementType elementType,
String elementId,
String tableName,
FetchHints fetchHints,
Authorizations authorizations)
Gets the specified extended data rows.
|
default ExtendedDataRow |
getExtendedData(ExtendedDataRowId id,
Authorizations authorizations)
Gets the specified extended data row.
|
default Iterable<ExtendedDataRow> |
getExtendedData(Iterable<ExtendedDataRowId> ids,
Authorizations authorizations)
Gets the specified extended data rows.
|
Iterable<ExtendedDataRow> |
getExtendedData(Iterable<ExtendedDataRowId> ids,
FetchHints fetchHints,
Authorizations authorizations)
Gets the specified extended data rows.
|
default Iterable<ExtendedDataRow> |
getExtendedDataForElements(Iterable<? extends ElementId> elementIds,
Authorizations authorizations)
Gets the specified extended data rows.
|
default Iterable<ExtendedDataRow> |
getExtendedDataForElements(Iterable<? extends ElementId> elementIds,
FetchHints fetchHints,
Authorizations authorizations)
Gets the specified extended data rows.
|
default Iterable<ExtendedDataRow> |
getExtendedDataForElements(Iterable<? extends ElementId> elementIds,
String tableName,
Authorizations authorizations)
Gets the specified extended data rows.
|
Iterable<ExtendedDataRow> |
getExtendedDataForElements(Iterable<? extends ElementId> elementIds,
String tableName,
FetchHints fetchHints,
Authorizations authorizations)
Gets the specified extended data rows.
|
Iterable<ExtendedDataRow> |
getExtendedDataInRange(ElementType elementType,
IdRange elementIdRange,
Authorizations authorizations)
Gets extended data rows from the graph in the given range.
|
IdGenerator |
getIdGenerator()
Gets the id generator used by this graph to create ids.
|
Iterable<GraphMetadataEntry> |
getMetadata()
Gets all metadata.
|
Object |
getMetadata(String key)
Gets metadata from the graph.
|
Iterable<GraphMetadataEntry> |
getMetadataWithPrefix(String prefix)
Gets all metadata with the given prefix.
|
GeMetricRegistry |
getMetricsRegistry()
Gets the metrics registry to record internal GraphEngine metrics
|
default NameSubstitutionStrategy |
getNameSubstitutionStrategy() |
PropertyDefinition |
getPropertyDefinition(String propertyName)
Gets the property definition for the given name.
|
Collection<PropertyDefinition> |
getPropertyDefinitions()
Gets all property definitions.
|
SearchIndexSecurityGranularity |
getSearchIndexSecurityGranularity()
Gets the granularity of the search index
SearchIndexSecurityGranularity |
default List<InputStream> |
getStreamingPropertyValueInputStreams(List<StreamingPropertyValue> streamingPropertyValues)
Opens multiple StreamingPropertyValue input streams at once.
|
default Vertex |
getVertex(String vertexId,
Authorizations authorizations)
Get a vertex from the graph.
|
default Vertex |
getVertex(String vertexId,
FetchHints fetchHints,
Authorizations authorizations)
Get a vertex from the graph.
|
default Vertex |
getVertex(String vertexId,
FetchHints fetchHints,
Long endTime,
Authorizations authorizations)
Get a vertex from the graph.
|
default long |
getVertexCount(Authorizations authorizations)
Gets a count of the number of vertices in the system.
|
Iterable<String> |
getVertexIds(Authorizations authorizations) |
default Map<Object,Long> |
getVertexPropertyCountByValue(String propertyName,
Authorizations authorizations)
Gets the number of times a property with a given value occurs on vertices
|
default Iterable<Vertex> |
getVertices(Authorizations authorizations)
Gets all vertices on the graph.
|
default Iterable<Vertex> |
getVertices(FetchHints fetchHints,
Authorizations authorizations)
Gets all vertices on the graph.
|
Iterable<Vertex> |
getVertices(FetchHints fetchHints,
Long endTime,
Authorizations authorizations)
Gets all vertices on the graph.
|
default Iterable<Vertex> |
getVertices(Iterable<String> ids,
Authorizations authorizations)
Gets all vertices matching the given ids on the graph.
|
default Iterable<Vertex> |
getVertices(Iterable<String> ids,
FetchHints fetchHints,
Authorizations authorizations)
Gets all vertices matching the given ids on the graph.
|
default Iterable<Vertex> |
getVertices(Iterable<String> ids,
FetchHints fetchHints,
Long endTime,
Authorizations authorizations)
Gets all vertices matching the given ids on the graph.
|
default List<Vertex> |
getVerticesInOrder(Iterable<String> ids,
Authorizations authorizations)
Gets all vertices matching the given ids on the graph.
|
default List<Vertex> |
getVerticesInOrder(Iterable<String> ids,
FetchHints fetchHints,
Authorizations authorizations)
Gets all vertices matching the given ids on the graph.
|
default Iterable<Vertex> |
getVerticesInRange(IdRange idRange,
Authorizations authorizations)
Gets vertices from the graph in the given range.
|
default Iterable<Vertex> |
getVerticesInRange(IdRange idRange,
FetchHints fetchHints,
Authorizations authorizations)
Gets vertices from the graph in the given range.
|
default Iterable<Vertex> |
getVerticesInRange(IdRange idRange,
FetchHints fetchHints,
Long endTime,
Authorizations authorizations)
Gets vertices from the graph in the given range.
|
default Iterable<Vertex> |
getVerticesWithPrefix(String vertexIdPrefix,
Authorizations authorizations)
Gets vertices from the graph given the prefix.
|
default Iterable<Vertex> |
getVerticesWithPrefix(String vertexIdPrefix,
FetchHints fetchHints,
Authorizations authorizations)
Gets vertices from the graph given the prefix.
|
default Iterable<Vertex> |
getVerticesWithPrefix(String vertexIdPrefix,
FetchHints fetchHints,
Long endTime,
Authorizations authorizations)
Gets vertices from the graph given the prefix.
|
boolean |
isFieldBoostSupported()
Determine if field boost is support.
|
boolean |
isPropertyDefined(String propertyName)
Determine if a property is already defined
|
boolean |
isQuerySimilarToTextSupported()
Returns true if this graph supports similar to text queries.
|
boolean |
isVisibilityValid(Visibility visibility,
Authorizations authorizations)
Given an authorization is the visibility object valid.
|
void |
markEdgeHidden(Edge edge,
Visibility visibility,
Authorizations authorizations)
Marks an edge as hidden for a given visibility.
|
void |
markEdgeVisible(Edge edge,
Visibility visibility,
Authorizations authorizations)
Marks an edge as visible for a given visibility, effectively undoing markEdgeHidden.
|
void |
markVertexHidden(Vertex vertex,
Visibility visibility,
Authorizations authorizations)
Marks a vertex as hidden for a given visibility.
|
void |
markVertexVisible(Vertex vertex,
Visibility visibility,
Authorizations authorizations)
Marks a vertex as visible for a given visibility, effectively undoing markVertexHidden.
|
EdgeBuilderByVertexId |
prepareEdge(String edgeId,
String outVertexId,
String inVertexId,
String label,
Long timestamp,
Visibility visibility)
Prepare an edge to be added to the graph.
|
default EdgeBuilderByVertexId |
prepareEdge(String edgeId,
String outVertexId,
String inVertexId,
String label,
Visibility visibility)
Prepare an edge to be added to the graph.
|
default EdgeBuilderByVertexId |
prepareEdge(String outVertexId,
String inVertexId,
String label,
Visibility visibility)
Prepare an edge to be added to the graph.
|
EdgeBuilder |
prepareEdge(String edgeId,
Vertex outVertex,
Vertex inVertex,
String label,
Long timestamp,
Visibility visibility)
Prepare an edge to be added to the graph.
|
default EdgeBuilder |
prepareEdge(String edgeId,
Vertex outVertex,
Vertex inVertex,
String label,
Visibility visibility)
Prepare an edge to be added to the graph.
|
default EdgeBuilder |
prepareEdge(Vertex outVertex,
Vertex inVertex,
String label,
Visibility visibility)
Prepare an edge to be added to the graph.
|
default VertexBuilder |
prepareVertex(Long timestamp,
Visibility visibility,
String conceptType)
Prepare a vertex to be added to the graph.
|
VertexBuilder |
prepareVertex(String vertexId,
Long timestamp,
Visibility visibility,
String conceptType)
Prepare a vertex to be added to the graph.
|
default VertexBuilder |
prepareVertex(String vertexId,
Visibility visibility,
String conceptType)
Prepare a vertex to be added to the graph.
|
default VertexBuilder |
prepareVertex(Visibility visibility,
String conceptType)
Prepare a vertex to be added to the graph.
|
GraphQuery |
query(Authorizations authorizations)
Creates a query builder object used to query the graph.
|
MultiVertexQuery |
query(String[] vertexIds,
Authorizations authorizations)
Creates a query builder object used to query a list of vertices.
|
MultiVertexQuery |
query(String[] vertexIds,
String queryString,
Authorizations authorizations)
Creates a query builder object used to query a list of vertices.
|
GraphQuery |
query(String queryString,
Authorizations authorizations)
Creates a query builder object used to query the graph.
|
SimilarToGraphQuery |
querySimilarTo(String[] fields,
String text,
Authorizations authorizations)
Creates a query builder object that finds all vertices similar to the given text for the specified fields.
|
void |
reindex(Authorizations authorizations)
Reindex all vertices and edges.
|
void |
reloadMetadata()
Force a reload of graph metadata.
|
void |
removeGraphEventListener(GraphEventListener graphEventListener)
Removes a graph event listener
|
void |
removeMetadata(String key)
Removes metadata from graph
|
void |
removePropertyDefinition(String propertyName)
Removes the property with the given name
|
Iterable<Element> |
saveElementMutations(Iterable<ElementMutation<? extends Element>> mutations,
Authorizations authorizations)
Saves multiple mutations with a single call.
|
void |
savePropertyDefinition(PropertyDefinition propertyDefinition)
Save a pre-made property definition.
|
void |
setMetadata(String key,
Object value)
Sets metadata on the graph.
|
void |
shutdown()
Cleans up or disconnects from the underlying storage.
|
default void |
softDeleteEdge(Edge edge,
Authorizations authorizations)
Soft deletes an edge from the graph.
|
void |
softDeleteEdge(Edge edge,
Long timestamp,
Authorizations authorizations)
Soft deletes an edge from the graph.
|
default void |
softDeleteEdge(String edgeId,
Authorizations authorizations)
Soft deletes an edge from the graph.
|
default void |
softDeleteEdge(String edgeId,
Long timestamp,
Authorizations authorizations)
Soft deletes an edge from the graph.
|
default void |
softDeleteVertex(String vertexId,
Authorizations authorizations)
Soft deletes a vertex from the graph.
|
default void |
softDeleteVertex(String vertexId,
Long timestamp,
Authorizations authorizations)
Soft deletes a vertex from the graph.
|
default void |
softDeleteVertex(Vertex vertex,
Authorizations authorizations)
Soft deletes a vertex from the graph.
|
void |
softDeleteVertex(Vertex vertex,
Long timestamp,
Authorizations authorizations)
Soft deletes a vertex from the graph.
|
void |
truncate()
Clears all data from the graph.
|
default void |
visit(Iterable<? extends Element> elements,
GraphVisitor visitor)
Visits elements using the supplied elements and visitor
|
default void |
visitEdges(GraphVisitor graphVisitor,
Authorizations authorizations)
Visits all edges on the graph
|
default void |
visitElements(GraphVisitor graphVisitor,
Authorizations authorizations)
Visits all elements on the graph
|
default void |
visitVertices(GraphVisitor graphVisitor,
Authorizations authorizations)
Visits all vertices on the graph
|
default Vertex addVertex(Visibility visibility, Authorizations authorizations, String conceptType)
visibility - The visibility to assign to the new vertex.authorizations - The authorizations required to add and retrieve the new vertex.default Vertex addVertex(String vertexId, Visibility visibility, Authorizations authorizations, String conceptType)
vertexId - The id to assign the new vertex.visibility - The visibility to assign to the new vertex.authorizations - The authorizations required to add and retrieve the new vertex.default Iterable<Vertex> addVertices(Iterable<ElementBuilder<Vertex>> vertices, Authorizations authorizations)
vertices - The vertices to add.authorizations - The authorizations required to add and retrieve the new vertex.default VertexBuilder prepareVertex(Visibility visibility, String conceptType)
visibility - The visibility to assign to the new vertex.default VertexBuilder prepareVertex(Long timestamp, Visibility visibility, String conceptType)
timestamp - The timestamp of the vertex. null, to use the system generated time.visibility - The visibility to assign to the new vertex.default VertexBuilder prepareVertex(String vertexId, Visibility visibility, String conceptType)
vertexId - The id to assign the new vertex.visibility - The visibility to assign to the new vertex.VertexBuilder prepareVertex(String vertexId, Long timestamp, Visibility visibility, String conceptType)
vertexId - The id to assign the new vertex.conceptType - The concept to assign the new vertex.timestamp - The timestamp of the vertex.visibility - The visibility to assign to the new vertex.default boolean doesVertexExist(String vertexId, Authorizations authorizations)
vertexId - The vertex id to check existence of.authorizations - The authorizations required to load the vertex.default Element getElement(ElementId elementId, Authorizations authorizations)
elementId - The element id to retrieve from the graph.authorizations - The authorizations required to load the element.default Element getElement(ElementId elementId, FetchHints fetchHints, Authorizations authorizations)
elementId - The element id to retrieve from the graph.fetchHints - Hint at what parts of the element to fetch.authorizations - The authorizations required to load the element.default void deleteElements(Stream<? extends ElementId> elementIds, Authorizations authorizations)
elementIds - The element ids to deleteauthorizations - The authorizations required to delete the elementsdefault void deleteElement(ElementId elementId, Authorizations authorizations)
elementId - The element to deleteauthorizations - The authorizations required to delete the elementdefault Vertex getVertex(String vertexId, Authorizations authorizations)
vertexId - The vertex id to retrieve from the graph.authorizations - The authorizations required to load the vertex.default Vertex getVertex(String vertexId, FetchHints fetchHints, Authorizations authorizations)
vertexId - The vertex id to retrieve from the graph.fetchHints - Hint at what parts of the vertex to fetch.authorizations - The authorizations required to load the vertex.default Vertex getVertex(String vertexId, FetchHints fetchHints, Long endTime, Authorizations authorizations)
vertexId - The vertex id to retrieve from the graph.fetchHints - Hint at what parts of the vertex to fetch.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVerticesWithPrefix(String vertexIdPrefix, Authorizations authorizations)
vertexIdPrefix - The prefix of the vertex ids to retrieve from the graph.authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVerticesWithPrefix(String vertexIdPrefix, FetchHints fetchHints, Authorizations authorizations)
vertexIdPrefix - The prefix of the vertex ids to retrieve from the graph.fetchHints - Hint at what parts of the vertex to fetch.authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVerticesWithPrefix(String vertexIdPrefix, FetchHints fetchHints, Long endTime, Authorizations authorizations)
vertexIdPrefix - The prefix of the vertex ids to retrieve from the graph.fetchHints - Hint at what parts of the vertex to fetch.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVerticesInRange(IdRange idRange, Authorizations authorizations)
idRange - The range of ids to get.authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVerticesInRange(IdRange idRange, FetchHints fetchHints, Authorizations authorizations)
idRange - The range of ids to get.fetchHints - Hint at what parts of the vertex to fetch.authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVerticesInRange(IdRange idRange, FetchHints fetchHints, Long endTime, Authorizations authorizations)
idRange - The range of ids to get.fetchHints - Hint at what parts of the vertex to fetch.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVertices(Authorizations authorizations)
authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVertices(FetchHints fetchHints, Authorizations authorizations)
fetchHints - Hint at what parts of the vertex to fetch.authorizations - The authorizations required to load the vertex.Iterable<String> getVertexIds(Authorizations authorizations)
Iterable<Vertex> getVertices(FetchHints fetchHints, Long endTime, Authorizations authorizations)
fetchHints - Hint at what parts of the vertex to fetch.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the vertex.default Map<String,Boolean> doVerticesExist(Iterable<String> ids, Authorizations authorizations)
ids - The vertex ids to check existence of.authorizations - The authorizations required to load the vertices.default Iterable<Vertex> getVertices(Iterable<String> ids, Authorizations authorizations)
getVerticesInOrder(Iterable, Authorizations).
Vertices are not kept in memory during the iteration.ids - The ids of the vertices to get.authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVertices(Iterable<String> ids, FetchHints fetchHints, Authorizations authorizations)
getVerticesInOrder(Iterable, Authorizations).
Vertices are not kept in memory during the iteration.ids - The ids of the vertices to get.fetchHints - Hint at what parts of the vertex to fetch.authorizations - The authorizations required to load the vertex.default Iterable<Vertex> getVertices(Iterable<String> ids, FetchHints fetchHints, Long endTime, Authorizations authorizations)
getVerticesInOrder(Iterable, Authorizations).
Vertices are not kept in memory during the iteration.ids - The ids of the vertices to get.fetchHints - Hint at what parts of the vertex to fetch.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the vertex.default List<Vertex> getVerticesInOrder(Iterable<String> ids, Authorizations authorizations)
getVertices(Iterable, Authorizations)
but returns the vertices in the order that you passed in the ids. This requires loading
all the vertices in memory to sort them.ids - The ids of the vertices to get.authorizations - The authorizations required to load the vertex.default List<Vertex> getVerticesInOrder(Iterable<String> ids, FetchHints fetchHints, Authorizations authorizations)
getVertices(Iterable, Authorizations)
but returns the vertices in the order that you passed in the ids. This requires loading
all the vertices in memory to sort them.ids - The ids of the vertices to get.fetchHints - Hint at what parts of the vertex to fetch.authorizations - The authorizations required to load the vertex.void deleteVertex(Vertex vertex, Authorizations authorizations)
vertex - The vertex to delete.authorizations - The authorizations required to delete the vertex.default void deleteVertex(String vertexId, Authorizations authorizations)
vertexId - The vertex id to delete.authorizations - The authorizations required to delete the vertex.default void softDeleteVertex(Vertex vertex, Authorizations authorizations)
vertex - The vertex to soft delete.authorizations - The authorizations required to soft delete the vertex.void softDeleteVertex(Vertex vertex, Long timestamp, Authorizations authorizations)
vertex - The vertex to soft delete.authorizations - The authorizations required to soft delete the vertex.default void softDeleteVertex(String vertexId, Authorizations authorizations)
vertexId - The vertex id to soft delete.authorizations - The authorizations required to soft delete the vertex.default void softDeleteVertex(String vertexId, Long timestamp, Authorizations authorizations)
vertexId - The vertex id to soft delete.authorizations - The authorizations required to soft delete the vertex.default Edge addEdge(Vertex outVertex, Vertex inVertex, String label, Visibility visibility, Authorizations authorizations)
outVertex - The source vertex. The "out" side of the edge.inVertex - The destination vertex. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.visibility - The visibility to assign to the new edge.authorizations - The authorizations required to add and retrieve the new edge.default Edge addEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Visibility visibility, Authorizations authorizations)
edgeId - The id to assign the new edge.outVertex - The source vertex. The "out" side of the edge.inVertex - The destination vertex. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.visibility - The visibility to assign to the new edge.authorizations - The authorizations required to add and retrieve the new edge.default Edge addEdge(String outVertexId, String inVertexId, String label, Visibility visibility, Authorizations authorizations)
outVertexId - The source vertex id. The "out" side of the edge.inVertexId - The destination vertex id. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.visibility - The visibility to assign to the new edge.authorizations - The authorizations required to add and retrieve the new edge.default Edge addEdge(String edgeId, String outVertexId, String inVertexId, String label, Visibility visibility, Authorizations authorizations)
edgeId - The id to assign the new edge.outVertexId - The source vertex id. The "out" side of the edge.inVertexId - The destination vertex id. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.visibility - The visibility to assign to the new edge.authorizations - The authorizations required to add and retrieve the new edge.default EdgeBuilder prepareEdge(Vertex outVertex, Vertex inVertex, String label, Visibility visibility)
outVertex - The source vertex. The "out" side of the edge.inVertex - The destination vertex. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.visibility - The visibility to assign to the new edge.default EdgeBuilder prepareEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Visibility visibility)
edgeId - The id to assign the new edge.outVertex - The source vertex. The "out" side of the edge.inVertex - The destination vertex. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.visibility - The visibility to assign to the new edge.EdgeBuilder prepareEdge(String edgeId, Vertex outVertex, Vertex inVertex, String label, Long timestamp, Visibility visibility)
edgeId - The id to assign the new edge.outVertex - The source vertex. The "out" side of the edge.inVertex - The destination vertex. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.timestamp - The timestamp of the edge.visibility - The visibility to assign to the new edge.default EdgeBuilderByVertexId prepareEdge(String outVertexId, String inVertexId, String label, Visibility visibility)
outVertexId - The source vertex id. The "out" side of the edge.inVertexId - The destination vertex id. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.visibility - The visibility to assign to the new edge.default EdgeBuilderByVertexId prepareEdge(String edgeId, String outVertexId, String inVertexId, String label, Visibility visibility)
edgeId - The id to assign the new edge.outVertexId - The source vertex id. The "out" side of the edge.inVertexId - The destination vertex id. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.visibility - The visibility to assign to the new edge.EdgeBuilderByVertexId prepareEdge(String edgeId, String outVertexId, String inVertexId, String label, Long timestamp, Visibility visibility)
edgeId - The id to assign the new edge.outVertexId - The source vertex id. The "out" side of the edge.inVertexId - The destination vertex id. The "in" side of the edge.label - The label to assign to the edge. eg knows, works at, etc.timestamp - The timestamp of the edge.visibility - The visibility to assign to the new edge.default boolean doesEdgeExist(String edgeId, Authorizations authorizations)
edgeId - The edge id to check existence of.authorizations - The authorizations required to load the edge.default Edge getEdge(String edgeId, Authorizations authorizations)
edgeId - The edge id to retrieve from the graph.authorizations - The authorizations required to load the edge.default Edge getEdge(String edgeId, FetchHints fetchHints, Authorizations authorizations)
edgeId - The edge id to retrieve from the graph.fetchHints - Hint at what parts of the edge to fetch.authorizations - The authorizations required to load the edge.default Edge getEdge(String edgeId, FetchHints fetchHints, Long endTime, Authorizations authorizations)
edgeId - The edge id to retrieve from the graph.fetchHints - Hint at what parts of the edge to fetch.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the edge.default Iterable<Edge> getEdges(Authorizations authorizations)
authorizations - The authorizations required to load the edge.default Iterable<Edge> getEdges(FetchHints fetchHints, Authorizations authorizations)
fetchHints - Hint at what parts of the edge to fetch.authorizations - The authorizations required to load the edge.Iterable<Edge> getEdges(FetchHints fetchHints, Long endTime, Authorizations authorizations)
fetchHints - Hint at what parts of the edge to fetch.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the edge.default Iterable<Edge> getEdgesInRange(IdRange idRange, Authorizations authorizations)
idRange - The range of ids to get.authorizations - The authorizations required to load the vertex.default Iterable<Edge> getEdgesInRange(IdRange idRange, FetchHints fetchHints, Authorizations authorizations)
idRange - The range of ids to get.fetchHints - Hint at what parts of the vertex to fetch.authorizations - The authorizations required to load the vertex.default Iterable<Edge> getEdgesInRange(IdRange idRange, FetchHints fetchHints, Long endTime, Authorizations authorizations)
idRange - The range of ids to get.fetchHints - Hint at what parts of the vertex to fetch.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the vertex.Iterable<String> filterEdgeIdsByAuthorization(Iterable<String> edgeIds, String authorizationToMatch, EnumSet<ElementFilter> filters, Authorizations authorizations)
edgeIds - The edge ids to filter on.authorizationToMatch - The authorization to look forfilters - The parts of the edge to filter onauthorizations - The authorization to find the edges withIterable<String> filterVertexIdsByAuthorization(Iterable<String> vertexIds, String authorizationToMatch, EnumSet<ElementFilter> filters, Authorizations authorizations)
vertexIds - The vertex ids to filter on.authorizationToMatch - The authorization to look forfilters - The parts of the edge to filter onauthorizations - The authorization to find the edges withdefault Map<String,Boolean> doEdgesExist(Iterable<String> ids, Authorizations authorizations)
ids - The edge ids to check existence of.authorizations - The authorizations required to load the edges.default Map<String,Boolean> doEdgesExist(Iterable<String> ids, Long endTime, Authorizations authorizations)
ids - The edge ids to check existence of.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the edges.default Iterable<Edge> getEdges(Iterable<String> ids, Authorizations authorizations)
ids - The ids of the edges to get.authorizations - The authorizations required to load the edge.default Iterable<Edge> getEdges(Iterable<String> ids, FetchHints fetchHints, Authorizations authorizations)
ids - The ids of the edges to get.fetchHints - Hint at what parts of the edge to fetch.authorizations - The authorizations required to load the edge.default Iterable<Edge> getEdges(Iterable<String> ids, FetchHints fetchHints, Long endTime, Authorizations authorizations)
ids - The ids of the edges to get.fetchHints - Hint at what parts of the edge to fetch.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the edge.@Deprecated default Iterable<String> findRelatedEdges(Iterable<String> vertexIds, Authorizations authorizations)
@Deprecated default Iterable<String> findRelatedEdges(Iterable<String> vertexIds, Long endTime, Authorizations authorizations)
default Iterable<String> findRelatedEdgeIdsForVertices(Iterable<Vertex> verticesIterable, Authorizations authorizations)
verticesIterable - The list of vertices.authorizations - The authorizations required to load the edges.default Iterable<String> findRelatedEdgeIds(Iterable<String> vertexIds, Authorizations authorizations)
vertexIds - The list of vertex ids.authorizations - The authorizations required to load the edges.default Iterable<String> findRelatedEdgeIds(Iterable<String> vertexIds, Long endTime, Authorizations authorizations)
vertexIds - The list of vertex ids.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the edges.default Iterable<RelatedEdge> findRelatedEdgeSummaryForVertices(Iterable<Vertex> verticesIterable, Authorizations authorizations)
verticesIterable - The list of vertices.authorizations - The authorizations required to load the edges.default Iterable<RelatedEdge> findRelatedEdgeSummary(Iterable<String> vertexIds, Authorizations authorizations)
vertexIds - The list of vertex ids.authorizations - The authorizations required to load the edges.default Iterable<RelatedEdge> findRelatedEdgeSummary(Iterable<String> vertexIds, Long endTime, Authorizations authorizations)
vertexIds - The list of vertex ids.endTime - Include all changes made up until the point in time.authorizations - The authorizations required to load the edges.void deleteEdge(Edge edge, Authorizations authorizations)
edge - The edge to delete from the graph.authorizations - The authorizations required to delete the edge.default void deleteEdge(String edgeId, Authorizations authorizations)
edgeId - The edge id of the edge to delete from the graph.authorizations - The authorizations required to delete the edge.default void softDeleteEdge(Edge edge, Authorizations authorizations)
edge - The edge to soft delete from the graph.authorizations - The authorizations required to delete the edge.void softDeleteEdge(Edge edge, Long timestamp, Authorizations authorizations)
edge - The edge to soft delete from the graph.authorizations - The authorizations required to delete the edge.default void softDeleteEdge(String edgeId, Authorizations authorizations)
edgeId - The edge id of the vertex to soft delete from the graph.authorizations - The authorizations required to delete the edge.default void softDeleteEdge(String edgeId, Long timestamp, Authorizations authorizations)
edgeId - The edge id of the vertex to soft delete from the graph.authorizations - The authorizations required to delete the edge.GraphQuery query(String queryString, Authorizations authorizations)
queryString - The string to search for in the text of an element. This will search all fields for the given text.authorizations - The authorizations required to load the elements.GraphQuery query(Authorizations authorizations)
authorizations - The authorizations required to load the elements.MultiVertexQuery query(String[] vertexIds, String queryString, Authorizations authorizations)
vertexIds - The vertex ids to query.queryString - The string to search for in the text of an element. This will search all fields for the given text.authorizations - The authorizations required to load the elements.MultiVertexQuery query(String[] vertexIds, Authorizations authorizations)
vertexIds - The vertex ids to query.authorizations - The authorizations required to load the elements.boolean isQuerySimilarToTextSupported()
SimilarToGraphQuery querySimilarTo(String[] fields, String text, Authorizations authorizations)
fields - The fields to match against.text - The text to find similar to.authorizations - The authorizations required to load the elements.void flush()
void shutdown()
@Deprecated default Iterable<Path> findPaths(String sourceVertexId, String destVertexId, int maxHops, Authorizations authorizations)
findPaths(FindPathOptions, Authorizations)sourceVertexId - The source vertex id to start the search from.destVertexId - The destination vertex id to get to.maxHops - The maximum number of hops to make before giving up.authorizations - The authorizations required to load all edges and vertices.@Deprecated default Iterable<Path> findPaths(String sourceVertexId, String destVertexId, String[] labels, int maxHops, Authorizations authorizations)
findPaths(FindPathOptions, Authorizations)sourceVertexId - The source vertex id to start the search from.destVertexId - The destination vertex id to get to.labels - Edge labelsmaxHops - The maximum number of hops to make before giving up.authorizations - The authorizations required to load all edges and vertices.@Deprecated default Iterable<Path> findPaths(String sourceVertexId, String destVertexId, int maxHops, ProgressCallback progressCallback, Authorizations authorizations)
findPaths(FindPathOptions, Authorizations)sourceVertexId - The source vertex id to start the search from.destVertexId - The destination vertex id to get to.maxHops - The maximum number of hops to make before giving up.progressCallback - Callback used to report progress.authorizations - The authorizations required to load all edges and vertices.@Deprecated default Iterable<Path> findPaths(String sourceVertexId, String destVertexId, String[] labels, int maxHops, ProgressCallback progressCallback, Authorizations authorizations)
findPaths(FindPathOptions, Authorizations)sourceVertexId - The source vertex id to start the search from.destVertexId - The destination vertex id to get to.labels - Edge labelsmaxHops - The maximum number of hops to make before giving up.progressCallback - Callback used to report progress.authorizations - The authorizations required to load all edges and vertices.Iterable<Path> findPaths(FindPathOptions options, Authorizations authorizations)
options - Find path optionsauthorizations - The authorizations required to load all edges and vertices.IdGenerator getIdGenerator()
boolean isVisibilityValid(Visibility visibility, Authorizations authorizations)
visibility - The visibility you want to check.authorizations - The given authorizations.void reindex(Authorizations authorizations)
authorizations - authorizations used to query for the data to reindex.void setMetadata(String key, Object value)
key - The key to the metadata.value - The value to set.void removeMetadata(String key)
key - Object getMetadata(String key)
key - The key to the metadata.void reloadMetadata()
Iterable<GraphMetadataEntry> getMetadata()
Iterable<GraphMetadataEntry> getMetadataWithPrefix(String prefix)
boolean isFieldBoostSupported()
void truncate()
void drop()
SearchIndexSecurityGranularity getSearchIndexSecurityGranularity()
SearchIndexSecurityGranularityvoid addGraphEventListener(GraphEventListener graphEventListener)
void removeGraphEventListener(GraphEventListener graphEventListener)
graphEventListener - The listener to removevoid markVertexHidden(Vertex vertex, Visibility visibility, Authorizations authorizations)
vertex - The vertex to mark hidden.visibility - The visibility string under which this vertex is hidden.
This visibility can be a superset of the vertex visibility to mark
it as hidden for only a subset of authorizations.authorizations - The authorizations used.void markVertexVisible(Vertex vertex, Visibility visibility, Authorizations authorizations)
vertex - The vertex to mark visible.visibility - The visibility string under which this vertex is now visible.authorizations - The authorizations used.void markEdgeHidden(Edge edge, Visibility visibility, Authorizations authorizations)
edge - The edge to mark hidden.visibility - The visibility string under which this edge is hidden.
This visibility can be a superset of the edge visibility to mark
it as hidden for only a subset of authorizations.authorizations - The authorizations used.void markEdgeVisible(Edge edge, Visibility visibility, Authorizations authorizations)
edge - The edge to mark visible.visibility - The visibility string under which this edge is now visible.authorizations - The authorizations used.Authorizations createAuthorizations(String... auths)
auths - The authorizations granted.default Authorizations createAuthorizations(Collection<String> auths)
auths - The authorizations granted.Authorizations createAuthorizations(Authorizations auths, String... additionalAuthorizations)
auths - The authorizations granted.additionalAuthorizations - additional authorizationsdefault Authorizations createAuthorizations(Authorizations auths, Collection<String> additionalAuthorizations)
auths - The authorizations granted.additionalAuthorizations - additional authorizationsdefault Map<Object,Long> getVertexPropertyCountByValue(String propertyName, Authorizations authorizations)
propertyName - The name of the property to findauthorizations - The authorizations to use to find the propertydefault long getVertexCount(Authorizations authorizations)
default long getEdgeCount(Authorizations authorizations)
void savePropertyDefinition(PropertyDefinition propertyDefinition)
propertyDefinition - the property definition to save.default DefinePropertyBuilder defineProperty(String propertyName)
propertyName - The name of the property to define.boolean isPropertyDefined(String propertyName)
PropertyDefinition getPropertyDefinition(String propertyName)
propertyName - name of the propertyvoid removePropertyDefinition(String propertyName)
propertyName - Collection<PropertyDefinition> getPropertyDefinitions()
Iterable<Element> saveElementMutations(Iterable<ElementMutation<? extends Element>> mutations, Authorizations authorizations)
mutations - the mutations to saveauthorizations - the authorizations used during savedefault List<InputStream> getStreamingPropertyValueInputStreams(List<StreamingPropertyValue> streamingPropertyValues)
streamingPropertyValues - list of StreamingPropertyValues to get input streams fordefault Iterable<ExtendedDataRow> getExtendedData(Iterable<ExtendedDataRowId> ids, Authorizations authorizations)
ids - The ids of the rows to get.authorizations - The authorizations used to get the rowsIterable<ExtendedDataRow> getExtendedData(Iterable<ExtendedDataRowId> ids, FetchHints fetchHints, Authorizations authorizations)
ids - The ids of the rows to get.authorizations - The authorizations used to get the rowsdefault ExtendedDataRow getExtendedData(ExtendedDataRowId id, Authorizations authorizations)
id - The id of the row to get.authorizations - The authorizations used to get the rowsdefault Iterable<ExtendedDataRow> getExtendedData(ElementType elementType, String elementId, String tableName, Authorizations authorizations)
elementType - The type of element to get the rows fromelementId - The element id to get the rows fromtableName - The name of the table within the element to get the rows fromauthorizations - The authorizations used to get the rowsdefault Iterable<ExtendedDataRow> getExtendedData(ElementId elementId, String tableName, Authorizations authorizations)
elementId - The element id to get the rows fromtableName - The name of the table within the element to get the rows fromauthorizations - The authorizations used to get the rowsdefault Iterable<ExtendedDataRow> getExtendedData(ElementType elementType, String elementId, String tableName, FetchHints fetchHints, Authorizations authorizations)
elementType - The type of element to get the rows fromelementId - The element id to get the rows fromtableName - The name of the table within the element to get the rows fromfetchHints - Fetch hints to filter extended dataauthorizations - The authorizations used to get the rowsdefault Iterable<ExtendedDataRow> getExtendedData(ElementId elementId, String tableName, FetchHints fetchHints, Authorizations authorizations)
elementId - The element id to get the rows fromtableName - The name of the table within the element to get the rows fromfetchHints - Fetch hints to filter extended dataauthorizations - The authorizations used to get the rowsdefault Iterable<ExtendedDataRow> getExtendedDataForElements(Iterable<? extends ElementId> elementIds, Authorizations authorizations)
elementIds - The element ids of the elements to get the rows fromauthorizations - The authorizations used to get the rowsdefault Iterable<ExtendedDataRow> getExtendedDataForElements(Iterable<? extends ElementId> elementIds, String tableName, Authorizations authorizations)
elementIds - The element ids of the elements to get the rows fromtableName - The name of the table within the element to get the rows fromauthorizations - The authorizations used to get the rowsdefault Iterable<ExtendedDataRow> getExtendedDataForElements(Iterable<? extends ElementId> elementIds, FetchHints fetchHints, Authorizations authorizations)
elementIds - The element ids of the elements to get the rows fromfetchHints - Fetch hints to filter extended dataauthorizations - The authorizations used to get the rowsIterable<ExtendedDataRow> getExtendedDataForElements(Iterable<? extends ElementId> elementIds, String tableName, FetchHints fetchHints, Authorizations authorizations)
elementIds - The element ids of the elements to get the rows fromtableName - The name of the table within the element to get the rows fromfetchHints - Fetch hints to filter extended dataauthorizations - The authorizations used to get the rowsIterable<ExtendedDataRow> getExtendedDataInRange(ElementType elementType, IdRange elementIdRange, Authorizations authorizations)
elementType - The type of element to get the rows fromelementIdRange - The range of element ids to get extended data rows for.authorizations - The authorizations required to load the vertex.void deleteExtendedDataRow(ExtendedDataRowId id, Authorizations authorizations)
FetchHints getDefaultFetchHints()
default void visitElements(GraphVisitor graphVisitor, Authorizations authorizations)
default void visitVertices(GraphVisitor graphVisitor, Authorizations authorizations)
default void visitEdges(GraphVisitor graphVisitor, Authorizations authorizations)
default void visit(Iterable<? extends Element> elements, GraphVisitor visitor)
void dumpGraph()
GeMetricRegistry getMetricsRegistry()
default NameSubstitutionStrategy getNameSubstitutionStrategy()
Copyright © 2016–2021 MWARE SOLUTIONS. All rights reserved.