The function has two required input tables, vertices and edges. Each row of the vertices table represents a vertex of the graph and each row of the edges table represents an edge of the graph.
As a legacy, the function has an optional input table, sources, which specifies the vertices that are sources. For a directed graph, this table was required. The function now ignores this optional table and treats all graphs as undirected.
Column Name | Data Type | Description |
---|---|---|
vertex_key_column | Any allowed in PARTITION BY clause | Column that is, or is part of, the unique vertex key. Every column that is part of this key must appear in the PARTITION BY clause. This column cannot contain NULL values. |
accumulate_column | Any | Column to copy to the community vertex table. |
Column Name | Data Type | Description |
---|---|---|
source_vertex_key_column | Any allowed in PARTITION BY clause | Column that is, or is part of, the key that identifies the source vertex of the edge. This key must be a vertex key in the vertices table. Every column that is part of this key must appear in the PARTITION BY clause. This column cannot contain NULL values. |
target_key_column | Same as data type of source_vertex_key_column | Column that is, or is part of, the key that identifies the target vertex of the edge. This key must be a vertex key in the vertices table and must be specified by the TargetKey argument. This column can contain NULL values. |
edge_weight | SMALLINT, INTEGER, or NUMERIC | Column that contains the weights of the edges, which must be positive values. This column is required only for a weighted graph. This column can contain NULL values. |
Column Name | Data Type | Description |
---|---|---|
source_vertex_key_column | Same as data type of corresponding vertex_key_column in vertices table | Column that is, or is part of, the key that identifies a source vertex. This key must be a vertex key in the vertices table. Every column that is part of this key must appear in the PARTITION BY clause. |