> ## 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.

# alterBackup

<div className="kinetica-doxygen">
  <div id="a0d261d4f3dab25f405d4c23d98957d50" />

  <h2 className="memtitle"><span className="permalink"><a href="#a0d261d4f3dab25f405d4c23d98957d50">◆ </a></span>alterBackup() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">AlterBackupResponse</a> gpudb::GPUdb::alterBackup </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupRequest">AlterBackupRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <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="/content/api/cpp/structgpudb_1_1AlterBackupRequest#afb40c34397bdfd1b9fd1cbba27a85ef0">datasinkName</a>. </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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupRequest">Request</a> object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a1f41e6f7246ec165a78018ebc4e14bb1" />

  <h2 className="memtitle"><span className="permalink"><a href="#a1f41e6f7246ec165a78018ebc4e14bb1">◆ </a></span>alterBackup() <span className="overload">\[2/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">AlterBackupResponse</a> & gpudb::GPUdb::alterBackup </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupRequest">AlterBackupRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
        </tr>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">AlterBackupResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <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="/content/api/cpp/structgpudb_1_1AlterBackupRequest#afb40c34397bdfd1b9fd1cbba27a85ef0">datasinkName</a>. </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">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="a8d54f289d7c4c7630c3bf7d582a3473c" />

  <h2 className="memtitle"><span className="permalink"><a href="#a8d54f289d7c4c7630c3bf7d582a3473c">◆ </a></span>alterBackup() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">AlterBackupResponse</a> gpudb::GPUdb::alterBackup </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> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <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 <span className="em arg">datasinkName</span>. </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>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="aac2057974412bc4ecd18b7d997dfddec" />

  <h2 className="memtitle"><span className="permalink"><a href="#aac2057974412bc4ecd18b7d997dfddec">◆ </a></span>alterBackup() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">AlterBackupResponse</a> & gpudb::GPUdb::alterBackup </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>

        <tr>
          <td className="paramkey" />

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">AlterBackupResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <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 <span className="em arg">datasinkName</span>. </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>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1AlterBackupResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>