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

> gpudb::ShowSchemaRequest — 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#a1cc194756eebfcbf911f60598b55daed">GPUdb::showSchema</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/show__schema_8h_source">gpudb/protocol/show\_schema.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:acf36e479dcd2b325a7fd81acbc7f12b2" id="r_acf36e479dcd2b325a7fd81acbc7f12b2">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#acf36e479dcd2b325a7fd81acbc7f12b2">ShowSchemaRequest</a> ()</td>
      </tr>

      <tr className="memdesc:acf36e479dcd2b325a7fd81acbc7f12b2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowSchemaRequest" title="A set of parameters for GPUdb::showSchema.">ShowSchemaRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

      <tr className="separator:af540ed83c1e94ee6ad48dcd2f9a992b4">
        <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:ab426d3779701046c6ea78613c2593a35" id="r_ab426d3779701046c6ea78613c2593a35">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab426d3779701046c6ea78613c2593a35">schemaName</a></td>
      </tr>

      <tr className="memdesc:ab426d3779701046c6ea78613c2593a35">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the schema for which to retrieve the information. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a1d3ec503dc22393856576104836bd876">
        <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#a1cc194756eebfcbf911f60598b55daed">GPUdb::showSchema</a>. </p>
      <p>Retrieves information about a <a href="/content/concepts/schemas/" target="_top">schema</a> (or all schemas), as specified in <a className="el" href="#ab426d3779701046c6ea78613c2593a35">schemaName</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__schema_8h_source#l00019">19</a> of file <a className="el" href="/content/api/cpp/show__schema_8h_source">show\_schema.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#acf36e479dcd2b325a7fd81acbc7f12b2">◆ </a></span>ShowSchemaRequest() <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::ShowSchemaRequest::ShowSchemaRequest </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_1ShowSchemaRequest" title="A set of parameters for GPUdb::showSchema.">ShowSchemaRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__schema_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/show__schema_8h_source">show\_schema.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#af540ed83c1e94ee6ad48dcd2f9a992b4">◆ </a></span>ShowSchemaRequest() <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::ShowSchemaRequest::ShowSchemaRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">schemaName\_</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_1ShowSchemaRequest" title="A set of parameters for GPUdb::showSchema.">ShowSchemaRequest</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">schemaName\_</td>
                <td>Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned. </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#af41f688d2e571fea39e93bcb1aae4f3e">show\_schema\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#abc687a170852e53bc07b6563ba3b07f0">false</a> will return an error if the provided <span className="em arg">schemaName\_</span> does not exist. If <a className="el" href="/content/api/cpp/namespacegpudb#a616d5dccf626e7832b98f554008408ac">true</a> then it will return an empty result if the provided <span className="em arg">schemaName\_</span> does not exist. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a616d5dccf626e7832b98f554008408ac">show\_schema\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#abc687a170852e53bc07b6563ba3b07f0">show\_schema\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#abc687a170852e53bc07b6563ba3b07f0">show\_schema\_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__schema_8h_source#l00061">61</a> of file <a className="el" href="/content/api/cpp/show__schema_8h_source">show\_schema.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#af41f688d2e571fea39e93bcb1aae4f3e">show\_schema\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#abc687a170852e53bc07b6563ba3b07f0">false</a> will return an error if the provided <a className="el" href="#ab426d3779701046c6ea78613c2593a35">schemaName</a> does not exist. If <a className="el" href="/content/api/cpp/namespacegpudb#a616d5dccf626e7832b98f554008408ac">true</a> then it will return an empty result if the provided <a className="el" href="#ab426d3779701046c6ea78613c2593a35">schemaName</a> does not exist. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a616d5dccf626e7832b98f554008408ac">show\_schema\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#abc687a170852e53bc07b6563ba3b07f0">show\_schema\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#abc687a170852e53bc07b6563ba3b07f0">show\_schema\_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__schema_8h_source#l00092">92</a> of file <a className="el" href="/content/api/cpp/show__schema_8h_source">show\_schema.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ab426d3779701046c6ea78613c2593a35">◆ </a></span>schemaName</h2>

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

      <div className="memdoc">
        <p>Name of the schema for which to retrieve the information. </p>
        <p>If blank, then info for all schemas is returned. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__schema_8h_source#l00071">71</a> of file <a className="el" href="/content/api/cpp/show__schema_8h_source">show\_schema.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__schema_8h_source">show\_schema.h</a></li>
    </ul>
  </div>
</div>