Struct QueryGraphParams 

pub struct QueryGraphParams {
    pub entity_name: Result<String, DbErr>,
    pub relation_name: Result<String, DbErr>,
    pub reverse_direction: bool,
    pub root_node_names: Vec<String>,
    pub max_depth: Option<u64>,
    pub batch_sort_key: Option<String>,
    pub batch_sort_asc: bool,
    pub max_batch_size: Option<usize>,
    pub max_total_size: Option<usize>,
}

A helper struct to specify how to perform a graph query

Fields

entity_name: Result<String, DbErr>

Which entity to consider for constructing the graph (unformatted)

relation_name: Result<String, DbErr>

Which relation to consider for constructing the graph (unformatted)

reverse_direction: bool

Whether to reverse the direction when constructing the graph

root_node_names: Vec<String>

Specify the root nodes to be the nodes with the supplied names The keys in the HashMaps must be Formatted.

max_depth: Option<u64>

Recursion goes up to this level, 0 means no recursion at all. Recursion does not terminate early if this value is None.

batch_sort_key: Option<String>

Sort each batch on this key (this value is a Formatted column name). This key is also used as for filling the weight field of queried nodes, if supplied. The order is random if this value is None.

batch_sort_asc: bool

Sort each batch in an ascending order if this value is true.

max_batch_size: Option<usize>

Include up to this number of nodes in each batch. All nodes are included in all batches if this value is None.

max_total_size: Option<usize>

Include up to this number of nodes across the whole recursion. All nodes are included if this value is None.

Implementations

impl QueryGraphParams

pub fn from_query_graph_metadata(metadata: QueryGraphJson) -> Self

Construct params from metadata

Trait Implementations

impl Debug for QueryGraphParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryGraphParams

fn default() -> Self

Returns the “default value” for a type.