Graph object¶

class graphdatascience.graph.graph_object.Graph¶

A graph object that represents a graph in the graph catalog. It can be passed into algorithm endpoints to compute over the corresponding graph. It contains summary information about the graph.

configuration() → Series[Any]¶

Returns:: the configuration of the graph

creation_time() → Any¶

Returns:: the creation time of the graph

database() → str¶

Returns:: the name of the database the graph is stored in

degree_distribution() → Series[float]¶

Returns:: the degree distribution of the graph

density() → float¶

Returns:: the density of the graph

drop(failIfMissing: bool = False) → Series[str]¶

Parameters:: failIfMissing – whether to fail if the graph does not exist
Returns:: the result of the drop operation

exists() → bool¶

Returns:: whether the graph exists

memory_usage() → str¶

Returns:: the memory usage of the graph

modification_time() → Any¶

Returns:: the modification time of the graph

name() → str¶

Returns:: the name of the graph

node_count() → int¶

Returns:: the number of nodes in the graph

node_labels() → list[str]¶

Returns:: the node labels in the graph

node_properties(label: str | None = None) → Series[str] | list[str]¶

Parameters:: label – the node label to get the properties for
Returns:: the node properties for the given label

relationship_count() → int¶

Returns:: the number of relationships in the graph

relationship_properties(type: str | None = None) → Series[str] | list[str]¶

Parameters:: type – the relationship type to get the properties for
Returns:: the relationship properties for the given type

relationship_types() → list[str]¶

Returns:: the relationship types in the graph

size_in_bytes() → int¶

Returns:: the size of the graph in bytes