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

# createBackup

<div className="kinetica-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="createBackup(com.gpudb.protocol.CreateBackupRequest)">
        <h3>createBackup</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateBackupResponse" title="class in com.gpudb.protocol">CreateBackupResponse</a></span> <span className="element-name">createBackup</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest" title="class in com.gpudb.protocol">CreateBackupRequest</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">Creates a database <a href="/content/admin/backup_restore/#database-backup" target="_top">backup</a>, containing a snapshot of existing objects, at the remote file store accessible via the <a href="/content/concepts/data_sinks/" target="_top">data sink</a> specified by <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest#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/CreateBackupRequest" 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/CreateBackupResponse" 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="createBackup(java.lang.String,java.lang.String,java.util.Map,java.lang.String,java.util.Map)">
        <h3>createBackup</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/CreateBackupResponse" title="class in com.gpudb.protocol">CreateBackupResponse</a></span> <span className="element-name">createBackup</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> backupType, <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>> backupObjectsMap, <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">Creates a database <a href="/content/admin/backup_restore/#database-backup" target="_top">backup</a>, containing a snapshot of existing objects, at the remote file store 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 for this backup. If the backup already exists, only an incremental or differential backup can be made, unless <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#RECREATE"><code>RECREATE</code></a> is set to <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a>.</div>

          <div className="dd">
            <code>backupType</code> - Type of snapshot to create. Supported values:

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>: Snapshot of changes in the database objects and data since the last full snapshot. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#FULL"><code>FULL</code></a>: Snapshot of the given database objects and data. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#INCREMENTAL"><code>INCREMENTAL</code></a>: Snapshot of changes in the database objects and data since the last snapshot of any kind. </li>
            </ul>
          </div>

          <div className="dd">
            <code>backupObjectsMap</code> - Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#ALL"><code>ALL</code></a>: All object types and data contained in the given <a href="/content/concepts/schemas/" target="_top">schema(s)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CATALOG"><code>CATALOG</code></a>: Data Lake catalog that is external to the database. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CONTEXT"><code>CONTEXT</code></a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#CREDENTIAL"><code>CREDENTIAL</code></a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#DATASINK"><code>DATASINK</code></a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#DATASOURCE"><code>DATASOURCE</code></a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#DIRECTORY"><code>DIRECTORY</code></a>: KiFS <a href="/content/tools/kifs/" target="_top">File directory(ies)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#FUNCTION_ENVIRONMENT"><code>FUNCTION\_ENVIRONMENT</code></a>: <a href="/content/udf/python/writing/#udf-python-func-env" target="_top">Python UDF function environment(s)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#GRAPH"><code>GRAPH</code></a>: <a href="/content/graph_solver/network_graph_solver/" target="_top">Graph</a> definition(s). Source table(s), if applicable, are required in order to restore graph objects. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#MONITOR"><code>MONITOR</code></a>: <a href="/content/concepts/table_monitors/" target="_top">Table monitor(s)</a> / <a href="/content/sql/ddl/create-stream" target="_top">SQL stream(s)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#RESOURCE_GROUP"><code>RESOURCE\_GROUP</code></a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#ROLE"><code>ROLE</code></a>: <a href="/content/security/sec_concepts/#roles" target="_top">Role(s)</a>, role members (roles or users, recursively), and associated permissions. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#STORED_PROCEDURE"><code>STORED\_PROCEDURE</code></a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#TABLE"><code>TABLE</code></a>: <a href="/content/concepts/tables/" target="_top">Table(s)</a> and <a href="/content/sql/ddl/create-view" target="_top">SQL view(s)</a>. Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#USER"><code>USER</code></a>: <a href="/content/security/sec_concepts/#security-concepts-users" target="_top">User(s)</a> (internal and external) and associated permissions. </li>
              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupObjectsMap#USER_DEFINED_FUNCTION"><code>USER\_DEFINED\_FUNCTION</code></a>: <a href="/content/udf_overview" target="_top">UDF(s)</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="dd"><code>datasinkName</code> - Data sink through which the backup will be stored.</div>

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

            <ul>
              <li>
                <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#BLOCK_TABLE_MUTATIONS"><code>BLOCK\_TABLE\_MUTATIONS</code></a>: Whether or not to block all mutations on target tables while they are being backed up. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a>: Block all mutations on target tables while they are being backed up. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a>: Only block mutations on a target table at the point a disk eviction is necessary. </li>
                </ul>

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

              <li>
                <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#CHECKSUM"><code>CHECKSUM</code></a>: Whether or not to calculate checksums for backup files. Supported values:

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

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

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

              <li>
                <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DDL_ONLY"><code>DDL\_ONLY</code></a>: Whether or not, for tables, to only backup DDL and not table data. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#TRUE"><code>TRUE</code></a>: For tables, only back up DDL, not data. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#FALSE"><code>FALSE</code></a>: For tables, back up DDL and data. </li>
                </ul>

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

              <li>
                <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#DELETE_INTERMEDIATE_BACKUPS"><code>DELETE\_INTERMEDIATE\_BACKUPS</code></a>: Whether or not to delete any intermediate snapshots when the <code>backupType</code> is set to <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.BackupType#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>. Supported values:

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

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

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

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

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

              <li><a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#MAX_INCREMENTAL_BACKUPS_TO_KEEP"><code>MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</code></a>: Maximum number of incremental snapshots to keep. The default value is '-1'. </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.Options#RECREATE"><code>RECREATE</code></a>: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values:

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

                The default value is <a href="/content/api/java/com/gpudb/protocol/CreateBackupRequest.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/CreateBackupResponse" 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>