Schema Types#

Query (QueryRoot)#

Field	Type	Description
hello	String!	Hello world demo
graph	Graph!	Returns a graph
path	String!
updateGraph	MutableGraph!	Update graph query, has side effects to update graph state Returns:: GqlMutableGraph
path	String!
vectorisedGraph	VectorisedGraph	Create vectorised graph in the format used for queries Returns:: GqlVectorisedGraph
path	String!
namespaces	CollectionOfNamespace!	Returns all namespaces using recursive search Returns:: List of namespaces on root
namespace	Namespace!	Returns a specific namespace at a given path Returns:: Namespace or error if no namespace found
path	String!
root	Namespace!	Returns root namespace Returns:: Root namespace
plugins	QueryPlugin!	Returns a plugin.
receiveGraph	String!	Encodes graph and returns as string Returns:: Base64 url safe encoded string
path	String!
version	String!

Mutation (MutRoot)#

Field	Type	Description
plugins	MutationPlugin!	Returns a collection of mutation plugins.
deleteGraph	Boolean!	Delete graph from a path on the server.
path	String!
newGraph	Boolean!	Creates a new graph.
path	String!
graphType	GraphType!
moveGraph	Boolean!	Move graph from a path path on the server to a new_path on the server. If namespace is not provided, it will be set to the current working directory. This applies to both the graph namespace and new graph namespace.
path	String!
newPath	String!
copyGraph	Boolean!	Copy graph from a path path on the server to a new_path on the server. If namespace is not provided, it will be set to the current working directory. This applies to both the graph namespace and new graph namespace.
path	String!
newPath	String!
uploadGraph	String!	Upload a graph file from a path on the client using GQL multipart uploading. Returns:: name of the new graph
path	String!
graph	Upload!
overwrite	Boolean!
sendGraph	String!	Send graph bincode as base64 encoded string. Returns:: path of the new graph
path	String!
graph	String!
overwrite	Boolean!
createSubgraph	String!	Returns a subgraph given a set of nodes from an existing graph in the server. Returns:: name of the new graph
parentPath	String!
nodes	[String!]!
newPath	String!
overwrite	Boolean!
createIndex	Boolean!	(Experimental) Creates search index.
path	String!
indexSpec	IndexSpecInput
inRam	Boolean!

Objects#

CollectionOfMetaGraph#

Collection of items

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). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
count	Int!	Returns a count of collection objects.

CollectionOfNamespace#

Collection of items

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). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
count	Int!	Returns a count of collection objects.

CollectionOfNamespacedItem#

Collection of items

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). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
count	Int!	Returns a count of collection objects.

Edge#

Raphtory graph edge.

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. Errors if any of the layers do not exist.
names	[String!]!
excludeLayers	Edge!	Returns a view of Edge containing all layers except the excluded list of names. Errors if any of the layers do not exist.
names	[String!]!
layer	Edge!	Returns a view of Edge containing the specified layer. Errors if any of the layers do not exist.
name	String!
excludeLayer	Edge!	Returns a view of Edge containing all layers except the excluded layer specified. Errors if any of the layers do not exist.
name	String!
rolling	EdgeWindowSet!	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
expanding	EdgeWindowSet!	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!
window	Edge!	Creates a view of the Edge including all events between the specified start (inclusive) and end (exclusive). For persistent graphs, any edge which exists at any point during the window will be included. You may want to restrict this to only edges that are present at the end of the window using the is_valid function.
start	Int!
end	Int!
at	Edge!	Creates a view of the Edge including all events at a specified time.
time	Int!
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. This is equivalent to before(time + 1) for Graph and at(time) for PersistentGraph.
time	Int!
snapshotLatest	Edge!	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	Edge!	Creates a view of the Edge including all events before a specified end (exclusive).
time	Int!
after	Edge!	Creates a view of the Edge including all events after a specified start (exclusive).
time	Int!
shrinkWindow	Edge!	Shrinks both the start and end of the window.
start	Int!
end	Int!
shrinkStart	Edge!	Set the start of the window.
start	Int!
shrinkEnd	Edge!	Set the end of the window.
end	Int!
applyViews	Edge!	Takes a specified selection of views and applies them in given order.
views	[EdgeViewCollection!]!
earliestTime	Int	Returns the earliest time of an edge.
firstUpdate	Int
latestTime	Int	Returns the latest time of an edge.
lastUpdate	Int
time	Int!	Returns the time of an exploded edge. Errors on an unexploded edge.
start	Int	Returns the start time for rolling and expanding windows for this edge. Returns none if no window is applied.
end	Int	Returns the end time of the window. Returns none if no window is applied.
src	Node!	Returns the source node of the edge. Returns: Node:
dst	Node!	Returns the destination node of the edge. Returns: Node:
nbr	Node!	Returns the node at the other end of the edge (same as dst() for out-edges and src() for in-edges). Returns: Node:
id	[String!]!	Returns the id of the edge. Returns: list[str]:
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. Each new edge object contains only updates from the respective layers.
history	[Int!]!	Returns a list of timestamps of when an edge is added or change to an edge is made. Returns: List[int]:
deletions	[Int!]!	Returns a list of timestamps of when an edge is deleted. Returns: List[int]:
isValid	Boolean!	Checks if the edge is currently valid and exists at the current time. Returns: boolean
isActive	Boolean!	Checks if the edge is currently active and has at least one update within the current period. Returns: boolean
isDeleted	Boolean!	Checks if the edge is deleted at the current time. Returns: boolean
isSelfLoop	Boolean!	Returns true if the edge source and destination nodes are the same. Returns: boolean

