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
- Return type:
Series[Any]
-
creation_time() → Any
- Returns:
the creation time of the graph
- Return type:
Any
-
database() → str
- Returns:
the name of the database the graph is stored in
- Return type:
str
-
degree_distribution() → Series[float]
- Returns:
the degree distribution of the graph
- Return type:
Series[float]
-
density() → float
- Returns:
the density of the graph
- Return type:
float
-
drop(failIfMissing: bool = False) → Series[str]
- Parameters:
failIfMissing (bool) – whether to fail if the graph does not exist
- Returns:
the result of the drop operation
- Return type:
Series[str]
-
exists() → bool
- Returns:
whether the graph exists
- Return type:
bool
-
memory_usage() → str
- Returns:
the memory usage of the graph
- Return type:
str
-
modification_time() → Any
- Returns:
the modification time of the graph
- Return type:
Any
-
name() → str
- Returns:
the name of the graph
- Return type:
str
-
node_count() → int
- Returns:
the number of nodes in the graph
- Return type:
int
-
node_labels() → list[str]
- Returns:
the node labels in the graph
- Return type:
list[str]
-
node_properties(label: str | None = None) → Series[str] | list[str]
- Parameters:
label (str | None) – the node label to get the properties for
- Returns:
the node properties for the given label
- Return type:
Series[str] | list[str]
-
relationship_count() → int
- Returns:
the number of relationships in the graph
- Return type:
int
-
relationship_properties(type: str | None = None) → Series[str] | list[str]
- Parameters:
type (str | None) – the relationship type to get the properties for
- Returns:
the relationship properties for the given type
- Return type:
Series[str] | list[str]
-
relationship_types() → list[str]
- Returns:
the relationship types in the graph
- Return type:
list[str]
-
size_in_bytes() → int
- Returns:
the size of the graph in bytes
- Return type:
int