Objects

GraphQL object types representing graph entities.

Types

Type	Description
`CollectionOfMetaGraph`	Collection of items
`CollectionOfNamespace`	Collection of items
`CollectionOfNamespacedItem`	Collection of items
`Document`	Document in a vector graph
`Edge`	Raphtory graph edge.
`Edges`
`EdgeSchema`
`EdgesWindowSet`
`EdgeWindowSet`
`EventTime`	Raphtory’s EventTime.
`Graph`
`GraphAlgorithmPlugin`
`GraphSchema`
`GraphWindowSet`
`History`	History of updates for an object in Raphtory.
`HistoryDateTime`	History object that provides access to datetimes instead of `EventTime` entries.
`HistoryEventId`	History object that provides access to event ids instead of `EventTime` entries.
`HistoryTimestamp`	History object that provides access to timestamps (milliseconds since the Unix epoch) instead of `EventTime` entries.
`IndexSpec`
`Intervals`	Provides access to the intervals between temporal entries of an object.
`LayerSchema`
`Metadata`
`MetaGraph`
`MutableEdge`
`MutableGraph`
`MutableNode`
`MutationPlugin`
`Namespace`
`Node`	Raphtory graph node.
`Nodes`
`NodeSchema`
`NodesWindowSet`
`NodeWindowSet`
`PagerankOutput`	PageRank score.
`PathFromNode`
`PathFromNodeWindowSet`
`Properties`
`Property`
`PropertySchema`
`PropertyTuple`
`QueryPlugin`
`ShortestPathOutput`
`TemporalProperties`
`TemporalProperty`
`VectorisedGraph`
`VectorSelection`

Type Details

CollectionOfMetaGraph

Collection of items

Fields