EdgeSchema#

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

EdgeWindowSet#

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. The page_index sets the number of pages to skip (defaults to 0). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
list	[Edge!]!

Edges#

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. Returns a collection of collections. This means that item in the window set is a collection of edges.
window	WindowDuration!
step	WindowDuration
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. Returns a collection of collections. This means that item in the window set is a collection of edges.
step	WindowDuration!
window	Edges!	Creates a view of the Edge including all events between the specified start (inclusive) and end (exclusive).
start	Int!
end	Int!
at	Edges!	Creates a view of the Edge including all events at a specified time.
time	Int!
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	Int!
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	Int!
after	Edges!	Creates a view of the Edge including all events after a specified start (exclusive).
time	Int!
shrinkWindow	Edges!	Shrinks both the start and end of the window.
start	Int!
end	Int!
shrinkStart	Edges!	Set the start of the window.
start	Int!
shrinkEnd	Edges!	Set the end of the window.
end	Int!
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. Each new edge object contains only updates from the respective layers.
sorted	Edges!	Specify a sort order from: source, destination, property, time. You can also reverse the ordering.
sortBys	[EdgeSortBy!]!
start	Int	Returns the start time of the window or none if there is no window.
end	Int	Returns the end time of the window or none if there is no window.
count	Int!	Returns the number of edges. Returns: int:
page	[Edge!]!	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). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
list	[Edge!]!	Returns a list of all objects in the current selection of the collection. You should filter filter the collection first then call list.

EdgesWindowSet#

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. The page_index sets the number of pages to skip (defaults to 0). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
list	[Edges!]!

GqlDocument#

Document in a vector graph

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!

GqlIndexSpec#

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

GqlVectorSelection#

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	[GqlDocument!]!	Returns a list of documents in the current selection.
addNodes	GqlVectorSelection!	Adds all the documents associated with the specified nodes to the current selection. Documents added by this call are assumed to have a score of 0.
nodes	[String!]!
addEdges	GqlVectorSelection!	Adds all the documents associated with the specified edges to the current selection. Documents added by this call are assumed to have a score of 0.
edges	[InputEdge!]!
expand	GqlVectorSelection!	Add all the documents a specified number of hops away to the selection. Two documents A and B are considered to be 1 hop away of each other if they are on the same entity or if they are on the same node and edge pair.
hops	Int!
window	Window
expandEntitiesBySimilarity	GqlVectorSelection!	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	Window
expandNodesBySimilarity	GqlVectorSelection!	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	Window
expandEdgesBySimilarity	GqlVectorSelection!	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	Window

