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

> gpudb::AlterTierRequest — 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#ae73f596fa5539fff857b7312f5627a52">GPUdb::alterTier</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/alter__tier_8h_source">gpudb/protocol/alter\_tier.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:a9dcbf34a24dade479f6a1609b737d9a9" id="r_a9dcbf34a24dade479f6a1609b737d9a9">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9dcbf34a24dade479f6a1609b737d9a9">AlterTierRequest</a> ()</td>
      </tr>

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

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

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

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

      <tr className="separator:a0120b1be0572b3cb81e990ad4d2a6ee6">
        <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:a4894487b8f50f8597f0056389108017a" id="r_a4894487b8f50f8597f0056389108017a">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4894487b8f50f8597f0056389108017a">name</a></td>
      </tr>

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

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

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

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

      <tr className="separator:ac63cb682625aa53e02de4420c742812d">
        <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#ae73f596fa5539fff857b7312f5627a52">GPUdb::alterTier</a>. </p>
      <p>Alters properties of an existing <a href="/content/rm/concepts/#storage-tiers" target="_top">tier</a> to facilitate <a href="/content/rm/concepts/" target="_top">resource management</a>.</p>
      <p>To disable <a href="/content/rm/concepts/#watermark-based-eviction" target="_top">watermark-based eviction</a>, set both <a className="el" href="/content/api/cpp/namespacegpudb#a698971465a627d3e0cc83af7f40e4b1c">high\_watermark</a> and <a className="el" href="/content/api/cpp/namespacegpudb#a7170f7b48a6c8a4f7c81262fcfed673e">low\_watermark</a> to 100. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__tier_8h_source#l00025">25</a> of file <a className="el" href="/content/api/cpp/alter__tier_8h_source">alter\_tier.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a9dcbf34a24dade479f6a1609b737d9a9">◆ </a></span>AlterTierRequest() <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::AlterTierRequest::AlterTierRequest </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_1AlterTierRequest" title="A set of parameters for GPUdb::alterTier.">AlterTierRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__tier_8h_source#l00030">30</a> of file <a className="el" href="/content/api/cpp/alter__tier_8h_source">alter\_tier.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a0120b1be0572b3cb81e990ad4d2a6ee6">◆ </a></span>AlterTierRequest() <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::AlterTierRequest::AlterTierRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">name\_</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_1AlterTierRequest" title="A set of parameters for GPUdb::alterTier.">AlterTierRequest</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">name\_</td>
                <td>Name of the tier to be altered. Must be an existing tier group name: vram, ram, disk\[n], persist, cold\[n]. </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#a84a36879b48735a4305c4b100116ec6f">alter\_tier\_capacity</a>: Maximum size in bytes this tier may hold at once, per rank. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a698971465a627d3e0cc83af7f40e4b1c">alter\_tier\_high\_watermark</a>: Threshold of usage of this tier's resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a7170f7b48a6c8a4f7c81262fcfed673e">alter\_tier\_low\_watermark</a>: Threshold of resource usage that once fallen below after crossing the <a className="el" href="/content/api/cpp/namespacegpudb#a698971465a627d3e0cc83af7f40e4b1c">high\_watermark</a>, will cease watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3823dab89a8e56d4107ef8b972f5f385">alter\_tier\_wait\_timeout</a>: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a03ee64646f0352c7ccd149aefb04a410">alter\_tier\_persist</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a6b8337e1aa0cf172804f9cea33667000">true</a> the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6b8337e1aa0cf172804f9cea33667000">alter\_tier\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#ace135c6229542d6a76a58883f4380db5">alter\_tier\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6b8337e1aa0cf172804f9cea33667000">alter\_tier\_true</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a55d8e4c06f440717ae7f42553b677a2f">alter\_tier\_rank</a>: Apply the requested change only to a specific rank. The minimum allowed value is '0'. The maximum allowed value is '10000'. </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/alter__tier_8h_source#l00095">95</a> of file <a className="el" href="/content/api/cpp/alter__tier_8h_source">alter\_tier.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the tier to be altered. </p>
        <p>Must be an existing tier group name: vram, ram, disk\[n], persist, cold\[n]. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__tier_8h_source#l00105">105</a> of file <a className="el" href="/content/api/cpp/alter__tier_8h_source">alter\_tier.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a84a36879b48735a4305c4b100116ec6f">alter\_tier\_capacity</a>: Maximum size in bytes this tier may hold at once, per rank. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a698971465a627d3e0cc83af7f40e4b1c">alter\_tier\_high\_watermark</a>: Threshold of usage of this tier's resource that once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a7170f7b48a6c8a4f7c81262fcfed673e">alter\_tier\_low\_watermark</a>: Threshold of resource usage that once fallen below after crossing the <a className="el" href="/content/api/cpp/namespacegpudb#a698971465a627d3e0cc83af7f40e4b1c">high\_watermark</a>, will cease watermark-based eviction from this tier. The minimum allowed value is '0'. The maximum allowed value is '100'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3823dab89a8e56d4107ef8b972f5f385">alter\_tier\_wait\_timeout</a>: Timeout in seconds for reading from or writing to this resource. Applies to cold storage tiers only. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a03ee64646f0352c7ccd149aefb04a410">alter\_tier\_persist</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a6b8337e1aa0cf172804f9cea33667000">true</a> the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6b8337e1aa0cf172804f9cea33667000">alter\_tier\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#ace135c6229542d6a76a58883f4380db5">alter\_tier\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6b8337e1aa0cf172804f9cea33667000">alter\_tier\_true</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a55d8e4c06f440717ae7f42553b677a2f">alter\_tier\_rank</a>: Apply the requested change only to a specific rank. The minimum allowed value is '0'. The maximum allowed value is '10000'. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__tier_8h_source#l00145">145</a> of file <a className="el" href="/content/api/cpp/alter__tier_8h_source">alter\_tier.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__tier_8h_source">alter\_tier.h</a></li>
    </ul>
  </div>
</div>