Package org.neo4j.gds.api

Interface GraphStore

All Known Subinterfaces:

GraphStoreWrapper

All Known Implementing Classes:

CSRGraphStore, GraphStoreAdapter

public interface GraphStore

Method Summary

Modifier and Type	Method	Description
void	addGraphProperty(java.lang.String propertyKey, GraphPropertyValues propertyValues)
void	addInverseIndex(org.neo4j.gds.RelationshipType relationshipType, Topology topology, java.util.Optional<RelationshipPropertyStore> properties)
void	addNodeLabel(org.neo4j.gds.NodeLabel nodeLabel)	Add a new Node label to the Graph Store.
void	addNodeProperty(java.util.Set<org.neo4j.gds.NodeLabel> nodeLabels, java.lang.String propertyKey, NodePropertyValues propertyValues)
void	addRelationshipType(SingleTypeRelationships relationships)
Capabilities	capabilities()
DatabaseId	databaseId()
DeletionResult	deleteRelationships(org.neo4j.gds.RelationshipType relationshipType)
CompositeRelationshipIterator	getCompositeRelationshipIterator(org.neo4j.gds.RelationshipType relationshipType, java.util.Collection<java.lang.String> propertyKeys)
default Graph	getGraph(java.lang.String relationshipProperty)
default Graph	getGraph(java.lang.String nodeLabel, java.lang.String relationshipType, java.util.Optional<java.lang.String> maybeRelationshipProperty)
Graph	getGraph(java.util.Collection<org.neo4j.gds.NodeLabel> nodeLabels)	Returns a graph containing only nodes with the given node labels and no relationships.
Graph	getGraph(java.util.Collection<org.neo4j.gds.NodeLabel> nodeLabels, java.util.Collection<org.neo4j.gds.RelationshipType> relationshipTypes, java.util.Optional<java.lang.String> maybeRelationshipProperty)
default Graph	getGraph(java.util.Collection<org.neo4j.gds.RelationshipType> relationshipTypes, java.util.Optional<java.lang.String> maybeRelationshipProperty)
default Graph	getGraph(org.neo4j.gds.NodeLabel nodeLabel)	Returns a graph containing only nodes with the given node label and no relationships.
default Graph	getGraph(org.neo4j.gds.NodeLabel nodeLabel, org.neo4j.gds.RelationshipType relationshipType, java.util.Optional<java.lang.String> maybeRelationshipProperty)
default Graph	getGraph(org.neo4j.gds.RelationshipType... relationshipType)
default Graph	getGraph(org.neo4j.gds.RelationshipType relationshipType, java.util.Optional<java.lang.String> relationshipProperty)
Graph	getUnion()
GraphProperty	graphProperty(java.lang.String propertyKey)
java.util.Set<java.lang.String>	graphPropertyKeys()
org.neo4j.gds.api.nodeproperties.ValueType	graphPropertyType(java.lang.String propertyKey)
GraphPropertyValues	graphPropertyValues(java.lang.String propertyKey)
boolean	hasGraphProperty(java.lang.String propertyKey)
boolean	hasNodeProperty(java.lang.String propertyKey)
boolean	hasNodeProperty(java.util.Collection<org.neo4j.gds.NodeLabel> labels, java.lang.String propertyKey)
boolean	hasNodeProperty(org.neo4j.gds.NodeLabel label, java.lang.String propertyKey)
boolean	hasRelationshipProperty(org.neo4j.gds.RelationshipType relType, java.lang.String propertyKey)
boolean	hasRelationshipType(org.neo4j.gds.RelationshipType relationshipType)
java.util.Set<org.neo4j.gds.RelationshipType>	inverseIndexedRelationshipTypes()
java.time.ZonedDateTime	modificationTime()
long	nodeCount()
java.util.Set<org.neo4j.gds.NodeLabel>	nodeLabels()
NodeProperty	nodeProperty(java.lang.String propertyKey)
java.util.Set<java.lang.String>	nodePropertyKeys()
default java.util.Collection<java.lang.String>	nodePropertyKeys(java.util.Collection<org.neo4j.gds.NodeLabel> labels)
java.util.Set<java.lang.String>	nodePropertyKeys(org.neo4j.gds.NodeLabel label)
IdMap	nodes()
long	relationshipCount()
long	relationshipCount(org.neo4j.gds.RelationshipType relationshipType)
java.util.Set<java.lang.String>	relationshipPropertyKeys()
default java.util.Collection<java.lang.String>	relationshipPropertyKeys(java.util.Collection<org.neo4j.gds.RelationshipType> relTypes)
java.util.Set<java.lang.String>	relationshipPropertyKeys(org.neo4j.gds.RelationshipType relationshipType)
org.neo4j.gds.api.nodeproperties.ValueType	relationshipPropertyType(java.lang.String propertyKey)
RelationshipProperty	relationshipPropertyValues(org.neo4j.gds.RelationshipType relationshipType, java.lang.String propertyKey)
java.util.Set<org.neo4j.gds.RelationshipType>	relationshipTypes()
void	removeGraphProperty(java.lang.String propertyKey)
void	removeNodeProperty(java.lang.String propertyKey)
org.neo4j.gds.api.schema.GraphSchema	schema()

Method Detail

databaseId

DatabaseId databaseId()

schema

org.neo4j.gds.api.schema.GraphSchema schema()

modificationTime

java.time.ZonedDateTime modificationTime()

capabilities

Capabilities capabilities()

graphPropertyKeys

java.util.Set<java.lang.String> graphPropertyKeys()

hasGraphProperty

boolean hasGraphProperty(java.lang.String propertyKey)

graphProperty

GraphProperty graphProperty(java.lang.String propertyKey)