Graph#

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
expanding	GraphWindowSet!	Creates a expanding window with the specified step size.
step	WindowDuration!
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	Int!
end	Int!
at	Graph!	Creates a view including all events at a specified time.
time	Int!
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	Int!
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	Int!
after	Graph!	Create a view including all events after a specified start (exclusive).
time	Int!
shrinkWindow	Graph!	Shrink both the start and end of the window.
start	Int!
end	Int!
shrinkStart	Graph!	Set the start of the window to the larger of the specified value or current start.
start	Int!
shrinkEnd	Graph!	Set the end of the window to the smaller of the specified value or current end.
end	Int!
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	Int	Returns the timestamp of the earliest activity in the graph.
latestTime	Int	Returns the timestamp of the latest activity in the graph.
start	Int	Returns the start time of the window. Errors if there is no window.
end	Int	Returns the end time of the window. Errors if there is no window.
earliestEdgeTime	Int	Returns the earliest time that any edge in this graph is valid.
includeNegative	Boolean
latestEdgeTime	Int	/// Returns the latest time that any edge in this graph is valid.
includeNegative	Boolean
countEdges	Int!	Returns the number of edges in the graph. Returns: int:
countTemporalEdges	Int!	Returns the number of temporal edges in the graph.
countNodes	Int!	Returns the number of nodes in the graph. Optionally takes a list of node ids to return a subset.
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.
ids	[String!]
edge	Edge	Gets the edge with the specified source and destination nodes.
src	String!
dst	String!
edges	Edges!	Gets the edges in the graph.
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!
nodeFilter	Graph!
filter	NodeFilter!
edgeFilter	Graph!
filter	EdgeFilter!
getIndexSpec	GqlIndexSpec!	(Experimental) Get index specification.
searchNodes	[Node!]!	(Experimental) Searches for nodes which match the given filter expression. Uses Tantivy's exact search.
filter	NodeFilter!
limit	Int!
offset	Int!
searchEdges	[Edge!]!	(Experimental) Searches the index for edges which match the given filter expression. Uses Tantivy's exact search.
filter	EdgeFilter!
limit	Int!
offset	Int!
applyViews	Graph!	Returns the specified graph view or if none is specified returns the default view. This allows you to specify multiple operations together.
views	[GraphViewCollection!]!

GraphAlgorithmPlugin#

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

GraphSchema#

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

GraphWindowSet#

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. The page_index sets the number of pages to skip (defaults to 0). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
list	[Graph!]!

LayerSchema#

Field	Argument	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

MetaGraph#

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. Returns: int:
metadata	[Property!]!	Returns the metadata of the graph.

Metadata#

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!]

MutableEdge#

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). If this is called after add_edge, the layer is inherited from the add_edge and does not need to be specified again.
properties	[PropertyInput!]!
layer	String
updateMetadata	Boolean!	Update metadata of the edge (existing values are overwritten). If this is called after add_edge, the layer is inherited from the add_edge and does not need to be specified again.
properties	[PropertyInput!]!
layer	String
addUpdates	Boolean!	Add temporal property updates to the edge. If this is called after add_edge, the layer is inherited from the add_edge and does not need to be specified again.
time	Int!
properties	[PropertyInput!]
layer	String

MutableGraph#

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#

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#

Field	Argument	Type	Description
NoOps		String!

Namespace#

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

Node#

Raphtory graph node.

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. Returns a collection of collections. This means that item in the window set is a collection of nodes.
window	WindowDuration!
step	WindowDuration
expanding	NodeWindowSet!	Creates a WindowSet with the specified step size using an expanding window.
step	WindowDuration!
window	Node!	Create a view of the node including all events between the specified start (inclusive) and end (exclusive).
start	Int!
end	Int!
at	Node!	Create a view of the node including all events at a specified time.
time	Int!
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	Int!
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	Int!
after	Node!	Create a view of the node including all events after the specified start time (exclusive).
time	Int!
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	Int!
end	Int!
shrinkStart	Node!	Set the start of the window to the larger of a specified start time and self.start().
start	Int!
shrinkEnd	Node!	Set the end of the window to the smaller of a specified end and self.end().
end	Int!
applyViews	Node!
views	[NodeViewCollection!]!
earliestTime	Int	Returns the earliest time that the node exists.
firstUpdate	Int	Returns the time of the first update made to the node.
latestTime	Int	Returns the latest time that the node exists.
lastUpdate	Int	Returns the time of the last update made to the node.
start	Int	Gets the start time for the window. Errors if there is no window.
end	Int	Gets the end time for the window. Errors if there is no window.
history	[Int!]!	Returns the history of a node, including 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.
outEdges	Edges!	Returns outgoing edges.
inEdges	Edges!	Returns incoming edges.
neighbours	PathFromNode!	Returns neighbouring nodes.
inNeighbours	PathFromNode!	Returns the number of neighbours that have at least one in-going edge to this node.
outNeighbours	PathFromNode!	Returns the number of neighbours that have at least one out-going edge from this node.
nodeFilter	Node!
filter	NodeFilter!

NodeSchema#

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

NodeWindowSet#

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. The page_index sets the number of pages to skip (defaults to 0). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
list	[Node!]!

