Skip to content

Commit ae24f31

Browse files
committed
Include streaming a single property in client graph catalog docs
1 parent 4fb3c19 commit ae24f31

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

doc/modules/ROOT/pages/python-client/graph-object.adoc

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -180,16 +180,14 @@ gds.graph.drop(G) # same as G.drop()
180180

181181
==== Streaming properties
182182

183-
The calls xref:graph-catalog-node-ops.adoc#catalog-graph-stream-node-properties-example[`gds.graph.streamNodeProperties`] and xref:graph-catalog-relationship-ops.adoc#catalog-graph-stream-relationship-properties-example[`gds.graph.streamRelationshipProperties`] have additional functionality in the client.
183+
The client methods
184184

185+
* xref:graph-catalog-node-ops.adoc[`gds.graph.streamNodeProperty`]
186+
* xref:graph-catalog-node-ops.adoc[`gds.graph.streamNodeProperties`]
187+
* xref:graph-catalog-relationship-ops.adoc[`gds.graph.streamRelationshipProperty`]
188+
* xref:graph-catalog-relationship-ops.adoc[`gds.graph.streamRelationshipProperties`]
185189

186-
===== Separate columns
190+
are greatly sped up if xref::installation/installation-apache-arrow.adoc[Arrow Flight Server] of GDS is enabled.
187191

188-
Setting the client only optional keyword parameter `separate_property_columns=True` (it defaults to `False`) for `gds.graph.streamNodeProperties` and `gds.graph.streamRelationshipProperties` returns a pandas `DataFrame` in which each property requested has its own column.
192+
Additionally, setting the client only optional keyword parameter `separate_property_columns=True` (it defaults to `False`) for `gds.graph.streamNodeProperties` and `gds.graph.streamRelationshipProperties` returns a pandas `DataFrame` in which each property requested has its own column.
189193
Note that this is different from the default behavior for which there would only be one column called `propertyValue` that contains all properties requested interleaved for each node or relationship.
190-
191-
192-
[.enterprise-edition]
193-
===== Arrow flight server support
194-
195-
If the xref::installation/installation-apache-arrow.adoc[Arrow Flight Server] of GDS is enabled, the client `gds.graph.streamNodeProperties` and `gds.graph.streamRelationshipProperties` calls are greatly sped up.

0 commit comments

Comments
 (0)