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

> gpudb::AlterTableMetadataRequest — 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#a4fbed5af394ba543a8722e34e0ca8aa4">GPUdb::alterTableMetadata</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/alter__table__metadata_8h_source">gpudb/protocol/alter\_table\_metadata.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:ac80b23febbda9cef596b1e924f16cbe8" id="r_ac80b23febbda9cef596b1e924f16cbe8">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac80b23febbda9cef596b1e924f16cbe8">AlterTableMetadataRequest</a> ()</td>
      </tr>

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

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

      <tr className="memitem:ad09e34db15fc0f85e8a2d8f6c2784761" id="r_ad09e34db15fc0f85e8a2d8f6c2784761">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad09e34db15fc0f85e8a2d8f6c2784761">AlterTableMetadataRequest</a> (const std::vector\< std::string > \&tableNames\_, const std::map\< std::string, std::string > \&metadataMap\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:ad09e34db15fc0f85e8a2d8f6c2784761">
        <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:ae567f6aa1d741774426ff00cf0b357dd" id="r_ae567f6aa1d741774426ff00cf0b357dd">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae567f6aa1d741774426ff00cf0b357dd">tableNames</a></td>
      </tr>

      <tr className="memdesc:ae567f6aa1d741774426ff00cf0b357dd">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Names of the tables whose metadata will be updated, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a9bb67485844da8c2d2c873ff8174515f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A map which contains the metadata of the tables that are to be updated. <br /></td>
      </tr>

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

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

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

      <tr className="separator:ae15d2c1fc007355a60df70b242dad864">
        <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#a4fbed5af394ba543a8722e34e0ca8aa4">GPUdb::alterTableMetadata</a>. </p>
      <p>Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source#l00021">21</a> of file <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source">alter\_table\_metadata.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ac80b23febbda9cef596b1e924f16cbe8">◆ </a></span>AlterTableMetadataRequest() <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::AlterTableMetadataRequest::AlterTableMetadataRequest </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_1AlterTableMetadataRequest" title="A set of parameters for GPUdb::alterTableMetadata.">AlterTableMetadataRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source#l00027">27</a> of file <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source">alter\_table\_metadata.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ad09e34db15fc0f85e8a2d8f6c2784761">◆ </a></span>AlterTableMetadataRequest() <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::AlterTableMetadataRequest::AlterTableMetadataRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableNames\_</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">metadataMap\_</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_1AlterTableMetadataRequest" title="A set of parameters for GPUdb::alterTableMetadata.">AlterTableMetadataRequest</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">tableNames\_</td>
                <td>Names of the tables whose metadata will be updated, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. All specified tables must exist, or an error will be returned. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">metadataMap\_</td>
                <td>A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared. </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__table__metadata_8h_source#l00055">55</a> of file <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source">alter\_table\_metadata.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>A map which contains the metadata of the tables that are to be updated. </p>
        <p>Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source#l00077">77</a> of file <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source">alter\_table\_metadata.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::AlterTableMetadataRequest::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__table__metadata_8h_source#l00082">82</a> of file <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source">alter\_table\_metadata.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ae567f6aa1d741774426ff00cf0b357dd">◆ </a></span>tableNames</h2>

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

      <div className="memdoc">
        <p>Names of the tables whose metadata will be updated, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>All specified tables must exist, or an error will be returned. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source#l00069">69</a> of file <a className="el" href="/content/api/cpp/alter__table__metadata_8h_source">alter\_table\_metadata.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__table__metadata_8h_source">alter\_table\_metadata.h</a></li>
    </ul>
  </div>
</div>