Nodes#

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
expanding	NodesWindowSet!	Creates a WindowSet with the specified step size using an expanding window.
step	WindowDuration!
window	Nodes!	Create a view of the node including all events between the specified start (inclusive) and end (exclusive).
start	Int!
end	Int!
at	Nodes!	Create a view of the nodes including all events at a specified time.
time	Int!
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	Int!
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	Int!
after	Nodes!	Create a view of the nodes including all events after the specified start time (exclusive).
time	Int!
shrinkWindow	Nodes!	Shrink both the start and end of the window.
start	Int!
end	Int!
shrinkStart	Nodes!	Set the start of the window to the larger of a specified start time and self.start().
start	Int!
shrinkEnd	Nodes!	Set the end of the window to the smaller of a specified end and self.end().
end	Int!
typeFilter	Nodes!	Filter nodes by node type.
nodeTypes	[String!]!
nodeFilter	Nodes!	Returns a view of the node types.
filter	NodeFilter!
applyViews	Nodes!
views	[NodesViewCollection!]!
sorted	Nodes!
sortBys	[NodeSortBy!]!
start	Int	Returns the start time of the window. Errors if there is no window.
end	Int	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. The page_index sets the number of pages to skip (defaults to 0). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
list	[Node!]!
ids	[String!]!	Returns a view of the node ids.

NodesWindowSet#

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. The page_index sets the number of pages to skip (defaults to 0). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
list	[Nodes!]!

PagerankOutput#

PageRank score.

Field	Argument	Type	Description
name		String!
rank		Float!

PathFromNode#

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
expanding	PathFromNodeWindowSet!	Creates a WindowSet with the given step size using an expanding window.
step	WindowDuration!
window	PathFromNode!	Create a view of the PathFromNode including all events between a specified start (inclusive) and end (exclusive).
start	Int!
end	Int!
at	PathFromNode!	Create a view of the PathFromNode including all events at time.
time	Int!
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	Int!
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	Int!
after	PathFromNode!	Create a view of the PathFromNode including all events after the specified start (exclusive).
time	Int!
shrinkWindow	PathFromNode!	Shrink both the start and end of the window.
start	Int!
end	Int!
shrinkStart	PathFromNode!	Set the start of the window to the larger of the specified start and self.start().
start	Int!
shrinkEnd	PathFromNode!	Set the end of the window to the smaller of the specified end and self.end().
end	Int!
typeFilter	PathFromNode!	Filter nodes by type.
nodeTypes	[String!]!
start	Int	Returns the earliest time that this PathFromNode is valid or None if the PathFromNode is valid for all times.
end	Int	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. The page_index sets the number of pages to skip (defaults to 0). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
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!]!

PathFromNodeWindowSet#

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. The page_index sets the number of pages to skip (defaults to 0). For example, if page(5, 2, 1) is called, a page with 5 items, offset by 11 items (2 pages of 5 + 1), will be returned.
limit	Int!
offset	Int
pageIndex	Int
list	[PathFromNode!]!

Properties#

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#

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

PropertySchema#

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

PropertyTuple#

Field	Argument	Type	Description
time		Int!
asString		String!
value		PropertyOutput!

QueryPlugin#

Field	Argument	Type	Description
NoOps		String!

ShortestPathOutput#

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

TemporalProperties#

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#

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

VectorisedGraph#

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

Inputs#

EdgeAddition#

Field	Type	Description
src	String!	Source node.
dst	String!	Destination node.
layer	String	Layer.
metadata	[PropertyInput!]	Metadata.
updates	[TemporalPropertyInput!]

EdgeFilter#

Field	Type	Description
src	NodeFieldFilter	Source node.
dst	NodeFieldFilter	Destination node.
property	PropertyFilterExpr	Property.
metadata	MetadataFilterExpr	Metadata.
temporalProperty	TemporalPropertyFilterExpr	Temporal property.
and	[EdgeFilter!]	AND operator.
or	[EdgeFilter!]	OR operator.
not	EdgeFilter	NOT operator.

EdgeSortBy#

Field	Type	Description
reverse	Boolean	Reverse order
src	Boolean	Source node
dst	Boolean	Destination
time	SortByTime	Time
property	String	Property

EdgeViewCollection#

