Method add_edges

python/graphscope/framework/graph.py:552–713

Add edges to the graph, and return a new graph. Here the src_label and dst_label must be both specified or both unspecified, i. src_label and dst_label both unspecified and current graph has no vertex label. We deduce vertex label from edge table, and set vertex label n

(
        self,
        edges,
        label="_e",
        properties=None,
        src_label=None,
        dst_label=None,
        src_field: Union[int, str] = 0,
        dst_field: Union[int, str] = 1,
    )

        return graph_dag_node

    def add_edges(
        self,
        edges,
        label="_e",
        properties=None,
        src_label=None,
        dst_label=None,
        src_field: Union[int, str] = 0,
        dst_field: Union[int, str] = 1,
    ):
        """Add edges to the graph, and return a new graph.
        Here the src_label and dst_label must be both specified or both unspecified,

        i. src_label and dst_label both unspecified and current graph has no vertex label.

            We deduce vertex label from edge table, and set vertex label name to '_'.

        ii. src_label and dst_label both unspecified and current graph has one vertex label.

            We set src_label and dst label to this single vertex label.

        ii. src_label and dst_label both specified and existed in current graph's vertex labels.

        iii. src_label and dst_label both specified and some are not existed in current graph's vertex labels.

            We deduce missing vertex labels from edge tables.


        Args:
            edges (Union[str, Loader]): Edge data source.
            label (str, optional): Edge label name. Defaults to "_e".
            properties (list[str], optional): List of column names loaded as properties. Defaults to None.
            src_label (str, optional): Source vertex label. Defaults to None.
            dst_label (str, optional): Destination vertex label. Defaults to None.
            src_field (int, optional): Column index or name used as src field. Defaults to 0.
            dst_field (int, optional): Column index or name used as dst field. Defaults to 1.

        Raises:
            ValueError: If the given value is invalid or conflict with current graph.

        Returns:
            :class:`graphscope.framework.graph.GraphDAGNode`:
                A new graph with edge added, evaluated in eager mode.
        """
        if self._compact_edges:
            raise ValueError(
                "Cannot incrementally add edges to graphs with compacted edges, "
                "please use `graphscope.load_from()` instead."
            )
        if src_label is None and dst_label is None:
            check_argument(
                len(self._v_labels) <= 1,
                "Ambiguous vertex label, please specify the src_label and dst_label.",
            )
            if len(self._v_labels) == 1:
                src_label = dst_label = self._v_labels[0]
            else:
                src_label = dst_label = "_"