RemoteEdge
#
Bases: object
A remote edge reference
Returned by RemoteGraph.edge, RemoteGraph.add_edge, and RemoteGraph.delete_edge.
add_metadata(properties, layer=None)
#
Add metadata to the edge within the remote graph. This function is used to add metadata to an edge that does not change over time. This metadata is fundamental information of the edge.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
properties
|
dict[str, PropValue]
|
A dictionary of properties to be added to the edge. |
required |
layer
|
str
|
The layer you want these properties to be added on to. |
None
|
Returns:
| Type | Description |
|---|---|
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:
| Name | Type | Description | Default |
|---|---|---|---|
t
|
int | str | datetime
|
The timestamp at which the updates should be applied. |
required |
properties
|
dict[str, PropValue]
|
A dictionary of properties to update. |
None
|
layer
|
str
|
The layer you want the updates to be applied. |
None
|
Returns:
| Type | Description |
|---|---|
None
|
|
delete(t, layer=None)
#
Mark the edge as deleted at the specified time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
t
|
int | str | datetime
|
The timestamp at which the deletion should be applied. |
required |
layer
|
str
|
The layer you want the deletion applied to. |
None
|
Returns:
| Type | Description |
|---|---|
None
|
|
Raises:
| Type | Description |
|---|---|
GraphError
|
If the operation fails. |
update_metadata(properties, layer=None)
#
Update metadata of an edge in the remote graph overwriting existing values. This function is used to add properties to an edge that does not change over time. These properties are fundamental attributes of the edge.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
properties
|
dict[str, PropValue]
|
A dictionary of properties to be added to the edge. |
required |
layer
|
str
|
The layer you want these properties to be added on to. |
None
|
Returns:
| Type | Description |
|---|---|
None
|
|