Field	Type	Description
defaultLayer	Boolean	Contains only the default layer.
latest	Boolean	Latest time.
snapshotLatest	Boolean	Snapshot at latest time.
snapshotAt	Int	Snapshot at specified time.
layers	[String!]	List of included layers.
excludeLayers	[String!]	List of excluded layers.
layer	String	Single included layer.
excludeLayer	String	Single excluded layer.
window	Window	Window between a start and end time.
at	Int	View at a specified time.
before	Int	View before a specified time (end exclusive).
after	Int	View after a specified time (start exclusive).
shrinkWindow	Window	Shrink a Window to a specified start and end time.
shrinkStart	Int	Set the window start to a specified time.
shrinkEnd	Int	Set the window end to a specified time.

EdgesViewCollection#

Field	Type	Description
defaultLayer	Boolean	Contains only the default layer.
latest	Boolean	Latest time.
snapshotLatest	Boolean	Snapshot at latest time.
snapshotAt	Int	Snapshot at specified time.
layers	[String!]	List of included layers.
excludeLayers	[String!]	List of excluded layers.
layer	String	Single included layer.
excludeLayer	String	Single excluded layer.
window	Window	Window between a start and end time.
at	Int	View at a specified time.
before	Int	View before a specified time (end exclusive).
after	Int	View after a specified time (start exclusive).
shrinkWindow	Window	Shrink a Window to a specified start and end time.
shrinkStart	Int	Set the window start to a specified time.
shrinkEnd	Int	Set the window end to a specified time.

GraphViewCollection#

Field	Type	Description
defaultLayer	Boolean	Contains only the default layer.
layers	[String!]	List of included layers.
excludeLayers	[String!]	List of excluded layers.
layer	String	Single included layer.
excludeLayer	String	Single excluded layer.
subgraph	[String!]	Subgraph nodes.
subgraphNodeTypes	[String!]	Subgraph node types.
excludeNodes	[String!]	List of excluded nodes.
valid	Boolean	Valid state.
window	Window	Window between a start and end time.
at	Int	View at a specified time.
latest	Boolean	View at the latest time.
snapshotAt	Int	Snapshot at specified time.
snapshotLatest	Boolean	Snapshot at latest time.
before	Int	View before a specified time (end exclusive).
after	Int	View after a specified time (start exclusive).
shrinkWindow	Window	Shrink a Window to a specified start and end time.
shrinkStart	Int	Set the window start to a specified time.
shrinkEnd	Int	Set the window end to a specified time.
nodeFilter	NodeFilter	Node filter.
edgeFilter	EdgeFilter	Edge filter.

IndexSpecInput#

Field		Type	Description
nodeProps		PropsInput!	Node properties.
edgeProps		PropsInput!	Edge properties.

InputEdge#

Field		Type	Description
src		String!	Source node.
dst		String!	Destination node.

MetadataFilterExpr#

Field	Type	Description
name	String!	Node metadata to compare against.
operator	Operator!	Operator.
value	Value	Value.

NodeAddition#

Field	Type	Description
name	String!	Name.
nodeType	String	Node type.
metadata	[PropertyInput!]	Metadata.
updates	[TemporalPropertyInput!]	Updates.

NodeFieldFilter#

Field	Type	Description
field	NodeField!	Node component to compare against.
operator	Operator!	Operator filter.
value	Value!	Value filter.

NodeFilter#

Field	Type	Description
node	NodeFieldFilter	Node filter.
property	PropertyFilterExpr	Property filter.
metadata	MetadataFilterExpr	Metadata filter.
temporalProperty	TemporalPropertyFilterExpr	Temporal property filter.
and	[NodeFilter!]	AND operator.
or	[NodeFilter!]	OR operator.
not	NodeFilter	NOT operator.

NodeSortBy#

Field	Type	Description
reverse	Boolean	Reverse order
id	Boolean	Unique Id
time	SortByTime	Time
property	String	Property

NodeViewCollection#

Field	Type	Description
defaultLayer	Boolean	Contains only the default layer.
latest	Boolean	View at the latest time.
snapshotLatest	Boolean	Snapshot at latest time.
snapshotAt	Int	Snapshot at specified time.
layers	[String!]	List of included layers.
excludeLayers	[String!]	List of excluded layers.
layer	String	Single included layer.
excludeLayer	String	Single excluded layer.
window	Window	Window between a start and end time.
at	Int	View at a specified time.
before	Int	View before a specified time (end exclusive).
after	Int	View after a specified time (start exclusive).
shrinkWindow	Window	Shrink a Window to a specified start and end time.
shrinkStart	Int	Set the window start to a specified time.
shrinkEnd	Int	Set the window end to a specified time.
nodeFilter	NodeFilter	Node filter.

NodesViewCollection#