Field	Type	Description
`list`	[MetaGraph!]!	Returns a list of collection objects.
`page`	[MetaGraph!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount. The page_index sets the number of pages to skip (defaults to 0).
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`count`	Int!	Returns a count of collection objects.

CollectionOfNamespace

Collection of items

Fields

Field	Type	Description
`list`	[Namespace!]!	Returns a list of collection objects.
`page`	[Namespace!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount. The page_index sets the number of pages to skip (defaults to 0).
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`count`	Int!	Returns a count of collection objects.

CollectionOfNamespacedItem

Collection of items

Fields

Field	Type	Description
`list`	[NamespacedItem!]!	Returns a list of collection objects.
`page`	[NamespacedItem!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount. The page_index sets the number of pages to skip (defaults to 0).
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`count`	Int!	Returns a count of collection objects.

Document

Document in a vector graph

Fields

Field	Type	Description
`entity`	DocumentEntity!	Entity associated with document.
`content`	String!	Content of the document.
`embedding`	[Float!]!	Similarity score with a specified query
`score`	Float!

Edge

Raphtory graph edge.

Fields

Field	Type	Description
`defaultLayer`	Edge!	Return a view of Edge containing only the default edge layer.
`layers`	Edge!	Returns a view of Edge containing all layers in the list of names.
↳ `names`	[String!]!
`excludeLayers`	Edge!	Returns a view of Edge containing all layers except the excluded list of names.
↳ `names`	[String!]!
`layer`	Edge!	Returns a view of Edge containing the specified layer.
↳ `name`	String!
`excludeLayer`	Edge!	Returns a view of Edge containing all layers except the excluded layer specified.
↳ `name`	String!
`rolling`	EdgeWindowSet!	Creates a WindowSet with the given window duration and optional step using a rolling window.
↳ `window`	WindowDuration!
↳ `step`	WindowDuration
↳ `alignmentUnit`	AlignmentUnit
`expanding`	EdgeWindowSet!	Creates a WindowSet with the given step size using an expanding window.
↳ `step`	WindowDuration!
↳ `alignmentUnit`	AlignmentUnit
`window`	Edge!	Creates a view of the Edge including all events between the specified start (inclusive) and end (exclusive).
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`at`	Edge!	Creates a view of the Edge including all events at a specified time.
↳ `time`	TimeInput!
`latest`	Edge!	Returns a view of the edge at the latest time of the graph.
`snapshotAt`	Edge!	Creates a view of the Edge including all events that are valid at time.
↳ `time`	TimeInput!
`snapshotLatest`	Edge!	Creates a view of the Edge including all events that are valid at the latest time.
`before`	Edge!	Creates a view of the Edge including all events before a specified end (exclusive).
↳ `time`	TimeInput!
`after`	Edge!	Creates a view of the Edge including all events after a specified start (exclusive).
↳ `time`	TimeInput!
`shrinkWindow`	Edge!	Shrinks both the start and end of the window.
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`shrinkStart`	Edge!	Set the start of the window.
↳ `start`	TimeInput!
`shrinkEnd`	Edge!	Set the end of the window.
↳ `end`	TimeInput!
`applyViews`	Edge!	Takes a specified selection of views and applies them in given order.
↳ `views`	[EdgeViewCollection!]!
`earliestTime`	EventTime!	Returns the earliest time of an edge.
`firstUpdate`	EventTime!
`latestTime`	EventTime!	Returns the latest time of an edge.
`lastUpdate`	EventTime!
`time`	EventTime!	Returns the time of an exploded edge. Errors on an unexploded edge.
`start`	EventTime!	Returns the start time for rolling and expanding windows for this edge. Returns none if no window is applied.
`end`	EventTime!	Returns the end time of the window. Returns none if no window is applied.
`src`	Node!	Returns the source node of the edge.
`dst`	Node!	Returns the destination node of the edge.
`nbr`	Node!	Returns the node at the other end of the edge (same as dst() for out-edges and src() for in-edges).
`id`	[String!]!	Returns the id of the edge.
`properties`	Properties!	Returns a view of the properties of the edge.
`metadata`	Metadata!	Returns the metadata of an edge.
`layerNames`	[String!]!	Returns the names of the layers that have this edge as a member.
`layerName`	String!	Returns the layer name of an exploded edge, errors on an edge.
`explode`	Edges!	Returns an edge object for each update within the original edge.
`explodeLayers`	Edges!	Returns an edge object for each layer within the original edge.
`history`	History!	Returns a History object with time entries for when an edge is added or change to an edge is made.
`deletions`	History!	Returns a history object with time entries for an edge's deletion times.
`isValid`	Boolean!	Checks if the edge is currently valid and exists at the current time.
`isActive`	Boolean!	Checks if the edge is currently active and has at least one update within the current period.
`isDeleted`	Boolean!	Checks if the edge is deleted at the current time.
`isSelfLoop`	Boolean!	Returns true if the edge source and destination nodes are the same.
`filter`	Edge!
↳ `expr`	EdgeFilter!

Edges

Fields

Field	Type	Description
`defaultLayer`	Edges!	Returns a collection containing only edges in the default edge layer.
`layers`	Edges!	Returns a collection containing only edges belonging to the listed layers.
↳ `names`	[String!]!
`excludeLayers`	Edges!	Returns a collection containing edges belonging to all layers except the excluded list of layers.
↳ `names`	[String!]!
`layer`	Edges!	Returns a collection containing edges belonging to the specified layer.
↳ `name`	String!
`excludeLayer`	Edges!	Returns a collection containing edges belonging to all layers except the excluded layer specified.
↳ `name`	String!
`rolling`	EdgesWindowSet!	Creates a WindowSet with the given window duration and optional step using a rolling window. A rolling window is a window that moves forward by step size at each iteration.
↳ `window`	WindowDuration!
↳ `step`	WindowDuration
↳ `alignmentUnit`	AlignmentUnit
`expanding`	EdgesWindowSet!	Creates a WindowSet with the given step size using an expanding window. An expanding window is a window that grows by step size at each iteration.
↳ `step`	WindowDuration!
↳ `alignmentUnit`	AlignmentUnit
`window`	Edges!	Creates a view of the Edge including all events between the specified start (inclusive) and end (exclusive).
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`at`	Edges!	Creates a view of the Edge including all events at a specified time.
↳ `time`	TimeInput!
`latest`	Edges!
`snapshotAt`	Edges!	Creates a view of the Edge including all events that are valid at time. This is equivalent to before(time + 1) for Graph and at(time) for PersistentGraph.
↳ `time`	TimeInput!
`snapshotLatest`	Edges!	Creates a view of the Edge including all events that are valid at the latest time. This is equivalent to a no-op for Graph and latest() for PersistentGraph.
`before`	Edges!	Creates a view of the Edge including all events before a specified end (exclusive).
↳ `time`	TimeInput!
`after`	Edges!	Creates a view of the Edge including all events after a specified start (exclusive).
↳ `time`	TimeInput!
`shrinkWindow`	Edges!	Shrinks both the start and end of the window.
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`shrinkStart`	Edges!	Set the start of the window.
↳ `start`	TimeInput!
`shrinkEnd`	Edges!	Set the end of the window.
↳ `end`	TimeInput!
`applyViews`	Edges!	Takes a specified selection of views and applies them in order given.
↳ `views`	[EdgesViewCollection!]!
`explode`	Edges!	Returns an edge object for each update within the original edge.
`explodeLayers`	Edges!	Returns an edge object for each layer within the original edge.
`sorted`	Edges!	Specify a sort order from: source, destination, property, time. You can also reverse the ordering.
↳ `sortBys`	[EdgeSortBy!]!
`start`	EventTime!	Returns the start time of the window or none if there is no window.
`end`	EventTime!	Returns the end time of the window or none if there is no window.
`count`	Int!	Returns the number of edges.
`page`	[Edge!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`list`	[Edge!]!	Returns a list of all objects in the current selection of the collection. You should filter the collection first then call list.
`filter`	Edges!	Returns a filtered view that applies to list down the chain
↳ `expr`	EdgeFilter!
`select`	Edges!	Returns filtered list of edges
↳ `expr`	EdgeFilter!

EdgeSchema

Fields

Field	Type	Description
`srcType`	String!	Returns the type of source for these edges
`dstType`	String!	Returns the type of destination for these edges
`properties`	[PropertySchema!]!	Returns the list of property schemas for edges connecting these types of nodes
`metadata`	[PropertySchema!]!	Returns the list of metadata schemas for edges connecting these types of nodes

EdgesWindowSet

Fields

Field	Type	Description
`count`	Int!
`page`	[Edges!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`list`	[Edges!]!

EdgeWindowSet

Fields

Field	Type	Description
`count`	Int!
`page`	[Edge!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`list`	[Edge!]!

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.

Instances of EventTime may or may not contain time information. This is relevant for functions that may not return data (such as earliest_time and latest_time) because the data is unavailable. When empty, time operations (such as timestamp, datetime, and event_id) will return None.

Fields

Field	Type	Description
`timestamp`	Int	Get the timestamp in milliseconds since the Unix epoch.
`eventId`	Int	Get the event id for the EventTime. Used for ordering within the same timestamp.
`datetime`	String	Access a datetime representation of the EventTime as a String.
↳ `formatString`	String

Graph

Fields

Field	Type	Description
`uniqueLayers`	[String!]!	Returns the names of all layers in the graphview.
`defaultLayer`	Graph!	Returns a view containing only the default layer.
`layers`	Graph!	Returns a view containing all the specified layers.
↳ `names`	[String!]!
`excludeLayers`	Graph!	Returns a view containing all layers except the specified excluded layers.
↳ `names`	[String!]!
`layer`	Graph!	Returns a view containing the layer specified.
↳ `name`	String!
`excludeLayer`	Graph!	Returns a view containing all layers except the specified excluded layer.
↳ `name`	String!
`subgraph`	Graph!	Returns a subgraph of a specified set of nodes which contains only the edges that connect nodes of the subgraph to each other.
↳ `nodes`	[String!]!
`valid`	Graph!	Returns a view of the graph that only includes valid edges.
`subgraphNodeTypes`	Graph!	Returns a subgraph filtered by the specified node types.
↳ `nodeTypes`	[String!]!
`excludeNodes`	Graph!	Returns a subgraph containing all nodes except the specified excluded nodes.
↳ `nodes`	[String!]!
`rolling`	GraphWindowSet!	Creates a rolling window with the specified window size and an optional step.
↳ `window`	WindowDuration!
↳ `step`	WindowDuration
↳ `alignmentUnit`	AlignmentUnit
`expanding`	GraphWindowSet!	Creates an expanding window with the specified step size.
↳ `step`	WindowDuration!
↳ `alignmentUnit`	AlignmentUnit
`window`	Graph!	Return a graph containing only the activity between start and end, by default raphtory stores times in milliseconds from the unix epoch.
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`at`	Graph!	Creates a view including all events at a specified time.
↳ `time`	TimeInput!
`latest`	Graph!	Creates a view including all events at the latest time.
`snapshotAt`	Graph!	Create a view including all events that are valid at the specified time.
↳ `time`	TimeInput!
`snapshotLatest`	Graph!	Create a view including all events that are valid at the latest time.
`before`	Graph!	Create a view including all events before a specified end (exclusive).
↳ `time`	TimeInput!
`after`	Graph!	Create a view including all events after a specified start (exclusive).
↳ `time`	TimeInput!
`shrinkWindow`	Graph!	Shrink both the start and end of the window.
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`shrinkStart`	Graph!	Set the start of the window to the larger of the specified value or current start.
↳ `start`	TimeInput!
`shrinkEnd`	Graph!	Set the end of the window to the smaller of the specified value or current end.
↳ `end`	TimeInput!
`created`	Int!	Returns the timestamp for the creation of the graph.
`lastOpened`	Int!	Returns the graph's last opened timestamp according to system time.
`lastUpdated`	Int!	Returns the graph's last updated timestamp.
`earliestTime`	EventTime!	Returns the time entry of the earliest activity in the graph.
`latestTime`	EventTime!	Returns the time entry of the latest activity in the graph.
`start`	EventTime!	Returns the start time of the window. Errors if there is no window.
`end`	EventTime!	Returns the end time of the window. Errors if there is no window.
`earliestEdgeTime`	EventTime!	Returns the earliest time that any edge in this graph is valid.
↳ `includeNegative`	Boolean
`latestEdgeTime`	EventTime!	Returns the latest time that any edge in this graph is valid.
↳ `includeNegative`	Boolean
`countEdges`	Int!	Returns the number of edges in the graph.
`countTemporalEdges`	Int!	Returns the number of temporal edges in the graph.
`countNodes`	Int!	Returns the number of nodes in the graph.
`hasNode`	Boolean!	Returns true if the graph contains the specified node.
↳ `name`	String!
`hasEdge`	Boolean!	Returns true if the graph contains the specified edge. Edges are specified by providing a source and destination node id. You can restrict the search to a specified layer.
↳ `src`	String!
↳ `dst`	String!
↳ `layer`	String
`node`	Node	Gets the node with the specified id.
↳ `name`	String!
`nodes`	Nodes!	Gets (optionally a subset of) the nodes in the graph.
↳ `select`	NodeFilter
`edge`	Edge	Gets the edge with the specified source and destination nodes.
↳ `src`	String!
↳ `dst`	String!
`edges`	Edges!	Gets the edges in the graph.
↳ `select`	EdgeFilter
`properties`	Properties!	Returns the properties of the graph.
`metadata`	Metadata!	Returns the metadata of the graph.
`name`	String!	Returns the graph name.
`path`	String!	Returns path of graph.
`namespace`	String!	Returns namespace of graph.
`schema`	GraphSchema!	Returns the graph schema.
`algorithms`	GraphAlgorithmPlugin!
`sharedNeighbours`	[Node!]!
↳ `selectedNodes`	[String!]!
`exportTo`	Boolean!	Export all nodes and edges from this graph view to another existing graph
↳ `path`	String!
`filter`	Graph!
↳ `expr`	GraphFilter
`filterNodes`	Graph!
↳ `expr`	NodeFilter!
`filterEdges`	Graph!
↳ `expr`	EdgeFilter!
`getIndexSpec`	IndexSpec!	(Experimental) Get index specification.
`searchNodes`	[Node!]!	(Experimental) Searches for nodes which match the given filter expression.
↳ `filter`	NodeFilter!
↳ `limit`	Int!
↳ `offset`	Int!
`searchEdges`	[Edge!]!	(Experimental) Searches the index for edges which match the given filter expression.
↳ `filter`	EdgeFilter!
↳ `limit`	Int!
↳ `offset`	Int!
`applyViews`	Graph!	Returns the specified graph view or if none is specified returns the default view.
↳ `views`	[GraphViewCollection!]!

GraphAlgorithmPlugin

Fields

Field	Type	Description
`pagerank`	[PagerankOutput!]!
↳ `iterCount`	Int!
↳ `threads`	Int
↳ `tol`	Float
`shortest_path`	[ShortestPathOutput!]!
↳ `source`	String!
↳ `targets`	[String!]!
↳ `direction`	String

GraphSchema

Fields

Field	Type	Description
`nodes`	[NodeSchema!]!
`layers`	[LayerSchema!]!

GraphWindowSet

Fields

Field	Type	Description
`count`	Int!	Returns the number of items.
`page`	[Graph!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`list`	[Graph!]!

History

History of updates for an object in Raphtory. Provides access to temporal properties.

Fields

Field	Type	Description
`earliestTime`	EventTime!	Get the earliest time entry associated with this history or None if the history is empty.
`latestTime`	EventTime!	Get the latest time entry associated with this history or None if the history is empty.
`list`	[EventTime!]!	List all time entries present in this history.
`listRev`	[EventTime!]!	List all time entries present in this history in reverse order.
`page`	[EventTime!]!	Fetch one page of EventTime entries with a number of items up to a specified limit,
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`pageRev`	[EventTime!]!	Fetch one page of EventTime entries with a number of items up to a specified limit,
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`isEmpty`	Boolean!	Returns True if the history is empty.
`count`	Int!	Get the number of entries contained in the history.
`timestamps`	HistoryTimestamp!	Returns a HistoryTimestamp object which accesses timestamps (milliseconds since the Unix epoch)
`datetimes`	HistoryDateTime!	Returns a HistoryDateTime object which accesses datetimes instead of EventTime entries.
↳ `formatString`	String
`eventId`	HistoryEventId!	Returns a HistoryEventId object which accesses event ids of EventTime entries.
`intervals`	Intervals!	Returns an Intervals object which calculates the intervals between consecutive EventTime timestamps.

HistoryDateTime

History object that provides access to datetimes instead of EventTime entries.

Fields

Field	Type	Description
`list`	[String!]!	List all datetimes formatted as strings.
↳ `filterBroken`	Boolean
`listRev`	[String!]!	List all datetimes formatted as strings in reverse chronological order.
↳ `filterBroken`	Boolean
`page`	[String!]!	Fetch one page of datetimes formatted as string with a number of items up to a specified limit,
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
↳ `filterBroken`	Boolean
`pageRev`	[String!]!	Fetch one page of datetimes formatted as string in reverse chronological order with a number of items up to a specified limit,
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
↳ `filterBroken`	Boolean

HistoryEventId

History object that provides access to event ids instead of EventTime entries.

Fields

Field	Type	Description
`list`	[Int!]!	List event ids.
`listRev`	[Int!]!	List event ids in reverse order.
`page`	[Int!]!	Fetch one page of event ids with a number of items up to a specified limit,
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`pageRev`	[Int!]!	Fetch one page of event ids in reverse chronological order with a number of items up to a specified limit,
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int

HistoryTimestamp

History object that provides access to timestamps (milliseconds since the Unix epoch) instead of EventTime entries.

Fields

Field	Type	Description
`list`	[Int!]!	List all timestamps.
`listRev`	[Int!]!	List all timestamps in reverse order.
`page`	[Int!]!	Fetch one page of timestamps with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`pageRev`	[Int!]!	Fetch one page of timestamps in reverse order with a number of items up to a specified limit,
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int

IndexSpec

Fields

Field	Type	Description
`nodeMetadata`	[String!]!	Returns node metadata.
`nodeProperties`	[String!]!	Returns node properties.
`edgeMetadata`	[String!]!	Returns edge metadata.
`edgeProperties`	[String!]!	Returns edge properties.

Intervals

Provides access to the intervals between temporal entries of an object.

Fields

Field	Type	Description
`list`	[Int!]!	List time intervals between consecutive timestamps in milliseconds.
`listRev`	[Int!]!	List millisecond time intervals between consecutive timestamps in reverse order.
`page`	[Int!]!	Fetch one page of intervals between consecutive timestamps with a number of items up to a specified limit,
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`pageRev`	[Int!]!	Fetch one page of intervals between consecutive timestamps in reverse order with a number of items up to a specified limit,
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`mean`	Float	Compute the mean interval between consecutive timestamps. Returns None if fewer than 1 timestamp.
`median`	Int	Compute the median interval between consecutive timestamps. Returns None if fewer than 1 timestamp.
`max`	Int	Compute the maximum interval between consecutive timestamps. Returns None if fewer than 1 timestamp.
`min`	Int	Compute the minimum interval between consecutive timestamps. Returns None if fewer than 1 timestamp.

LayerSchema

Fields

Field	Type	Description
`name`	String!	Returns the name of the layer with this schema
`edges`	[EdgeSchema!]!	Returns the list of edge schemas for this edge layer

Metadata

Fields

Field	Type	Description
`get`	Property	Get metadata value matching the specified key.
↳ `key`	String!
`contains`	Boolean!	/// Check if the key is in the metadata.
↳ `key`	String!
`keys`	[String!]!	Return all metadata keys.
`values`	[Property!]!	/// Return all metadata values.
↳ `keys`	[String!]

MetaGraph

Fields

Field	Type	Description
`name`	String	Returns the graph name.
`path`	String!	Returns path of graph.
`created`	Int!	Returns the timestamp for the creation of the graph.
`lastOpened`	Int!	Returns the graph's last opened timestamp according to system time.
`lastUpdated`	Int!	Returns the graph's last updated timestamp.
`nodeCount`	Int!	Returns the number of nodes in the graph.
`edgeCount`	Int!	Returns the number of edges in the graph.
`metadata`	[Property!]!	Returns the metadata of the graph.

MutableEdge

Fields

Field	Type	Description
`success`	Boolean!	Use to check if adding the edge was successful.
`edge`	Edge!	Get the non-mutable edge for querying.
`src`	MutableNode!	Get the mutable source node of the edge.
`dst`	MutableNode!	Get the mutable destination node of the edge.
`delete`	Boolean!	Mark the edge as deleted at time time.
↳ `time`	Int!
↳ `layer`	String
`addMetadata`	Boolean!	Add metadata to the edge (errors if the value already exists).
↳ `properties`	[PropertyInput!]!
↳ `layer`	String
`updateMetadata`	Boolean!	Update metadata of the edge (existing values are overwritten).
↳ `properties`	[PropertyInput!]!
↳ `layer`	String
`addUpdates`	Boolean!	Add temporal property updates to the edge.
↳ `time`	Int!
↳ `properties`	[PropertyInput!]
↳ `layer`	String

MutableGraph

Fields

Field	Type	Description
`graph`	Graph!	Get the non-mutable graph.
`node`	MutableNode	Get mutable existing node.
↳ `name`	String!
`addNode`	MutableNode!	Add a new node or add updates to an existing node.
↳ `time`	Int!
↳ `name`	String!
↳ `properties`	[PropertyInput!]
↳ `nodeType`	String
`createNode`	MutableNode!	Create a new node or fail if it already exists.
↳ `time`	Int!
↳ `name`	String!
↳ `properties`	[PropertyInput!]
↳ `nodeType`	String
`addNodes`	Boolean!	Add a batch of nodes.
↳ `nodes`	[NodeAddition!]!
`edge`	MutableEdge	Get a mutable existing edge.
↳ `src`	String!
↳ `dst`	String!
`addEdge`	MutableEdge!	Add a new edge or add updates to an existing edge.
↳ `time`	Int!
↳ `src`	String!
↳ `dst`	String!
↳ `properties`	[PropertyInput!]
↳ `layer`	String
`addEdges`	Boolean!	Add a batch of edges.
↳ `edges`	[EdgeAddition!]!
`deleteEdge`	MutableEdge!	Mark an edge as deleted (creates the edge if it did not exist).
↳ `time`	Int!
↳ `src`	String!
↳ `dst`	String!
↳ `layer`	String
`addProperties`	Boolean!	Add temporal properties to graph.
↳ `t`	Int!
↳ `properties`	[PropertyInput!]!
`addMetadata`	Boolean!	Add metadata to graph (errors if the property already exists).
↳ `properties`	[PropertyInput!]!
`updateMetadata`	Boolean!	Update metadata of the graph (overwrites existing values).
↳ `properties`	[PropertyInput!]!

MutableNode

Fields

Field	Type	Description
`success`	Boolean!	Use to check if adding the node was successful.
`node`	Node!	Get the non-mutable Node.
`addMetadata`	Boolean!	Add metadata to the node (errors if the property already exists).
↳ `properties`	[PropertyInput!]!
`setNodeType`	Boolean!	Set the node type (errors if the node already has a non-default type).
↳ `newType`	String!
`updateMetadata`	Boolean!	Update metadata of the node (overwrites existing property values).
↳ `properties`	[PropertyInput!]!
`addUpdates`	Boolean!	Add temporal property updates to the node.
↳ `time`	Int!
↳ `properties`	[PropertyInput!]

MutationPlugin

Fields

Field	Type	Description
`NoOps`	String!

Namespace

Fields

Field	Type	Description
`graphs`	CollectionOfMetaGraph!
`path`	String!
`parent`	Namespace
`children`	CollectionOfNamespace!
`items`	CollectionOfNamespacedItem!

Node

Raphtory graph node.

Fields

Field	Type	Description
`id`	String!	Returns the unique id of the node.
`name`	String!	Returns the name of the node.
`defaultLayer`	Node!	Return a view of the node containing only the default layer.
`layers`	Node!	Return a view of node containing all layers specified.
↳ `names`	[String!]!
`excludeLayers`	Node!	Returns a collection containing nodes belonging to all layers except the excluded list of layers.
↳ `names`	[String!]!
`layer`	Node!	Returns a collection containing nodes belonging to the specified layer.
↳ `name`	String!
`excludeLayer`	Node!	Returns a collection containing nodes belonging to all layers except the excluded layer.
↳ `name`	String!
`rolling`	NodeWindowSet!	Creates a WindowSet with the specified window size and optional step using a rolling window.
↳ `window`	WindowDuration!
↳ `step`	WindowDuration
↳ `alignmentUnit`	AlignmentUnit
`expanding`	NodeWindowSet!	Creates a WindowSet with the specified step size using an expanding window.
↳ `step`	WindowDuration!
↳ `alignmentUnit`	AlignmentUnit
`window`	Node!	Create a view of the node including all events between the specified start (inclusive) and end (exclusive).
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`at`	Node!	Create a view of the node including all events at a specified time.
↳ `time`	TimeInput!
`latest`	Node!	Create a view of the node including all events at the latest time.
`snapshotAt`	Node!	Create a view of the node including all events that are valid at the specified time.
↳ `time`	TimeInput!
`snapshotLatest`	Node!	Create a view of the node including all events that are valid at the latest time.
`before`	Node!	Create a view of the node including all events before specified end time (exclusive).
↳ `time`	TimeInput!
`after`	Node!	Create a view of the node including all events after the specified start time (exclusive).
↳ `time`	TimeInput!
`shrinkWindow`	Node!	Shrink a Window to a specified start and end time, if these are earlier and later than the current start and end respectively.
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`shrinkStart`	Node!	Set the start of the window to the larger of a specified start time and self.start().
↳ `start`	TimeInput!
`shrinkEnd`	Node!	Set the end of the window to the smaller of a specified end and self.end().
↳ `end`	TimeInput!
`applyViews`	Node!
↳ `views`	[NodeViewCollection!]!
`earliestTime`	EventTime!	Returns the earliest time that the node exists.
`firstUpdate`	EventTime!	Returns the time of the first update made to the node.
`latestTime`	EventTime!	Returns the latest time that the node exists.
`lastUpdate`	EventTime!	Returns the time of the last update made to the node.
`start`	EventTime!	Gets the start time for the window. Errors if there is no window.
`end`	EventTime!	Gets the end time for the window. Errors if there is no window.
`history`	History!	Returns a history object for the node, with time entries for node additions and changes made to node.
`edgeHistoryCount`	Int!	Get the number of edge events for this node.
`isActive`	Boolean!	Check if the node is active and it's history is not empty.
`nodeType`	String	Returns the type of node.
`properties`	Properties!	Returns the properties of the node.
`metadata`	Metadata!	Returns the metadata of the node.
`degree`	Int!	Returns the number of unique counter parties for this node.
`outDegree`	Int!	Returns the number edges with this node as the source.
`inDegree`	Int!	Returns the number edges with this node as the destination.
`inComponent`	Nodes!
`outComponent`	Nodes!
`edges`	Edges!	Returns all connected edges.
↳ `select`	EdgeFilter
`outEdges`	Edges!	Returns outgoing edges.
↳ `select`	EdgeFilter
`inEdges`	Edges!	Returns incoming edges.
↳ `select`	EdgeFilter
`neighbours`	PathFromNode!	Returns neighbouring nodes.
↳ `select`	NodeFilter
`inNeighbours`	PathFromNode!	Returns the number of neighbours that have at least one in-going edge to this node.
↳ `select`	NodeFilter
`outNeighbours`	PathFromNode!	Returns the number of neighbours that have at least one out-going edge from this node.
↳ `select`	NodeFilter
`filter`	Node!
↳ `expr`	NodeFilter!

Nodes

Fields

Field	Type	Description
`defaultLayer`	Nodes!	Return a view of the nodes containing only the default edge layer.
`layers`	Nodes!	Return a view of the nodes containing all layers specified.
↳ `names`	[String!]!
`excludeLayers`	Nodes!	Return a view of the nodes containing all layers except those specified.
↳ `names`	[String!]!
`layer`	Nodes!	Return a view of the nodes containing the specified layer.
↳ `name`	String!
`excludeLayer`	Nodes!	Return a view of the nodes containing all layers except those specified.
↳ `name`	String!
`rolling`	NodesWindowSet!	Creates a WindowSet with the specified window size and optional step using a rolling window.
↳ `window`	WindowDuration!
↳ `step`	WindowDuration
↳ `alignmentUnit`	AlignmentUnit
`expanding`	NodesWindowSet!	Creates a WindowSet with the specified step size using an expanding window.
↳ `step`	WindowDuration!
↳ `alignmentUnit`	AlignmentUnit
`window`	Nodes!	Create a view of the node including all events between the specified start (inclusive) and end (exclusive).
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`at`	Nodes!	Create a view of the nodes including all events at a specified time.
↳ `time`	TimeInput!
`latest`	Nodes!	Create a view of the nodes including all events at the latest time.
`snapshotAt`	Nodes!	Create a view of the nodes including all events that are valid at the specified time.
↳ `time`	TimeInput!
`snapshotLatest`	Nodes!	Create a view of the nodes including all events that are valid at the latest time.
`before`	Nodes!	Create a view of the nodes including all events before specified end time (exclusive).
↳ `time`	TimeInput!
`after`	Nodes!	Create a view of the nodes including all events after the specified start time (exclusive).
↳ `time`	TimeInput!
`shrinkWindow`	Nodes!	Shrink both the start and end of the window.
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`shrinkStart`	Nodes!	Set the start of the window to the larger of a specified start time and self.start().
↳ `start`	TimeInput!
`shrinkEnd`	Nodes!	Set the end of the window to the smaller of a specified end and self.end().
↳ `end`	TimeInput!
`typeFilter`	Nodes!	Filter nodes by node type.
↳ `nodeTypes`	[String!]!
`applyViews`	Nodes!
↳ `views`	[NodesViewCollection!]!
`sorted`	Nodes!
↳ `sortBys`	[NodeSortBy!]!
`start`	EventTime!	Returns the start time of the window. Errors if there is no window.
`end`	EventTime!	Returns the end time of the window. Errors if there is no window.
`count`	Int!
`page`	[Node!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`list`	[Node!]!
`ids`	[String!]!	Returns a view of the node ids.
`filter`	Nodes!	Returns a filtered view that applies to list down the chain
↳ `expr`	NodeFilter!
`select`	Nodes!	Returns filtered list of nodes
↳ `expr`	NodeFilter!

NodeSchema

Fields

Field	Type	Description
`typeName`	String!
`properties`	[PropertySchema!]!	Returns the list of property schemas for this node
`metadata`	[PropertySchema!]!

NodesWindowSet

Fields

Field	Type	Description
`count`	Int!
`page`	[Nodes!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`list`	[Nodes!]!

NodeWindowSet

Fields

Field	Type	Description
`count`	Int!
`page`	[Node!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`list`	[Node!]!

PagerankOutput

PageRank score.

Fields

Field	Type	Description
`name`	String!
`rank`	Float!

PathFromNode

Fields

Field	Type	Description
`layers`	PathFromNode!	Returns a view of PathFromNode containing the specified layer, errors if the layer does not exist.
↳ `names`	[String!]!
`excludeLayers`	PathFromNode!	Return a view of PathFromNode containing all layers except the specified excluded layers, errors if any of the layers do not exist.
↳ `names`	[String!]!
`layer`	PathFromNode!	Return a view of PathFromNode containing the layer specified layer, errors if the layer does not exist.
↳ `name`	String!
`excludeLayer`	PathFromNode!	Return a view of PathFromNode containing all layers except the specified excluded layers, errors if any of the layers do not exist.
↳ `name`	String!
`rolling`	PathFromNodeWindowSet!	Creates a WindowSet with the given window size and optional step using a rolling window.
↳ `window`	WindowDuration!
↳ `step`	WindowDuration
↳ `alignmentUnit`	AlignmentUnit
`expanding`	PathFromNodeWindowSet!	Creates a WindowSet with the given step size using an expanding window.
↳ `step`	WindowDuration!
↳ `alignmentUnit`	AlignmentUnit
`window`	PathFromNode!	Create a view of the PathFromNode including all events between a specified start (inclusive) and end (exclusive).
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`at`	PathFromNode!	Create a view of the PathFromNode including all events at time.
↳ `time`	TimeInput!
`snapshotLatest`	PathFromNode!	Create a view of the PathFromNode including all events that are valid at the latest time.
`snapshotAt`	PathFromNode!	Create a view of the PathFromNode including all events that are valid at the specified time.
↳ `time`	TimeInput!
`latest`	PathFromNode!	Create a view of the PathFromNode including all events at the latest time.
`before`	PathFromNode!	Create a view of the PathFromNode including all events before the specified end (exclusive).
↳ `time`	TimeInput!
`after`	PathFromNode!	Create a view of the PathFromNode including all events after the specified start (exclusive).
↳ `time`	TimeInput!
`shrinkWindow`	PathFromNode!	Shrink both the start and end of the window.
↳ `start`	TimeInput!
↳ `end`	TimeInput!
`shrinkStart`	PathFromNode!	Set the start of the window to the larger of the specified start and self.start().
↳ `start`	TimeInput!
`shrinkEnd`	PathFromNode!	Set the end of the window to the smaller of the specified end and self.end().
↳ `end`	TimeInput!
`typeFilter`	PathFromNode!	Filter nodes by type.
↳ `nodeTypes`	[String!]!
`start`	EventTime!	Returns the earliest time that this PathFromNode is valid or None if the PathFromNode is valid for all times.
`end`	EventTime!	Returns the latest time that this PathFromNode is valid or None if the PathFromNode is valid for all times.
`count`	Int!
`page`	[Node!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`list`	[Node!]!
`ids`	[String!]!	Returns the node ids.
`applyViews`	PathFromNode!	Takes a specified selection of views and applies them in given order.
↳ `views`	[PathFromNodeViewCollection!]!
`filter`	PathFromNode!	Returns a filtered view that applies to list down the chain
↳ `expr`	NodeFilter!
`select`	PathFromNode!	Returns filtered list of neighbour nodes
↳ `expr`	NodeFilter!

PathFromNodeWindowSet

Fields

Field	Type	Description
`count`	Int!
`page`	[PathFromNode!]!	Fetch one page with a number of items up to a specified limit, optionally offset by a specified amount.
↳ `limit`	Int!
↳ `offset`	Int
↳ `pageIndex`	Int
`list`	[PathFromNode!]!

Properties

Fields

Field	Type	Description
`get`	Property	Get property value matching the specified key.
↳ `key`	String!
`contains`	Boolean!	Check if the key is in the properties.
↳ `key`	String!
`keys`	[String!]!	Return all property keys.
`values`	[Property!]!	Return all property values.
↳ `keys`	[String!]
`temporal`	TemporalProperties!

Property

Fields

Field	Type	Description
`key`	String!
`asString`	String!
`value`	PropertyOutput!

PropertySchema

Fields

Field	Type	Description
`key`	String!
`propertyType`	String!
`variants`	[String!]!

PropertyTuple

Fields

Field	Type	Description
`time`	EventTime!
`asString`	String!
`value`	PropertyOutput!

QueryPlugin

Fields

Field	Type	Description
`NoOps`	String!

ShortestPathOutput

Fields

Field	Type	Description
`target`	String!
`nodes`	[String!]!

TemporalProperties

Fields

Field	Type	Description
`get`	TemporalProperty	Get property value matching the specified key.
↳ `key`	String!
`contains`	Boolean!	Check if the key is in the properties.
↳ `key`	String!
`keys`	[String!]!	Return all property keys.
`values`	[TemporalProperty!]!	Return all property values.
↳ `keys`	[String!]

TemporalProperty

Fields

Field	Type	Description
`key`	String!	Key of a property.
`history`	History!
`values`	[String!]!	Return the values of the properties.
`at`	String
↳ `t`	TimeInput!
`latest`	String
`unique`	[String!]!
`orderedDedupe`	[PropertyTuple!]!
↳ `latestTime`	Boolean!

VectorisedGraph

Fields

Field	Type	Description
`emptySelection`	VectorSelection!	Returns an empty selection of documents.
`entitiesBySimilarity`	VectorSelection!	Search the top scoring entities according to a specified query returning no more than a specified limit of entities.
↳ `query`	String!
↳ `limit`	Int!
↳ `window`	VectorisedGraphWindow
`nodesBySimilarity`	VectorSelection!	Search the top scoring nodes according to a specified query returning no more than a specified limit of nodes.
↳ `query`	String!
↳ `limit`	Int!
↳ `window`	VectorisedGraphWindow
`edgesBySimilarity`	VectorSelection!	Search the top scoring edges according to a specified query returning no more than a specified limit of edges.
↳ `query`	String!
↳ `limit`	Int!
↳ `window`	VectorisedGraphWindow

VectorSelection

Fields

Field	Type	Description
`nodes`	[Node!]!	Returns a list of nodes in the current selection.
`edges`	[Edge!]!	Returns a list of edges in the current selection.
`getDocuments`	[Document!]!	Returns a list of documents in the current selection.
`addNodes`	VectorSelection!	Adds all the documents associated with the specified nodes to the current selection.
↳ `nodes`	[String!]!
`addEdges`	VectorSelection!	Adds all the documents associated with the specified edges to the current selection.
↳ `edges`	[InputEdge!]!
`expand`	VectorSelection!	Add all the documents a specified number of hops away to the selection.
↳ `hops`	Int!
↳ `window`	VectorisedGraphWindow
`expandEntitiesBySimilarity`	VectorSelection!	Adds documents, from the set of one hop neighbours to the current selection, to the selection based on their similarity score with the specified query. This function loops so that the set of one hop neighbours expands on each loop and number of documents added is determined by the specified limit.
↳ `query`	String!
↳ `limit`	Int!
↳ `window`	VectorisedGraphWindow
`expandNodesBySimilarity`	VectorSelection!	Add the adjacent nodes with higher score for query to the selection up to a specified limit. This function loops like expand_entities_by_similarity but is restricted to nodes.
↳ `query`	String!
↳ `limit`	Int!
↳ `window`	VectorisedGraphWindow
`expandEdgesBySimilarity`	VectorSelection!	Add the adjacent edges with higher score for query to the selection up to a specified limit. This function loops like expand_entities_by_similarity but is restricted to edges.
↳ `query`	String!
↳ `limit`	Int!
↳ `window`	VectorisedGraphWindow