MutableEdge
#
Bases: Edge
__repr__()
#
Return repr(self).
add_metadata(metadata, layer=None)
#
Add metadata to an edge in the graph. This function is used to add properties to an edge that do not change over time. These properties are fundamental attributes of the edge.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
metadata
|
PropInput
|
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, secondary_index=None)
#
Add updates to an edge in the 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
|
TimeInput
|
The timestamp at which the updates should be applied. |
required |
properties
|
PropInput
|
A dictionary of properties to update. |
None
|
layer
|
str
|
The layer you want these properties to be added on to. |
None
|
secondary_index
|
int
|
The optional integer which will be used as a secondary index |
None
|
Returns:
| Type | Description |
|---|---|
None
|
This function does not return a value, if the operation is successful. |
Raises:
| Type | Description |
|---|---|
GraphError
|
If the operation fails. |
delete(t, layer=None)
#
Mark the edge as deleted at the specified time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
t
|
TimeInput
|
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(metadata, layer=None)
#
Update metadata of an edge in the 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 |
|---|---|---|---|
metadata
|
PropInput
|
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
|
|