com.gpudb.protocol

Class QueryGraphRequest.Options

java.lang.Object

com.gpudb.protocol.QueryGraphRequest.Options

Enclosing class:

QueryGraphRequest

public static final class QueryGraphRequest.Options
extends Object

Additional parameters

• FORCE_UNDIRECTED: If set to true, all inbound edges and outbound edges relative to the node will be returned. If set to false, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph graphName is directed and when querying nodes. Consult Directed Graphs for more details. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• LIMIT: When specified, limits the number of query results. Note that if the target_nodes_table is provided, the size of the corresponding table will be limited by the limit value. The default value is an empty Map.
• TARGET_NODES_TABLE: Name of the table to store the list of the final nodes reached during the traversal. If this value is left as the default, the table name will default to the adjacencyTable value plus a '_nodes' suffix, e.g., '_nodes'. The default value is ''.
• RESTRICTION_THRESHOLD_VALUE: Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the solution.
• EXPORT_QUERY_RESULTS: Returns query results in the response. If set to true, the adjacencyListIntArray (if the query was based on IDs), adjacencyListStringArray (if the query was based on names), or adjacencyListWktArray (if the query was based on WKTs) will be populated with the results. If set to false, none of the arrays will be populated. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• ENABLE_GRAPH_DRAW: If set to true, adds a WKT-type column named 'QUERY_EDGE_WKTLINE' to the given adjacencyTable and inputs WKT values from the source graph (if available) or auto-generated WKT values (if there are no WKT values in the source graph). A subsequent call to the /wms endpoint can then be made to display the query results on a map. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• AND_LABELS: If set to true, the result of the query has entities that satisfy all of the target labels, instead of any. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map. A set of string constants for the parameter options.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AND_LABELS If set to true, the result of the query has entities that satisfy all of the target labels, instead of any.
static String	ENABLE_GRAPH_DRAW If set to true, adds a WKT-type column named 'QUERY_EDGE_WKTLINE' to the given adjacencyTable and inputs WKT values from the source graph (if available) or auto-generated WKT values (if there are no WKT values in the source graph).
static String	EXPORT_QUERY_RESULTS Returns query results in the response.
static String	FALSE
static String	FORCE_UNDIRECTED If set to true, all inbound edges and outbound edges relative to the node will be returned.
static String	LIMIT When specified, limits the number of query results.
static String	RESTRICTION_THRESHOLD_VALUE Value-based restriction comparison.
static String	TARGET_NODES_TABLE Name of the table to store the list of the final nodes reached during the traversal.
static String	TRUE

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORCE_UNDIRECTED

public static final String FORCE_UNDIRECTED

If set to true, all inbound edges and outbound edges relative to the node will be returned. If set to false, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph graphName is directed and when querying nodes. Consult Directed Graphs for more details. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

TRUE

public static final String TRUE

See Also:

Constant Field Values

FALSE

public static final String FALSE

See Also:

Constant Field Values

LIMIT

public static final String LIMIT

When specified, limits the number of query results. Note that if the target_nodes_table is provided, the size of the corresponding table will be limited by the limit value. The default value is an empty Map.

See Also:

Constant Field Values

TARGET_NODES_TABLE

public static final String TARGET_NODES_TABLE

Name of the table to store the list of the final nodes reached during the traversal. If this value is left as the default, the table name will default to the adjacencyTable value plus a '_nodes' suffix, e.g., '_nodes'. The default value is ''.

See Also:

Constant Field Values

RESTRICTION_THRESHOLD_VALUE

public static final String RESTRICTION_THRESHOLD_VALUE

Value-based restriction comparison. Any node or edge with a RESTRICTIONS_VALUECOMPARED value greater than the restriction_threshold_value will not be included in the solution.

See Also:

Constant Field Values

EXPORT_QUERY_RESULTS

public static final String EXPORT_QUERY_RESULTS

Returns query results in the response. If set to true, the adjacencyListIntArray (if the query was based on IDs), adjacencyListStringArray (if the query was based on names), or adjacencyListWktArray (if the query was based on WKTs) will be populated with the results. If set to false, none of the arrays will be populated. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

ENABLE_GRAPH_DRAW

public static final String ENABLE_GRAPH_DRAW

If set to true, adds a WKT-type column named 'QUERY_EDGE_WKTLINE' to the given adjacencyTable and inputs WKT values from the source graph (if available) or auto-generated WKT values (if there are no WKT values in the source graph). A subsequent call to the /wms endpoint can then be made to display the query results on a map. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

AND_LABELS

public static final String AND_LABELS

If set to true, the result of the query has entities that satisfy all of the target labels, instead of any. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values