Class GraphDAGNode

python/graphscope/framework/graph.py:225–868

A class represents a graph node in a DAG. In GraphScope, all operations that generate a new graph will return a instance of :class:`GraphDAGNode`, which will be automatically executed by :meth:`Session.run` in `eager` mode. The following example demonstrates its usage: .. code

class GraphDAGNode(DAGNode, GraphInterface):
    """A class represents a graph node in a DAG.

    In GraphScope, all operations that generate a new graph will return
    a instance of :class:`GraphDAGNode`, which will be automatically
    executed by :meth:`Session.run` in `eager` mode.

    The following example demonstrates its usage:

    .. code:: python

        >>> # lazy mode
        >>> import graphscope as gs
        >>> sess = gs.session(mode="lazy")
        >>> g = sess.g()
        >>> g1 = g.add_vertices("person.csv","person")
        >>> print(g1) # <graphscope.framework.graph.GraphDAGNode object>
        >>> g2 = sess.run(g1)
        >>> print(g2) # <graphscope.framework.graph.Graph object>

        >>> # eager mode
        >>> import graphscope as gs
        >>> sess = gs.session(mode="eager")
        >>> g = sess.g()
        >>> g1 = g.add_vertices("person.csv","person")
        >>> print(g1) # <graphscope.framework.graph.Graph object>
        >>> del g1
    """

    def __init__(
        self,
        session,
        incoming_data=None,
        oid_type="int64",
        vid_type="uint64",
        directed=True,
        generate_eid=True,
        retain_oid=True,
        vertex_map: Union[str, int] = "global",
        compact_edges=False,
        use_perfect_hash=False,
    ):
        """Construct a :class:`GraphDAGNode` object.

        Args:
            session (:class:`Session`): A graphscope session instance.
            incoming_data: Graph can be initialized through various type of sources,
                which can be one of:

                - :class:`graphscope.framework.operation.Operation`
                - :class:`graphscope.nx.Graph`
                - :class:`graphscope.Graph`
                - :class:`vineyard.Object`, :class:`vineyard.ObjectId` or :class:`vineyard.ObjectName`

            oid_type: (str, optional): Type of vertex original id. Defaults to "int64".
            vid_type: (str, optional): Type of vertex internal id. Defaults to "uint64".
            directed: (bool, optional): Directed graph or not. Defaults to True.
            generate_eid: (bool, optional): Generate id for each edge when set True. Defaults to True.