Skip to content

PropertygraphSummary

Source code in docs_src/capo_neptunedata/types/propertygraph_summary.py
class PropertygraphSummary(TypedDict, closed=True):
    num_nodes: NotRequired["int"]
    """<p>The number of nodes in the graph.</p>"""
    num_edges: NotRequired["int"]
    """<p>The number of edges in the graph.</p>"""
    num_node_labels: NotRequired["int"]
    """<p>The number of distinct node labels in the graph.</p>"""
    num_edge_labels: NotRequired["int"]
    """<p>The number of distinct edge labels in the graph.</p>"""
    node_labels: NotRequired["capo_neptunedata.types.node_labels.NodeLabels"]
    """<p>A list of the distinct node labels in the graph.</p>"""
    edge_labels: NotRequired["capo_neptunedata.types.edge_labels.EdgeLabels"]
    """<p>A list of the distinct edge labels in the graph.</p>"""
    num_node_properties: NotRequired["int"]
    """<p>A list of the distinct node properties in the graph, along with the count of nodes where each property is used.</p>"""
    num_edge_properties: NotRequired["int"]
    """<p>The number of distinct edge properties in the graph.</p>"""
    node_properties: NotRequired[
        "capo_neptunedata.types.long_valued_map_list.LongValuedMapList"
    ]
    """<p>The number of distinct node properties in the graph.</p>"""
    edge_properties: NotRequired[
        "capo_neptunedata.types.long_valued_map_list.LongValuedMapList"
    ]
    """<p>A list of the distinct edge properties in the graph, along with the count of edges where each property is used.</p>"""
    total_node_property_values: NotRequired["int"]
    """<p>The total number of usages of all node properties.</p>"""
    total_edge_property_values: NotRequired["int"]
    """<p>The total number of usages of all edge properties.</p>"""
    node_structures: NotRequired[
        "capo_neptunedata.types.node_structures.NodeStructures"
    ]
    """<p>This field is only present when the requested mode is <code>DETAILED</code>. It contains a list of node structures.</p>"""
    edge_structures: NotRequired[
        "capo_neptunedata.types.edge_structures.EdgeStructures"
    ]
    """<p>This field is only present when the requested mode is <code>DETAILED</code>. It contains a list of edge structures.</p>"""

edge_labels instance-attribute

edge_labels: NotRequired[EdgeLabels]

A list of the distinct edge labels in the graph.

edge_properties instance-attribute

edge_properties: NotRequired[LongValuedMapList]

A list of the distinct edge properties in the graph, along with the count of edges where each property is used.

edge_structures instance-attribute

edge_structures: NotRequired[EdgeStructures]

This field is only present when the requested mode is DETAILED. It contains a list of edge structures.

node_labels instance-attribute

node_labels: NotRequired[NodeLabels]

A list of the distinct node labels in the graph.

node_properties instance-attribute

node_properties: NotRequired[LongValuedMapList]

The number of distinct node properties in the graph.

node_structures instance-attribute

node_structures: NotRequired[NodeStructures]

This field is only present when the requested mode is DETAILED. It contains a list of node structures.

num_edge_labels instance-attribute

num_edge_labels: NotRequired[int]

The number of distinct edge labels in the graph.

num_edge_properties instance-attribute

num_edge_properties: NotRequired[int]

The number of distinct edge properties in the graph.

num_edges instance-attribute

num_edges: NotRequired[int]

The number of edges in the graph.

num_node_labels instance-attribute

num_node_labels: NotRequired[int]

The number of distinct node labels in the graph.

num_node_properties instance-attribute

num_node_properties: NotRequired[int]

A list of the distinct node properties in the graph, along with the count of nodes where each property is used.

num_nodes instance-attribute

num_nodes: NotRequired[int]

The number of nodes in the graph.

total_edge_property_values instance-attribute

total_edge_property_values: NotRequired[int]

The total number of usages of all edge properties.

total_node_property_values instance-attribute

total_node_property_values: NotRequired[int]

The total number of usages of all node properties.