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

> gpudb::AlterBackupRequest — 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#a0d261d4f3dab25f405d4c23d98957d50">GPUdb::alterBackup</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/alter__backup_8h_source">gpudb/protocol/alter\_backup.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:a8f1c2e7ef902c003350e4be5f69a2858" id="r_a8f1c2e7ef902c003350e4be5f69a2858">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8f1c2e7ef902c003350e4be5f69a2858">AlterBackupRequest</a> ()</td>
      </tr>

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

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

      <tr className="memitem:acc7e31f38d9d009e67652925b8e71c84" id="r_acc7e31f38d9d009e67652925b8e71c84">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#acc7e31f38d9d009e67652925b8e71c84">AlterBackupRequest</a> (const std::string \&backupName\_, const std::string \&action\_, const std::string \&value\_, const std::string \&datasinkName\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:acc7e31f38d9d009e67652925b8e71c84">
        <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:aa01d9497cf621fcbc6f5e023afcd9754" id="r_aa01d9497cf621fcbc6f5e023afcd9754">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa01d9497cf621fcbc6f5e023afcd9754">backupName</a></td>
      </tr>

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

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

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

      <tr className="memdesc:a0f323b97f2ad656a6d1f9357f40dfe8f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Operation to be applied. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a90a640e9f213d4e8dc593829d7ada961">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Value of the modification, depending on <a className="el" href="#a0f323b97f2ad656a6d1f9357f40dfe8f">action</a>. <br /></td>
      </tr>

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

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

      <tr className="memdesc:afb40c34397bdfd1b9fd1cbba27a85ef0">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Data sink through which the backup is accessible. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a19f6d73f5833a5c8162d70205e30308f">
        <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#a0d261d4f3dab25f405d4c23d98957d50">GPUdb::alterBackup</a>. </p>
      <p>Alters an existing database <a href="/content/admin/backup_restore/#database-backup" target="_top">backup</a>, accessible via the <a href="/content/concepts/data_sinks/" target="_top">data sink</a> specified by <a className="el" href="#afb40c34397bdfd1b9fd1cbba27a85ef0">datasinkName</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__backup_8h_source#l00022">22</a> of file <a className="el" href="/content/api/cpp/alter__backup_8h_source">alter\_backup.h</a>.</p>
    </div>

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

    <h2 className="memtitle"><span className="permalink"><a href="#acc7e31f38d9d009e67652925b8e71c84">◆ </a></span>AlterBackupRequest() <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::AlterBackupRequest::AlterBackupRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">backupName\_</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::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">datasinkName\_</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_1AlterBackupRequest" title="A set of parameters for GPUdb::alterBackup.">AlterBackupRequest</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">backupName\_</td>
                <td>Name of the backup to be altered. </td>
              </tr>

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

                <td>
                  Operation to be applied. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0603d48ca575ca53ce3195abe3de6228">alter\_backup\_checksum</a>: Calculate checksum for backed-up files. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae63a14fc4ac33f9599d4a73f1985a42c">alter\_backup\_ddl\_only</a>: Whether or not to only save DDL and not back up table data, when taking future snapshots; set <span className="em arg">value\_</span> to 'true' or 'false' for DDL only or DDL and table data, respectively. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63fbf7a1a9547096545c61f48f905e2c">alter\_backup\_max\_incremental\_backups\_to\_keep</a>: Maximum number of incremental snapshots to keep, when taking future snapshots; set <span className="em arg">value\_</span> to the number of snapshots to keep. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae7a5dac180ab97cdc5f9906eb607bd68">alter\_backup\_merge</a>: Merges all snapshots within a backup and creates a single full snapshot. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a36d42509e69f99d17e52c76fa2cb9e17">alter\_backup\_purge</a>: Deletes a snapshot from a backup; set <span className="em arg">value\_</span> to the snapshot ID to purge. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">value\_</td>
                <td>Value of the modification, depending on <span className="em arg">action\_</span>. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">datasinkName\_</td>
                <td>Data sink through which the backup is accessible. </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#a05ceddc176637e5a40f2da39892827ed">alter\_backup\_comment</a>: Comments to store with the backup. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a662eb7205d50dc6af0c9485ae24421be">alter\_backup\_dry\_run</a>: Whether or not to perform a dry run of a backup alteration. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aadac6be158dcb8ba69a9743892b1d1ba">alter\_backup\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aab7544d67c85c8c4dfaf0aaf202856b1">alter\_backup\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aab7544d67c85c8c4dfaf0aaf202856b1">alter\_backup\_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/alter__backup_8h_source#l00096">96</a> of file <a className="el" href="/content/api/cpp/alter__backup_8h_source">alter\_backup.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0603d48ca575ca53ce3195abe3de6228">alter\_backup\_checksum</a>: Calculate checksum for backed-up files. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae63a14fc4ac33f9599d4a73f1985a42c">alter\_backup\_ddl\_only</a>: Whether or not to only save DDL and not back up table data, when taking future snapshots; set <a className="el" href="#a90a640e9f213d4e8dc593829d7ada961">value</a> to 'true' or 'false' for DDL only or DDL and table data, respectively. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a63fbf7a1a9547096545c61f48f905e2c">alter\_backup\_max\_incremental\_backups\_to\_keep</a>: Maximum number of incremental snapshots to keep, when taking future snapshots; set <a className="el" href="#a90a640e9f213d4e8dc593829d7ada961">value</a> to the number of snapshots to keep. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae7a5dac180ab97cdc5f9906eb607bd68">alter\_backup\_merge</a>: Merges all snapshots within a backup and creates a single full snapshot. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a36d42509e69f99d17e52c76fa2cb9e17">alter\_backup\_purge</a>: Deletes a snapshot from a backup; set <a className="el" href="#a90a640e9f213d4e8dc593829d7ada961">value</a> to the snapshot ID to purge. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__backup_8h_source#l00133">133</a> of file <a className="el" href="/content/api/cpp/alter__backup_8h_source">alter\_backup.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aa01d9497cf621fcbc6f5e023afcd9754">◆ </a></span>backupName</h2>

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

      <div className="memdoc">
        <p>Name of the backup to be altered. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__backup_8h_source#l00108">108</a> of file <a className="el" href="/content/api/cpp/alter__backup_8h_source">alter\_backup.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#afb40c34397bdfd1b9fd1cbba27a85ef0">◆ </a></span>datasinkName</h2>

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

      <div className="memdoc">
        <p>Data sink through which the backup is accessible. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__backup_8h_source#l00143">143</a> of file <a className="el" href="/content/api/cpp/alter__backup_8h_source">alter\_backup.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a05ceddc176637e5a40f2da39892827ed">alter\_backup\_comment</a>: Comments to store with the backup. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a662eb7205d50dc6af0c9485ae24421be">alter\_backup\_dry\_run</a>: Whether or not to perform a dry run of a backup alteration. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aadac6be158dcb8ba69a9743892b1d1ba">alter\_backup\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aab7544d67c85c8c4dfaf0aaf202856b1">alter\_backup\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aab7544d67c85c8c4dfaf0aaf202856b1">alter\_backup\_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/alter__backup_8h_source#l00162">162</a> of file <a className="el" href="/content/api/cpp/alter__backup_8h_source">alter\_backup.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Value of the modification, depending on <a className="el" href="#a0f323b97f2ad656a6d1f9357f40dfe8f">action</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__backup_8h_source#l00138">138</a> of file <a className="el" href="/content/api/cpp/alter__backup_8h_source">alter\_backup.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__backup_8h_source">alter\_backup.h</a></li>
    </ul>
  </div>
</div>