RemoteEdge#

class RemoteEdge#

Bases: object

A remote edge reference

Returned by RemoteGraph.edge(), RemoteGraph.add_edge(), and RemoteGraph.delete_edge().

Methods:

add_constant_properties(properties[, layer])

Add constant properties to the edge within the remote graph.

add_updates(t[, properties, layer])

Add updates to an edge in the remote graph at a specified time.

delete(t[, layer])

Mark the edge as deleted at the specified time.

update_constant_properties(properties[, layer])

Update constant properties of an edge in the remote graph overwriting existing values.
add_constant_properties(properties, layer=None)#

Add constant properties to the edge within the remote graph. This function is used to add properties to an edge that remain constant and do not change over time. These properties are fundamental attributes of the edge.

Parameters:

  • properties (Dict[str, Prop]) – A dictionary of properties to be added to the edge.

  • layer (str, optional) – The layer you want these properties to be added on to.

Return type:

None

add_updates(t, properties=None, layer=None)#

Add updates to an edge in the remote graph at a specified time.

This function allows for the addition of property updates to an edge within the graph. The updates are time-stamped, meaning they are applied at the specified time.

Parameters:

  • t (int | str | datetime) – The timestamp at which the updates should be applied.

  • properties (Optional[Dict[str, Prop]]) – A dictionary of properties to update.

  • layer (str, optional) – The layer you want the updates to be applied.

Return type:

None

delete(t, layer=None)#

Mark the edge as deleted at the specified time.

Parameters:

  • t (int | str | datetime) – The timestamp at which the deletion should be applied.

  • layer (str, optional) – The layer you want the deletion applied to.

Return type:

None

update_constant_properties(properties, layer=None)#

Update constant properties of an edge in the remote graph overwriting existing values. This function is used to add properties to an edge that remains constant and does not change over time. These properties are fundamental attributes of the edge.

Parameters:

  • properties (Dict[str, Prop]) – A dictionary of properties to be added to the edge.

  • layer (str, optional) – The layer you want these properties to be added on to.

Return type:

None