> ## 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-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="alterBackup(com.gpudb.protocol.AlterBackupRequest)">
        <h3>alterBackup</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AlterBackupResponse" title="class in com.gpudb.protocol">AlterBackupResponse</a></span> <span className="element-name">alterBackup</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest" title="class in com.gpudb.protocol">AlterBackupRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">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 href="/content/api/java/com/gpudb/protocol/AlterBackupRequest#getDatasinkName()"><code>datasinkName</code></a>.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/AlterBackupResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="alterBackup(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.util.Map)">
        <h3>alterBackup</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/AlterBackupResponse" title="class in com.gpudb.protocol">AlterBackupResponse</a></span> <span className="element-name">alterBackup</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> backupName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> action, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> value, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> datasinkName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">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 <code>datasinkName</code>.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>backupName</code> - Name of the backup to be altered.</div>

          <div className="dd">
            <code>action</code> - Operation to be applied. Supported values:

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Action#CHECKSUM"><code>CHECKSUM</code></a>: Calculate checksum for backed-up files. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Action#DDL_ONLY"><code>DDL\_ONLY</code></a>: Whether or not to only save DDL and not back up table data, when taking future snapshots; set <code>value</code> to 'true' or 'false' for DDL only or DDL and table data, respectively. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Action#MAX_INCREMENTAL_BACKUPS_TO_KEEP"><code>MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</code></a>: Maximum number of incremental snapshots to keep, when taking future snapshots; set <code>value</code> to the number of snapshots to keep. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Action#MERGE"><code>MERGE</code></a>: Merges all snapshots within a backup and creates a single full snapshot. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Action#PURGE"><code>PURGE</code></a>: Deletes a snapshot from a backup; set <code>value</code> to the snapshot ID to purge. </li>
            </ul>
          </div>

          <div className="dd"><code>value</code> - Value of the modification, depending on <code>action</code>.</div>
          <div className="dd"><code>datasinkName</code> - Data sink through which the backup is accessible.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Options#COMMENT"><code>COMMENT</code></a>: Comments to store with the backup. </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Options#DRY_RUN"><code>DRY\_RUN</code></a>: Whether or not to perform a dry run of a backup alteration. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/AlterBackupRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>
            </ul>

            The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/AlterBackupResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>