Struct raphtory_graphql::server::GraphServer

pub struct GraphServer { /* private fields */ }

A struct for defining and running a Raphtory GraphQL server

Implementations

impl GraphServer

pub fn new( work_dir: PathBuf, app_config: Option<AppConfig>, config_path: Option<PathBuf>, ) -> IoResult<Self>

pub async fn with_vectorised<F, T>( self, graph_names: Option<Vec<String>>, embedding: F, cache: &Path, template: Option<T>, ) -> IoResult<Self>

where F: EmbeddingFunction + Clone + 'static, T: DocumentTemplate<DynamicGraph> + 'static,

Vectorise a subset of the graphs of the server.

Arguments:

• graph_names - the names of the graphs to vectorise. All if None is provided.
• embedding - the embedding function to translate documents to embeddings.
• cache - the directory to use as cache for the embeddings.
• template - the template to use for creating documents.

Returns: A new server object containing the vectorised graphs.

pub fn register_algorithm<'a, E: AlgorithmEntryPoint<'a> + 'static, A: Algorithm<'a, E> + 'static>( self, name: &str, ) -> Self

pub async fn start(self) -> IoResult<RunningGraphServer>

Start the server on the default port and return a handle to it.

pub async fn start_with_port(self, port: u16) -> IoResult<RunningGraphServer>

Start the server on the port port and return a handle to it.

pub async fn run(self) -> IoResult<()>

Run the server on the default port until completion.

pub async fn run_with_port(self, port: u16) -> IoResult<()>

Run the server on the port port until completion.