Edge
#
Bases: object
Entry point for constructing edge filter expressions.
The Edge filter provides:
- endpoint filters via src() and dst(),
- property and metadata filters,
- view restrictions (time windows, snapshots, layers),
- and structural predicates over edge state (active/valid/deleted/self-loop).
Examples:
Edge.src().id() == 1 Edge.property("weight") > 0.5 Edge.window(0, 10).is_active() Edge.layer("fire_nation").is_valid()
after(time)
staticmethod
#
Restricts edge evaluation to times strictly after the given time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
int
|
Lower time bound. |
required |
Returns:
| Type | Description |
|---|---|
|
filter.EdgeViewPropsFilterBuilder |
at(time)
staticmethod
#
Restricts edge evaluation to a single point in time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
int
|
Event time. |
required |
Returns:
| Type | Description |
|---|---|
|
filter.EdgeViewPropsFilterBuilder |
before(time)
staticmethod
#
Restricts edge evaluation to times strictly before the given time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
int
|
Upper time bound. |
required |
Returns:
| Type | Description |
|---|---|
|
filter.EdgeViewPropsFilterBuilder |
dst()
staticmethod
#
Selects the edge destination endpoint for filtering.
Returns:
| Type | Description |
|---|---|
|
filter.EdgeEndpoint |
is_active()
staticmethod
#
Matches edges that have at least one event in the current view.
Returns:
| Type | Description |
|---|---|
|
filter.FilterExpr |
is_deleted()
staticmethod
#
Matches edges that have been deleted.
Returns:
| Type | Description |
|---|---|
|
filter.FilterExpr |
is_self_loop()
staticmethod
#
Matches edges that are self-loops (source == destination).
Returns:
| Type | Description |
|---|---|
|
filter.FilterExpr |
is_valid()
staticmethod
#
Matches edges that are structurally valid in the current view.
Returns:
| Type | Description |
|---|---|
|
filter.FilterExpr |
latest()
staticmethod
#
Evaluates edge predicates against the latest available edge state.
Returns:
| Type | Description |
|---|---|
|
filter.EdgeViewPropsFilterBuilder |
layer(layer)
staticmethod
#
Restricts evaluation to edges belonging to the given layer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
layer
|
str
|
Layer name. |
required |
Returns:
| Type | Description |
|---|---|
|
filter.EdgeViewPropsFilterBuilder |
layers(layers)
staticmethod
#
metadata(name)
staticmethod
#
Filters an edge metadata field by name.
Metadata is shared across all temporal versions of an edge.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Metadata key. |
required |
Returns:
| Type | Description |
|---|---|
|
filter.FilterOps |
property(name)
staticmethod
#
Filters an edge property by name.
The property may be static or temporal depending on the query context.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Property key. |
required |
Returns:
| Type | Description |
|---|---|
|
filter.PropertyFilterOps |
snapshot_at(time)
staticmethod
#
Evaluates edge predicates against a snapshot of the graph at a given time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
time
|
int
|
Snapshot time. |
required |
Returns:
| Type | Description |
|---|---|
|
filter.EdgeViewPropsFilterBuilder |
snapshot_latest()
staticmethod
#
Evaluates edge predicates against the most recent snapshot of the graph.
Returns:
| Type | Description |
|---|---|
|
filter.EdgeViewPropsFilterBuilder |
src()
staticmethod
#
Selects the edge source endpoint for filtering.
Returns:
| Type | Description |
|---|---|
|
filter.EdgeEndpoint |