> ## 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::ShowGraphRequest

> gpudb::ShowGraphRequest — 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#aa26104ece9a4825f8fd309470e2477ec">GPUdb::showGraph</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/show__graph_8h_source">gpudb/protocol/show\_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:a21e3fc83337509880f229aa1d173911d" id="r_a21e3fc83337509880f229aa1d173911d">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a21e3fc83337509880f229aa1d173911d">ShowGraphRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a21e3fc83337509880f229aa1d173911d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowGraphRequest" title="A set of parameters for GPUdb::showGraph.">ShowGraphRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a9ea797d9778c05d804518dc160b37931" id="r_a9ea797d9778c05d804518dc160b37931">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9ea797d9778c05d804518dc160b37931">ShowGraphRequest</a> (const std::string \&graphName\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:a9ea797d9778c05d804518dc160b37931">
        <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:ad076027d312689fdfb1111950f10b639" id="r_ad076027d312689fdfb1111950f10b639">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad076027d312689fdfb1111950f10b639">graphName</a></td>
      </tr>

      <tr className="memdesc:ad076027d312689fdfb1111950f10b639">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the graph on which to retrieve information. <br /></td>
      </tr>

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

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

      <tr className="memdesc:acad25e09ff8446c8e6b64bc34af163e4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:acad25e09ff8446c8e6b64bc34af163e4">
        <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#aa26104ece9a4825f8fd309470e2477ec">GPUdb::showGraph</a>. </p>
      <p>Shows information and characteristics of graphs that exist on the graph server. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__graph_8h_source#l00018">18</a> of file <a className="el" href="/content/api/cpp/show__graph_8h_source">show\_graph.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a21e3fc83337509880f229aa1d173911d">◆ </a></span>ShowGraphRequest() <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::ShowGraphRequest::ShowGraphRequest </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_1ShowGraphRequest" title="A set of parameters for GPUdb::showGraph.">ShowGraphRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__graph_8h_source#l00023">23</a> of file <a className="el" href="/content/api/cpp/show__graph_8h_source">show\_graph.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a9ea797d9778c05d804518dc160b37931">◆ </a></span>ShowGraphRequest() <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::ShowGraphRequest::ShowGraphRequest </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::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_1ShowGraphRequest" title="A set of parameters for GPUdb::showGraph.">ShowGraphRequest</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 on which to retrieve information. If left as the default value, information about all graphs is returned. The default value is ''. </td>
              </tr>

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

                <td>
                  Optional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a3bb68b1028a864565f1ce5919de172f4">show\_graph\_show\_original\_request</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a26a3b0bf712e67e2e00990e225e367f2">true</a>, the request that was originally used to create the graph is also returned as JSON. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a26a3b0bf712e67e2e00990e225e367f2">show\_graph\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a592bbf5af85bb488e6cad6647134bcdb">show\_graph\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a26a3b0bf712e67e2e00990e225e367f2">show\_graph\_true</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3814a4ae4f1f583d62e4f013824e7e07">show\_graph\_server\_id</a>: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#aab789724b8c8e65eecbf3c6bab42d8a6">show\_graph\_export\_graph\_schema</a>: If true, generates the graph ontology (schema) as a DOT format string in the response info field under the key 'dot'. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a26a3b0bf712e67e2e00990e225e367f2">show\_graph\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a592bbf5af85bb488e6cad6647134bcdb">show\_graph\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a592bbf5af85bb488e6cad6647134bcdb">show\_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/show__graph_8h_source#l00080">80</a> of file <a className="el" href="/content/api/cpp/show__graph_8h_source">show\_graph.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the graph on which to retrieve information. </p>
        <p>If left as the default value, information about all graphs is returned. The default value is ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__graph_8h_source#l00091">91</a> of file <a className="el" href="/content/api/cpp/show__graph_8h_source">show\_graph.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a3bb68b1028a864565f1ce5919de172f4">show\_graph\_show\_original\_request</a>: If set to <a className="el" href="/content/api/cpp/namespacegpudb#a26a3b0bf712e67e2e00990e225e367f2">true</a>, the request that was originally used to create the graph is also returned as JSON. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a26a3b0bf712e67e2e00990e225e367f2">show\_graph\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a592bbf5af85bb488e6cad6647134bcdb">show\_graph\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a26a3b0bf712e67e2e00990e225e367f2">show\_graph\_true</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3814a4ae4f1f583d62e4f013824e7e07">show\_graph\_server\_id</a>: Indicates which graph server(s) to send the request to. Default is to send to get information about all the servers. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#aab789724b8c8e65eecbf3c6bab42d8a6">show\_graph\_export\_graph\_schema</a>: If true, generates the graph ontology (schema) as a DOT format string in the response info field under the key 'dot'. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a26a3b0bf712e67e2e00990e225e367f2">show\_graph\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a592bbf5af85bb488e6cad6647134bcdb">show\_graph\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a592bbf5af85bb488e6cad6647134bcdb">show\_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/show__graph_8h_source#l00125">125</a> of file <a className="el" href="/content/api/cpp/show__graph_8h_source">show\_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/show__graph_8h_source">show\_graph.h</a></li>
    </ul>
  </div>
</div>