graphPropertyType

org.neo4j.gds.api.nodeproperties.ValueType graphPropertyType(java.lang.String propertyKey)

graphPropertyValues

GraphPropertyValues graphPropertyValues(java.lang.String propertyKey)

addGraphProperty

void addGraphProperty(java.lang.String propertyKey,
                      GraphPropertyValues propertyValues)

removeGraphProperty

void removeGraphProperty(java.lang.String propertyKey)

nodeCount

long nodeCount()

nodes

IdMap nodes()

nodeLabels

java.util.Set<org.neo4j.gds.NodeLabel> nodeLabels()

addNodeLabel

void addNodeLabel(org.neo4j.gds.NodeLabel nodeLabel)

Add a new Node label to the Graph Store.

Parameters:

nodeLabel - the Node label to add

nodePropertyKeys

java.util.Set<java.lang.String> nodePropertyKeys(org.neo4j.gds.NodeLabel label)

nodePropertyKeys

java.util.Set<java.lang.String> nodePropertyKeys()

hasNodeProperty

boolean hasNodeProperty(java.lang.String propertyKey)

hasNodeProperty

boolean hasNodeProperty(org.neo4j.gds.NodeLabel label,
                        java.lang.String propertyKey)

hasNodeProperty

boolean hasNodeProperty(java.util.Collection<org.neo4j.gds.NodeLabel> labels,
                        java.lang.String propertyKey)

nodePropertyKeys

default java.util.Collection<java.lang.String> nodePropertyKeys(java.util.Collection<org.neo4j.gds.NodeLabel> labels)

nodeProperty

NodeProperty nodeProperty(java.lang.String propertyKey)

addNodeProperty

void addNodeProperty(java.util.Set<org.neo4j.gds.NodeLabel> nodeLabels,
                     java.lang.String propertyKey,
                     NodePropertyValues propertyValues)

removeNodeProperty

void removeNodeProperty(java.lang.String propertyKey)

relationshipCount

long relationshipCount()

relationshipCount

long relationshipCount(org.neo4j.gds.RelationshipType relationshipType)

relationshipTypes

java.util.Set<org.neo4j.gds.RelationshipType> relationshipTypes()

hasRelationshipType

boolean hasRelationshipType(org.neo4j.gds.RelationshipType relationshipType)

inverseIndexedRelationshipTypes

java.util.Set<org.neo4j.gds.RelationshipType> inverseIndexedRelationshipTypes()

hasRelationshipProperty

boolean hasRelationshipProperty(org.neo4j.gds.RelationshipType relType,
                                java.lang.String propertyKey)

relationshipPropertyKeys

default java.util.Collection<java.lang.String> relationshipPropertyKeys(java.util.Collection<org.neo4j.gds.RelationshipType> relTypes)

relationshipPropertyType

org.neo4j.gds.api.nodeproperties.ValueType relationshipPropertyType(java.lang.String propertyKey)

relationshipPropertyKeys

java.util.Set<java.lang.String> relationshipPropertyKeys()

relationshipPropertyKeys

java.util.Set<java.lang.String> relationshipPropertyKeys(org.neo4j.gds.RelationshipType relationshipType)

relationshipPropertyValues

RelationshipProperty relationshipPropertyValues(org.neo4j.gds.RelationshipType relationshipType,
                                                java.lang.String propertyKey)

addRelationshipType

void addRelationshipType(SingleTypeRelationships relationships)

addInverseIndex

void addInverseIndex(org.neo4j.gds.RelationshipType relationshipType,
                     Topology topology,
                     java.util.Optional<RelationshipPropertyStore> properties)

deleteRelationships

DeletionResult deleteRelationships(org.neo4j.gds.RelationshipType relationshipType)

getGraph

default Graph getGraph(org.neo4j.gds.RelationshipType... relationshipType)

getGraph

default Graph getGraph(java.lang.String relationshipProperty)

getGraph

default Graph getGraph(org.neo4j.gds.RelationshipType relationshipType,
                       java.util.Optional<java.lang.String> relationshipProperty)

getGraph

default Graph getGraph(java.util.Collection<org.neo4j.gds.RelationshipType> relationshipTypes,
                       java.util.Optional<java.lang.String> maybeRelationshipProperty)

getGraph

default Graph getGraph(java.lang.String nodeLabel,
                       java.lang.String relationshipType,
                       java.util.Optional<java.lang.String> maybeRelationshipProperty)

getGraph

default Graph getGraph(org.neo4j.gds.NodeLabel nodeLabel)

Returns a graph containing only nodes with the given node label and no relationships.

Parameters:

nodeLabel - node label filter

Returns:

a node-only graph

getGraph

Graph getGraph(java.util.Collection<org.neo4j.gds.NodeLabel> nodeLabels)

Returns a graph containing only nodes with the given node labels and no relationships.

Parameters:

nodeLabels - node label filter

Returns:

a node-only graph

getGraph

default Graph getGraph(org.neo4j.gds.NodeLabel nodeLabel,
                       org.neo4j.gds.RelationshipType relationshipType,
                       java.util.Optional<java.lang.String> maybeRelationshipProperty)

getGraph

Graph getGraph(java.util.Collection<org.neo4j.gds.NodeLabel> nodeLabels,
               java.util.Collection<org.neo4j.gds.RelationshipType> relationshipTypes,
               java.util.Optional<java.lang.String> maybeRelationshipProperty)

getUnion

Graph getUnion()

getCompositeRelationshipIterator

CompositeRelationshipIterator getCompositeRelationshipIterator(org.neo4j.gds.RelationshipType relationshipType,
                                                               java.util.Collection<java.lang.String> propertyKeys)