Field	Type	Description
defaultLayer	Boolean	Contains only the default layer.
latest	Boolean	View at the latest time.
snapshotLatest	Boolean	Snapshot at latest time.
layers	[String!]	List of included layers.
excludeLayers	[String!]	List of excluded layers.
layer	String	Single included layer.
excludeLayer	String	Single excluded layer.
window	Window	Window between a start and end time.
at	Int	View at a specified time.
snapshotAt	Int	Snapshot at specified time.
before	Int	View before a specified time (end exclusive).
after	Int	View after a specified time (start exclusive).
shrinkWindow	Window	Shrink a Window to a specified start and end time.
shrinkStart	Int	Set the window start to a specified time.
shrinkEnd	Int	Set the window end to a specified time.
nodeFilter	NodeFilter	Node filter.
typeFilter	[String!]	List of types.

ObjectEntry#

Field		Type	Description
key		String!	Key.
value		Value!	Value.

PathFromNodeViewCollection#

Field	Type	Description
latest	Boolean	Latest time.
snapshotLatest	Boolean	Latest snapshot.
snapshotAt	Int	Time.
layers	[String!]	List of layers.
excludeLayers	[String!]	List of excluded layers.
layer	String	Single layer.
excludeLayer	String	Single layer to exclude.
window	Window	Window between a start and end time.
at	Int	View at a specified time.
before	Int	View before a specified time (end exclusive).
after	Int	View after a specified time (start exclusive).
shrinkWindow	Window	Shrink a Window to a specified start and end time.
shrinkStart	Int	Set the window start to a specified time.
shrinkEnd	Int	Set the window end to a specified time.

PropertyFilterExpr#

Field	Type	Description
name	String!	Node property to compare against.
operator	Operator!	Operator.
value	Value	Value.

PropertyInput#

Field		Type	Description
key		String!	Key.
value		Value!	Value.

PropsInput#

Field		Type	Description
all		AllPropertySpec	All properties and metadata.
some		SomePropertySpec	Some properties and metadata.

SomePropertySpec#

SomePropertySpec object containing lists of metadata and property names.

Field		Type	Description
metadata		[String!]!	List of metadata.
properties		[String!]!	List of properties.

TemporalPropertyFilterExpr#

Field	Type	Description
name	String!	Name.
temporal	TemporalType!	Type of temporal property. Choose from: any, latest.
operator	Operator!	Operator.
value	Value	Value.

TemporalPropertyInput#

Field		Type	Description
time		Int!	Time.
properties		[PropertyInput!]	Properties.

Value#

Field	Type	Description
u64	Int	64 bit unsigned integer.
i64	Int	64 bit signed integer.
f64	Float	64 bit float.
str	String	String.
bool	Boolean	Boolean.
list	[Value!]	List.
object	[ObjectEntry!]	Object.

Window#

Field		Type	Description
start		Int!	Start time.
end		Int!	End time.

WindowDuration#

Field		Type	Description
duration		String	Duration of window period. Choose from:
epoch		Int	Time.

Enums#

AllPropertySpec#

Value	Description
ALL	All properties and metadata.
ALL_METADATA	All metadata.
ALL_PROPERTIES	All properties.

GraphType#

Value	Description
PERSISTENT	Persistent.
EVENT	Event.

NodeField#

Value	Description
NODE_NAME	Node name.
NODE_TYPE	Node type.

Operator#

Value	Description
EQUAL	Equality operator.
NOT_EQUAL	Inequality operator.
GREATER_THAN_OR_EQUAL	Greater Than Or Equal operator.
LESS_THAN_OR_EQUAL	Less Than Or Equal operator.
GREATER_THAN	Greater Than operator.
LESS_THAN	Less Than operator.
IS_NONE	Is None operator.
IS_SOME	Is Some operator.
IS_IN	Is In operator.
IS_NOT_IN	Is Not In operator.
CONTAINS	Contains operator.
NOT_CONTAINS	Not Contains operator.

SortByTime#

Value	Description
LATEST	Latest time
EARLIEST	Earliest time

TemporalType#

Value	Description
ANY	Any.
LATEST	Latest.

Scalars#

Boolean#

The Boolean scalar type represents true or false.

Float#

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Int#

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

PropertyOutput#

String#

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Upload#

Unions#

DocumentEntity#

Entity associated with document.

Type	Description
Node	Raphtory graph node.
Edge	Raphtory graph edge.

NamespacedItem#

Type	Description
Namespace
MetaGraph