Skip to content

graphql #

Classes#

GraphServer#

A class for defining and running a Raphtory GraphQL server

RunningGraphServer#

A Raphtory server handler that also enables querying the server

RaphtoryClient#

A client for handling GraphQL operations in the context of Raphtory.

RemoteGraph#

RemoteEdge#

A remote edge reference

Returned by RemoteGraph.edge, RemoteGraph.add_edge, and RemoteGraph.delete_edge.

RemoteNode#

RemoteNodeAddition#

Node addition update

RemoteUpdate#

A temporal update

RemoteEdgeAddition#

An edge update

RemoteIndexSpec#

Create a RemoteIndexSpec specifying which node and edge properties to index.

PropsInput#

Create a PropsInput by choosing to include all/some properties explicitly.

SomePropertySpec#

Create a SomePropertySpec by explicitly listing metadata and/or temporal property names.

AllPropertySpec#

Specifies that all properties should be included when creating an index. Use one of the predefined variants: ALL , ALL_METADATA , or ALL_TEMPORAL .

Functions#

encode_graph(graph) #

Encode a graph using Base64 encoding

Arguments: graph (Graph | PersistentGraph): the graph

Returns: str: the encoded graph

decode_graph(graph) #

Decode a Base64-encoded graph

Arguments: graph (str): the encoded graph

Returns: Union[Graph, PersistentGraph]: the decoded graph

schema() #

Returns the raphtory graphql server schema

Returns str: Graphql schema