Skip to content

Classes#

GraphView#

Graph view is a read-only version of a graph at a certain point in time.

Graph#

A temporal graph with event semantics.

PersistentGraph#

A temporal graph that allows edges and nodes to be deleted.

Node#

A node (or node) in the graph.

Nodes#

A list of nodes that can be iterated over.

PathFromNode#

PathFromGraph#

MutableNode#

Edge#

PyEdge is a Python class that represents an edge in the graph. An edge is a directed connection between two nodes.

Edges#

A list of edges that can be iterated over.

NestedEdges#

MutableEdge#

Properties#

A view of the properties of an entity

PyPropValueList#

PropType#

PropType provides access to the types used by Raphtory. They can be used to specify the data type of different properties, which is especially useful if one wishes to cast some input column from one type to another during ingestion. PropType can be used to define the schema in the various load_* functions used for data ingestion (i.e. Graph.load_nodes(...)/Graph.load_edges(...) etc.)

Metadata#

A view of metadata of an entity

MetadataView#

TemporalProperties#

A view of the temporal properties of an entity

PropertiesView#

TemporalProperty#

A view of a temporal property

EventTime#

Raphtory’s EventTime. Represents a unique timepoint in the graph’s history as (timestamp, event_id).

  • timestamp: Number of milliseconds since the Unix epoch.
  • event_id: ID used for ordering between equal timestamps.

Unless specified manually, the event ids are generated automatically by Raphtory to maintain a unique ordering of events. EventTime can be converted into a timestamp or a Python datetime, and compared either by timestamp (against ints/floats/datetimes/strings), by tuple of (timestamp, event_id), or against another EventTime.

OptionalEventTime#

Raphtory’s optional EventTime type. Instances of OptionalEventTime may contain an EventTime, or be empty. This is used for functions that may not return data (such as earliest_time and latest_time) because the data is unavailable.

If data is contained, OptionalEventTime instances can be used similarly to EventTime. If empty, time operations (such as .t, .dt, .event_id) will return None. An empty OptionalEventTime is considered smaller than (<) any EventTime or OptionalEventTime with data.

History#

History of updates for an object. Provides access to time entries and derived views such as timestamps, datetimes, event ids, and intervals.

HistoryTimestamp#

History view that exposes timestamps in milliseconds since the Unix epoch.

HistoryDateTime#

History view that exposes UTC datetimes.

HistoryEventId#

History view that exposes event ids of time entries. They are used for ordering within the same timestamp.

Intervals#

View over the intervals between consecutive timestamps, expressed in milliseconds.

WindowSet#

IndexSpecBuilder#

IndexSpec#

Prop#