RaphtoryClient

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

Methods

Method	Description
`copy_graph`	Copy graph from a path path on the server to a new_path on the server
`create_index`	Create Index for graph on the server at 'path'
`delete_graph`	Delete graph from a path path on the server
`is_server_online`	Check if the server is online.
`move_graph`	Move graph from a path path on the server to a new_path on the server
`new_graph`	Create a new empty Graph on the server at path
`query`	Make a GraphQL query against the server.
`receive_graph`	Receive graph from a path path on the server
`remote_graph`	Get a RemoteGraph reference to a graph on the server at path
`send_graph`	Send a graph to the server
`upload_graph`	Upload graph file from a path file_path on the client

Method Details

copy_graph

Signature: copy_graph(path, new_path)

Copy graph from a path path on the server to a new_path on the server

Parameters

Name	Type	Default	Description
`path`	str	-	the path of the graph to be copied
`new_path`	str	-	the new path of the copied graph

Returns

Type	Description
None

create_index

Signature: create_index(path, index_spec, in_ram=True)

Create Index for graph on the server at 'path'

Parameters

Name	Type	Default	Description
`RemoteIndexSpec`	RemoteIndexSpec	-	spec specifying the properties that need to be indexed
`in_ram`	bool, optional	`True`	create index in ram
`path`	Any	-
`index_spec`	Any	-

Returns

Type	Description
None

delete_graph

Signature: delete_graph(path)

Delete graph from a path path on the server

Parameters

Name	Type	Default	Description
`path`	str	-	the path of the graph to be deleted

Returns

Type	Description
None

is_server_online

Check if the server is online.

Returns

Type	Description
bool	Returns true if server is online otherwise false.

move_graph

Signature: move_graph(path, new_path)

Move graph from a path path on the server to a new_path on the server

Parameters

Name	Type	Default	Description
`path`	str	-	the path of the graph to be moved
`new_path`	str	-	the new path of the moved graph

Returns

Type	Description
None

new_graph

Signature: new_graph(path, graph_type)

Create a new empty Graph on the server at path

Parameters

Name	Type	Default	Description
`path`	str	-	the path of the graph to be created
`graph_type`	`Literal["EVENT", "PERSISTENT"]`	-	the type of graph that should be created - this can be EVENT or PERSISTENT

Returns

Type	Description
None

query

Signature: query(query, variables=None)

Make a GraphQL query against the server.

Parameters

Name	Type	Default	Description
`query`	str	-	the query to make.
`variables`	dict[str, Any], optional	`None`	a dict of variables present on the query and their values.

receive_graph

Signature: receive_graph(path)

Receive graph from a path path on the server

Parameters

Name	Type	Default	Description
`path`	str	-	the path of the graph to be received

remote_graph

Signature: remote_graph(path)

Get a RemoteGraph reference to a graph on the server at path

Parameters

Name	Type	Default	Description
`path`	str	-	the path of the graph to be created

Returns

Type	Description
RemoteGraph	the remote graph reference

send_graph

Signature: send_graph(path, graph, overwrite=False)

Send a graph to the server

Parameters

Name	Type	Default	Description
`path`	str	-	the path of the graph
`graph`	Graph \| PersistentGraph	-	the graph to send
`overwrite`	bool, optional	`False`	overwrite existing graph. Defaults to False.

upload_graph

Signature: upload_graph(path, file_path, overwrite=False)

Upload graph file from a path file_path on the client

Parameters

Name	Type	Default	Description
`path`	str	-	the name of the graph
`file_path`	str	-	the path of the graph on the client
`overwrite`	bool, optional	`False`	overwrite existing graph. Defaults to False.