Skip to main content
pub struct QueryGraphRequest 
    pub graph_name: String,
    pub queries: Vec<String>,
    pub restrictions: Vec<String>,
    pub adjacency_table: String,
    pub rings: i32,
    pub options: HashMap<String, String>,

The request payload for the /query/graph endpoint.

Queries an existing graph.

Fields

graph_name: String

Name of the graph resource to query.

queries: Vec<String>

Nodes or edges to be queried specified using query identifiers. Identifiers can be used with existing column names, e.g., ‘table.column AS QUERY_NODE_ID’, raw values, e.g., ‘0, 2 AS QUERY_NODE_ID’, or expressions, e.g., ‘ST_MAKEPOINT(table.x, table.y) AS QUERY_NODE_WKTPOINT’. Multiple values can be provided as long as the same identifier is used for all values. If using raw values in an identifier combination, the number of values specified must match across the combination.

restrictions: Vec<String>

Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., ‘table.column AS RESTRICTIONS_EDGE_ID’, expressions, e.g., ‘column/2 AS RESTRICTIONS_VALUECOMPARED’, or raw values, e.g., ‘0, 0, 0, 1 AS RESTRICTIONS_ONOFFCOMPARED’. If using raw values in an identifier combination, the number of values specified must match across the combination.

adjacency_table: String

Name of the table to store the resulting adjacencies, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. If left blank, the query results are instead returned in the response. If the ‘QUERY_TARGET_NODE_LABEL’ query identifier is used in queries, then two additional columns will be available: ‘PATH_ID’ and ‘RING_ID’. See Using Labels for more information.

rings: i32

Sets the number of rings around the node to query for adjacency, with ‘1’ being the edges directly attached to the queried node. Also known as number of hops. For example, if it is set to ‘2’, the edge(s) directly attached to the queried node(s) will be returned; in addition, the edge(s) attached to the node(s) attached to the initial ring of edge(s) surrounding the queried node(s) will be returned. If the value is set to ‘0’, any nodes that meet the criteria in queries and restrictions will be returned. This parameter is only applicable when querying nodes.

options: HashMap<String, String>

Additional parameters.

Trait Implementations

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source

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

Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Source

fn deserialize<__D>(__deserializer: __D) ->Result<Self, __D::Error>
where __D: Deserializer<‘de>,

Deserialize this value from the given Serde deserializer. Read more
Source

fn avro_schema(&self) -> &‘static str

Returns the Avro schema as a JSON string for this record type.
Returns type properties including field types and attributes (e.g., primary_key).
Whether requests of this type are Snappy-compressed when the client has KineticaOptions::use_snappy enabled. Read more
Source

fn serialize<__S>(&self, __serializer: __S) ->Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more