Skip to main content
interface QueryGraphRequest
adjacency_table?: string;
graph_name: string;
options?: Record<string, string>;
queries: string[];
restrictions?: string[];
rings?: number;
adjacency_table? graph_name options? queries restrictions? rings?
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.

graph_name: string

Name of the graph resource to query.

options?: Record<string, string>

Additional parameters.

queries: 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?: 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.

rings?: number

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.