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

> gpudb::AlterSchemaRequest — 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#a6d8737eef0ac5964bafee8168c7001c2">GPUdb::alterSchema</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/alter__schema_8h_source">gpudb/protocol/alter\_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:af37f6e2a33c1da6192ca463b15bc23f9" id="r_af37f6e2a33c1da6192ca463b15bc23f9">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af37f6e2a33c1da6192ca463b15bc23f9">AlterSchemaRequest</a> ()</td>
      </tr>

      <tr className="memdesc:af37f6e2a33c1da6192ca463b15bc23f9">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterSchemaRequest" title="A set of parameters for GPUdb::alterSchema.">AlterSchemaRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

      <tr className="memdesc:ab186effa928b25494be8e9f87962f885">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterSchemaRequest" title="A set of parameters for GPUdb::alterSchema.">AlterSchemaRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="memdesc:a5d2aa8bd3561ad50e0ff38b0fb54e188">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the schema to be altered. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a49517cfdce15eaf73512c75f6bc99129">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Modification operation to be applied. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a1b763aa156f7e251002fbbf8e73c2a90">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The value of the modification, depending on <a className="el" href="#a49517cfdce15eaf73512c75f6bc99129">action</a>. <br /></td>
      </tr>

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

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

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

      <tr className="separator:aa1e823d73cbf9aa286e0607b7f09093a">
        <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#a6d8737eef0ac5964bafee8168c7001c2">GPUdb::alterSchema</a>. </p>
      <p>Used to change the name of a SQL-style <a href="/content/concepts/schemas/" target="_top">schema</a>, specified in <a className="el" href="#a5d2aa8bd3561ad50e0ff38b0fb54e188">schemaName</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__schema_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/alter__schema_8h_source">alter\_schema.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#af37f6e2a33c1da6192ca463b15bc23f9">◆ </a></span>AlterSchemaRequest() <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::AlterSchemaRequest::AlterSchemaRequest </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 an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterSchemaRequest" title="A set of parameters for GPUdb::alterSchema.">AlterSchemaRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__schema_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/alter__schema_8h_source">alter\_schema.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ab186effa928b25494be8e9f87962f885">◆ </a></span>AlterSchemaRequest() <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::AlterSchemaRequest::AlterSchemaRequest </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::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">action\_</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">value\_</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 an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterSchemaRequest" title="A set of parameters for GPUdb::alterSchema.">AlterSchemaRequest</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 to be altered. </td>
              </tr>

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

                <td>
                  Modification operation to be applied. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a215bf1e57bd8f9f909b7239f69646f85">alter\_schema\_add\_comment</a>: Adds a comment describing the schema. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b093863b91bdd60ffe707d7e063072">alter\_schema\_rename\_schema</a>: Renames a schema to <span className="em arg">value\_</span>. Has the same naming restrictions as <a href="/content/concepts/tables/" target="_top">tables</a>. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">value\_</td>
                <td>The value of the modification, depending on <span className="em arg">action\_</span>. For now the only value of <span className="em arg">action\_</span> is <a className="el" href="/content/api/cpp/namespacegpudb#ad4b093863b91bdd60ffe707d7e063072">rename\_schema</a>. In this case the value is the new name of the schema. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>
                <td>Optional parameters. 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/alter__schema_8h_source#l00059">59</a> of file <a className="el" href="/content/api/cpp/alter__schema_8h_source">alter\_schema.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Modification operation to be applied. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a215bf1e57bd8f9f909b7239f69646f85">alter\_schema\_add\_comment</a>: Adds a comment describing the schema. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad4b093863b91bdd60ffe707d7e063072">alter\_schema\_rename\_schema</a>: Renames a schema to <a className="el" href="#a1b763aa156f7e251002fbbf8e73c2a90">value</a>. Has the same naming restrictions as <a href="/content/concepts/tables/" target="_top">tables</a>. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__schema_8h_source#l00085">85</a> of file <a className="el" href="/content/api/cpp/alter__schema_8h_source">alter\_schema.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Optional parameters. </p>
        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__schema_8h_source#l00098">98</a> of file <a className="el" href="/content/api/cpp/alter__schema_8h_source">alter\_schema.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the schema to be altered. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__schema_8h_source#l00070">70</a> of file <a className="el" href="/content/api/cpp/alter__schema_8h_source">alter\_schema.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a1b763aa156f7e251002fbbf8e73c2a90">◆ </a></span>value</h2>

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

      <div className="memdoc">
        <p>The value of the modification, depending on <a className="el" href="#a49517cfdce15eaf73512c75f6bc99129">action</a>. </p>
        <p>For now the only value of <a className="el" href="#a49517cfdce15eaf73512c75f6bc99129">action</a> is <a className="el" href="/content/api/cpp/namespacegpudb#ad4b093863b91bdd60ffe707d7e063072">rename\_schema</a>. In this case the value is the new name of the schema. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__schema_8h_source#l00093">93</a> of file <a className="el" href="/content/api/cpp/alter__schema_8h_source">alter\_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/alter__schema_8h_source">alter\_schema.h</a></li>
    </ul>
  </div>
</div>