> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# gpudb::QueryGraphRequest

> gpudb::QueryGraphRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aa19b2032dbef0fd308b55202fcb738fa">GPUdb::queryGraph</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/query__graph_8h_source">gpudb/protocol/query\_graph.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a8cfd6e9f3badbe77ab50c8a21f9d6e2d" id="r_a8cfd6e9f3badbe77ab50c8a21f9d6e2d">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8cfd6e9f3badbe77ab50c8a21f9d6e2d">QueryGraphRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a8cfd6e9f3badbe77ab50c8a21f9d6e2d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1QueryGraphRequest" title="A set of parameters for GPUdb::queryGraph.">QueryGraphRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a8cfd6e9f3badbe77ab50c8a21f9d6e2d">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:af3f8db2d0294c3527d925dc6206dd4ef" id="r_af3f8db2d0294c3527d925dc6206dd4ef">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af3f8db2d0294c3527d925dc6206dd4ef">QueryGraphRequest</a> (const std::string \&graphName\_, const std::vector\< std::string > \&queries\_, const std::vector\< std::string > \&restrictions\_, const std::string \&adjacencyTable\_, const int32\_t rings\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:af3f8db2d0294c3527d925dc6206dd4ef">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1QueryGraphRequest" title="A set of parameters for GPUdb::queryGraph.">QueryGraphRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:af3f8db2d0294c3527d925dc6206dd4ef">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a43ad7b0ca838e70712631eb0bbfc75be" id="r_a43ad7b0ca838e70712631eb0bbfc75be">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a43ad7b0ca838e70712631eb0bbfc75be">graphName</a></td>
      </tr>

      <tr className="memdesc:a43ad7b0ca838e70712631eb0bbfc75be">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the graph resource to query. <br /></td>
      </tr>

      <tr className="separator:a43ad7b0ca838e70712631eb0bbfc75be">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a8b2317188945fb7342e569296c876a4a" id="r_a8b2317188945fb7342e569296c876a4a">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8b2317188945fb7342e569296c876a4a">queries</a></td>
      </tr>

      <tr className="memdesc:a8b2317188945fb7342e569296c876a4a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Nodes or edges to be queried specified using <a href="/content/graph_solver/network_graph_solver/#query-identifiers" target="_top">query identifiers</a>. <br /></td>
      </tr>

      <tr className="separator:a8b2317188945fb7342e569296c876a4a">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:aa58f0fdf080453b7a1e9cc902142bc9e" id="r_aa58f0fdf080453b7a1e9cc902142bc9e">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa58f0fdf080453b7a1e9cc902142bc9e">restrictions</a></td>
      </tr>

      <tr className="memdesc:aa58f0fdf080453b7a1e9cc902142bc9e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Additional restrictions to apply to the nodes/edges of an existing graph. <br /></td>
      </tr>

      <tr className="separator:aa58f0fdf080453b7a1e9cc902142bc9e">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a3be4a716bb21623b98e4dfa4392d9b0e" id="r_a3be4a716bb21623b98e4dfa4392d9b0e">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3be4a716bb21623b98e4dfa4392d9b0e">adjacencyTable</a></td>
      </tr>

      <tr className="memdesc:a3be4a716bb21623b98e4dfa4392d9b0e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table to store the resulting adjacencies, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. <br /></td>
      </tr>

      <tr className="separator:a3be4a716bb21623b98e4dfa4392d9b0e">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a876cb0cb7771705f7ba0bb0cca1b27c8" id="r_a876cb0cb7771705f7ba0bb0cca1b27c8">
        <td className="memItemLeft" align="right" valign="top">int32\_t </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a876cb0cb7771705f7ba0bb0cca1b27c8">rings</a></td>
      </tr>

      <tr className="memdesc:a876cb0cb7771705f7ba0bb0cca1b27c8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Sets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node. <br /></td>
      </tr>

      <tr className="separator:a876cb0cb7771705f7ba0bb0cca1b27c8">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a83583b6f7b945369de5780a2b24861b9" id="r_a83583b6f7b945369de5780a2b24861b9">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a83583b6f7b945369de5780a2b24861b9">options</a></td>
      </tr>

      <tr className="memdesc:a83583b6f7b945369de5780a2b24861b9">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Additional parameters. <br /></td>
      </tr>

      <tr className="separator:a83583b6f7b945369de5780a2b24861b9">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aa19b2032dbef0fd308b55202fcb738fa">GPUdb::queryGraph</a>. </p>
      <p>Employs a topological query on a graph generated a-priori by <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a4055b3b0cd047d5c78f8ab61350e1c4e">GPUdb::createGraph</a> and returns a list of adjacent edge(s) or node(s), also known as an adjacency list, depending on what's been provided to the endpoint; providing edges will return nodes and providing nodes will return edges.</p>
      <p>To determine the node(s) or edge(s) adjacent to a value from a given column, provide a list of values to <a className="el" href="#a8b2317188945fb7342e569296c876a4a">queries</a>. This field can be populated with column values from any table as long as the type is supported by the given identifier. See <a href="/content/graph_solver/network_graph_solver/#query-identifiers" target="_top">Query Identifiers</a> for more information.</p>
      <p>To return the adjacency list in the response, leave <a className="el" href="#a3be4a716bb21623b98e4dfa4392d9b0e">adjacencyTable</a> empty.</p>
      <p>IMPORTANT: It's highly recommended that you review the <a href="/content/graph_solver/network_graph_solver/" target="_top">Graphs and Solvers</a> concepts documentation, the <a href="/content/guides/graph_rest_guide/" target="_top">Graph REST Tutorial</a>, and/or some <a href="/content/guides/tags/graph-query" target="_top">/match/graph examples</a> before using this endpoint. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/query__graph_8h_source#l00038">38</a> of file <a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a8cfd6e9f3badbe77ab50c8a21f9d6e2d">◆ </a></span>QueryGraphRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::QueryGraphRequest::QueryGraphRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1QueryGraphRequest" title="A set of parameters for GPUdb::queryGraph.">QueryGraphRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/query__graph_8h_source#l00043">43</a> of file <a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af3f8db2d0294c3527d925dc6206dd4ef">◆ </a></span>QueryGraphRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::QueryGraphRequest::QueryGraphRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">graphName\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">queries\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">restrictions\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">adjacencyTable\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const int32\_t</td>
                  <td className="paramname"><span className="paramname"><span className="em">rings\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1QueryGraphRequest" title="A set of parameters for GPUdb::queryGraph.">QueryGraphRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">graphName\_</td>
                <td>Name of the graph resource to query. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">queries\_</td>
                <td>Nodes or edges to be queried specified using <a href="/content/graph_solver/network_graph_solver/#query-identifiers" target="_top">query identifiers</a>. 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. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">restrictions\_</td>
                <td>Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using <a href="/content/graph_solver/network_graph_solver/#identifiers" target="_top">identifiers</a>; identifiers are grouped as <a href="/content/graph_solver/network_graph_solver/#id-combos" target="_top">combinations</a>. 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. The default value is an empty vector. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">adjacencyTable\_</td>
                <td>Name of the table to store the resulting adjacencies, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. If left blank, the query results are instead returned in the response. If the 'QUERY\_TARGET\_NODE\_LABEL' <a href="/content/graph_solver/network_graph_solver/#query-identifiers" target="_top">query identifier</a> is used in <span className="em arg">queries\_</span>, then two additional columns will be available: 'PATH\_ID' and 'RING\_ID'. See <a href="/content/graph_solver/network_graph_solver/#using-labels" target="_top">Using Labels</a> for more information. The default value is ''. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">rings\_</td>
                <td>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 <span className="em arg">queries\_</span> and <span className="em arg">restrictions\_</span> will be returned. This parameter is only applicable when querying nodes. The default value is 1. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  Additional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a1dcd1e4aa5331b29f656ec75cfddc0b1">query\_graph\_force\_undirected</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">true</a>, all inbound edges and outbound edges relative to the node will be returned. If set to <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">false</a>, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph <span className="em arg">graphName\_</span> is directed and when querying nodes. Consult <a href="/content/graph_solver/network_graph_solver/#directed-graphs" target="_top">Directed Graphs</a> for more details. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">query\_graph\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#af9f4cf4858229ecd6fbb88d2e807a696">query\_graph\_limit</a>: When specified (>0), limits the number of query results. The size of the nodes table will be limited by the <a className="el" href="/content/api/cpp/namespacegpudb#af9f4cf4858229ecd6fbb88d2e807a696">limit</a> value. The default value is '0'. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a56c6520637ee893244d5c5d7a9d053e3">query\_graph\_output\_wkt\_path</a>: If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">query\_graph\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a152343177fe41887b1f2c8f7ea51a686">query\_graph\_and\_labels</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">true</a>, the result of the query has entities that satisfy all of the target labels, instead of any. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">query\_graph\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac82b78326aa02649f70af36c7f378b6a">query\_graph\_server\_id</a>: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0eb7ba53622df90830d072d4ada6b84b">query\_graph\_output\_charn\_length</a>: When specified (>0 and \<=256), limits the number of char length on the output tables for string based nodes. The default length is 64. The default value is '64'. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a57bf4d6470e8662acd69f93096a48dc1">query\_graph\_find\_common\_labels</a>: If set to true, for many-to-many queries or multi-level traversals, it lists the common labels between the source and target nodes and edge labels in each path. Otherwise (zero rings), it'll list all labels of the node(s) queried. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">query\_graph\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a>.
                    </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/query__graph_8h_source#l00222">222</a> of file <a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a3be4a716bb21623b98e4dfa4392d9b0e">◆ </a></span>adjacencyTable</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::QueryGraphRequest::adjacencyTable</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the table to store the resulting adjacencies, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a> and meeting <a href="/content/concepts/tables/#table-naming-criteria" target="_top">table naming criteria</a>. </p>
        <p>If left blank, the query results are instead returned in the response. If the 'QUERY\_TARGET\_NODE\_LABEL' <a href="/content/graph_solver/network_graph_solver/#query-identifiers" target="_top">query identifier</a> is used in <a className="el" href="#a8b2317188945fb7342e569296c876a4a">queries</a>, then two additional columns will be available: 'PATH\_ID' and 'RING\_ID'. See <a href="/content/graph_solver/network_graph_solver/#using-labels" target="_top">Using Labels</a> for more information. The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/query__graph_8h_source#l00282">282</a> of file <a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a43ad7b0ca838e70712631eb0bbfc75be">◆ </a></span>graphName</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::QueryGraphRequest::graphName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the graph resource to query. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/query__graph_8h_source#l00235">235</a> of file <a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a83583b6f7b945369de5780a2b24861b9">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::QueryGraphRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Additional parameters. </p>

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a1dcd1e4aa5331b29f656ec75cfddc0b1">query\_graph\_force\_undirected</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">true</a>, all inbound edges and outbound edges relative to the node will be returned. If set to <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">false</a>, only outbound edges relative to the node will be returned. This parameter is only applicable if the queried graph <a className="el" href="#a43ad7b0ca838e70712631eb0bbfc75be">graphName</a> is directed and when querying nodes. Consult <a href="/content/graph_solver/network_graph_solver/#directed-graphs" target="_top">Directed Graphs</a> for more details. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">query\_graph\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#af9f4cf4858229ecd6fbb88d2e807a696">query\_graph\_limit</a>: When specified (>0), limits the number of query results. The size of the nodes table will be limited by the <a className="el" href="/content/api/cpp/namespacegpudb#af9f4cf4858229ecd6fbb88d2e807a696">limit</a> value. The default value is '0'. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a56c6520637ee893244d5c5d7a9d053e3">query\_graph\_output\_wkt\_path</a>: If true then concatenated wkt line segments will be added as the WKT column of the adjacency table. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">query\_graph\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a152343177fe41887b1f2c8f7ea51a686">query\_graph\_and\_labels</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">true</a>, the result of the query has entities that satisfy all of the target labels, instead of any. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">query\_graph\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac82b78326aa02649f70af36c7f378b6a">query\_graph\_server\_id</a>: Indicates which graph server(s) to send the request to. Default is to send to the server, amongst those containing the corresponding graph, that has the most computational bandwidth. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0eb7ba53622df90830d072d4ada6b84b">query\_graph\_output\_charn\_length</a>: When specified (>0 and \<=256), limits the number of char length on the output tables for string based nodes. The default length is 64. The default value is '64'. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a57bf4d6470e8662acd69f93096a48dc1">query\_graph\_find\_common\_labels</a>: If set to true, for many-to-many queries or multi-level traversals, it lists the common labels between the source and target nodes and edge labels in each path. Otherwise (zero rings), it'll list all labels of the node(s) queried. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1cd1170a7b667692ad0549777c7e1f2">query\_graph\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a77fd961bc121320757340b18ae256129">query\_graph\_false</a>.
          </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/query__graph_8h_source#l00371">371</a> of file <a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a8b2317188945fb7342e569296c876a4a">◆ </a></span>queries</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> gpudb::QueryGraphRequest::queries</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Nodes or edges to be queried specified using <a href="/content/graph_solver/network_graph_solver/#query-identifiers" target="_top">query identifiers</a>. </p>
        <p>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. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/query__graph_8h_source#l00248">248</a> of file <a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aa58f0fdf080453b7a1e9cc902142bc9e">◆ </a></span>restrictions</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> gpudb::QueryGraphRequest::restrictions</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Additional restrictions to apply to the nodes/edges of an existing graph. </p>
        <p>Restrictions must be specified using <a href="/content/graph_solver/network_graph_solver/#identifiers" target="_top">identifiers</a>; identifiers are grouped as <a href="/content/graph_solver/network_graph_solver/#id-combos" target="_top">combinations</a>. 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. The default value is an empty vector. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/query__graph_8h_source#l00264">264</a> of file <a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a876cb0cb7771705f7ba0bb0cca1b27c8">◆ </a></span>rings</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int32\_t gpudb::QueryGraphRequest::rings</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Sets the number of rings around the node to query for adjacency, with '1' being the edges directly attached to the queried node. </p>
        <p>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 <a className="el" href="#a8b2317188945fb7342e569296c876a4a">queries</a> and <a className="el" href="#aa58f0fdf080453b7a1e9cc902142bc9e">restrictions</a> will be returned. This parameter is only applicable when querying nodes. The default value is 1. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/query__graph_8h_source#l00296">296</a> of file <a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/query__graph_8h_source">query\_graph.h</a></li>
    </ul>
  </div>
</div>