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

> gpudb::CreateBackupRequest — 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#a8b23a215e39231b2719d9eaf103e91a5">GPUdb::createBackup</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__backup_8h_source">gpudb/protocol/create\_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:a7798275e20d7ba67b3c82e2090e25102" id="r_a7798275e20d7ba67b3c82e2090e25102">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7798275e20d7ba67b3c82e2090e25102">CreateBackupRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a7798275e20d7ba67b3c82e2090e25102">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateBackupRequest" title="A set of parameters for GPUdb::createBackup.">CreateBackupRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a8a9249febac38a144cfa911876e408a5" id="r_a8a9249febac38a144cfa911876e408a5">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a8a9249febac38a144cfa911876e408a5">CreateBackupRequest</a> (const std::string \&backupName\_, const std::string \&backupType\_, const std::map\< std::string, std::string > \&backupObjectsMap\_, const std::string \&datasinkName\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a8a9249febac38a144cfa911876e408a5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateBackupRequest" title="A set of parameters for GPUdb::createBackup.">CreateBackupRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

      <tr className="memdesc:ae46524682490aec60b8ce43314a399cc">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name for this backup. <br /></td>
      </tr>

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

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

      <tr className="memdesc:ab761cb1853d3513be41357733c3fdc1f">
        <td className="mdescLeft"> </td>
        <td className="mdescRight"><a className="el" href="/content/api/cpp/classgpudb_1_1Type">Type</a> of snapshot to create. <br /></td>
      </tr>

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

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

      <tr className="memdesc:aec6348fb2df563402cd0bb4916613759">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">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. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a5e58568622ccf02370239603be22c85d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Data sink through which the backup will be stored. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a60523887afa4b5209799f3b4f53fabb2">
        <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#a8b23a215e39231b2719d9eaf103e91a5">GPUdb::createBackup</a>. </p>
      <p>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 className="el" href="#a5e58568622ccf02370239603be22c85d">datasinkName</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__backup_8h_source#l00023">23</a> of file <a className="el" href="/content/api/cpp/create__backup_8h_source">create\_backup.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a7798275e20d7ba67b3c82e2090e25102">◆ </a></span>CreateBackupRequest() <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::CreateBackupRequest::CreateBackupRequest </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 a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateBackupRequest" title="A set of parameters for GPUdb::createBackup.">CreateBackupRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__backup_8h_source#l00028">28</a> of file <a className="el" href="/content/api/cpp/create__backup_8h_source">create\_backup.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a8a9249febac38a144cfa911876e408a5">◆ </a></span>CreateBackupRequest() <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::CreateBackupRequest::CreateBackupRequest </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">backupType\_</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">backupObjectsMap\_</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 a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateBackupRequest" title="A set of parameters for GPUdb::createBackup.">CreateBackupRequest</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 for this backup. If the backup already exists, only an incremental or differential backup can be made, unless <a className="el" href="/content/api/cpp/namespacegpudb#ab9b18505d61116c56e2b1c34082e39c6">recreate</a> is set to <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">true</a>. </td>
              </tr>

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

                <td>
                  <a className="el" href="/content/api/cpp/classgpudb_1_1Type">Type</a> of snapshot to create. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2054defdcd4d203766463d1d858555d5">create\_backup\_differential</a>: Snapshot of changes in the database objects and data since the last full snapshot. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1ccf48cfebf436df551cfe63700d84e5">create\_backup\_full</a>: Snapshot of the given database objects and data. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#af763a8d93c789baa3e0822dfbdfd145f">create\_backup\_incremental</a>: Snapshot of changes in the database objects and data since the last snapshot of any kind. </li>
                  </ul>
                </td>
              </tr>

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

                <td>
                  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 className="el" href="/content/api/cpp/namespacegpudb#ae37707afbe708686542c206e58beb8f6">create\_backup\_all</a>: All object types and data contained in the given <a href="/content/concepts/schemas/" target="_top">schema(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad2250be35f3b277e4a477f9af2e2c9fa">create\_backup\_catalog</a>: Data Lake catalog that is external to the database. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a44e3a57cb038936ac1c0cba40587b3c2">create\_backup\_context</a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#afcdba3877540f96c05bf653086e923dd">create\_backup\_credential</a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2431b562b7c4f2f278c68ab2496dca45">create\_backup\_datasink</a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5973a4aaad70c65d0ae9095e25bd9f15">create\_backup\_datasource</a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a324d5ae0288c1a691b1d904dccdf67f2">create\_backup\_function\_environment</a>: <a href="/content/udf/python/writing/#udf-python-func-env" target="_top">Python UDF function environment(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a96786a12cf5613528b329e7bf0997bf6">create\_backup\_graph</a>: <a href="/content/graph_solver/network_graph_solver/" target="_top">Graph(s)</a> definition. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae9a4abecc01a8cc450c45ad6b97fae69">create\_backup\_monitor</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 className="el" href="/content/api/cpp/namespacegpudb#a720e18f531ad83c46c2fc90cb0b90a15">create\_backup\_resource\_group</a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9b67f5a0dbca7e23773060f393056665">create\_backup\_role</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 className="el" href="/content/api/cpp/namespacegpudb#a78d0a0a13be222c8d9898b6ef0d5052f">create\_backup\_stored\_procedure</a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0cb9a37268f3727b008ecf111416b969">create\_backup\_table</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 className="el" href="/content/api/cpp/namespacegpudb#aa86e001f0b5e523b1d76f71bf02a7768">create\_backup\_user</a>: <a href="/content/security/sec_concepts/#security-concepts-users" target="_top">User(s)</a> (internal and external) and associated permissions. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a55c98b5f7252ff61f01762132d74fa1b">create\_backup\_user\_defined\_function</a>: <a href="/content/udf_overview" target="_top">UDF(s)</a>. </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">datasinkName\_</td>
                <td>Data sink through which the backup will be stored. </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#aa6940a725ad0e9e33cfb7cba41d968bc">create\_backup\_checksum</a>: Whether or not to calculate checksums for backup files. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab65c3a8b5b94662e274b3ae5e7635ee5">create\_backup\_comment</a>: Comments to store with this backup. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#ab2b01d977c6b8b68c20abed16db58313">create\_backup\_ddl\_only</a>: Whether or not, for tables, to only backup DDL and not table data. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a>: For tables, only back up DDL, not data. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>: For tables, back up DDL and data. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a99c4f971adf5d65bb6968875fb6bf2f1">create\_backup\_delete\_intermediate\_backups</a>: Whether or not to delete any intermediate snapshots when the <span className="em arg">backupType\_</span> is set to <a className="el" href="/content/api/cpp/namespacegpudb#a2054defdcd4d203766463d1d858555d5">differential</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>.
                    </li>

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

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a879cb3cd79c29df04911c00087f7e8ca">create\_backup\_max\_incremental\_backups\_to\_keep</a>: Maximum number of incremental snapshots to keep. The default value is '-1'. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#ab9b18505d61116c56e2b1c34082e39c6">create\_backup\_recreate</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 className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_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/create__backup_8h_source#l00267">267</a> of file <a className="el" href="/content/api/cpp/create__backup_8h_source">create\_backup.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name for this backup. </p>
        <p>If the backup already exists, only an incremental or differential backup can be made, unless <a className="el" href="/content/api/cpp/namespacegpudb#ab9b18505d61116c56e2b1c34082e39c6">recreate</a> is set to <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">true</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__backup_8h_source#l00282">282</a> of file <a className="el" href="/content/api/cpp/create__backup_8h_source">create\_backup.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aec6348fb2df563402cd0bb4916613759">◆ </a></span>backupObjectsMap</h2>

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

      <div className="memdoc">
        <p>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. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae37707afbe708686542c206e58beb8f6">create\_backup\_all</a>: All object types and data contained in the given <a href="/content/concepts/schemas/" target="_top">schema(s)</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad2250be35f3b277e4a477f9af2e2c9fa">create\_backup\_catalog</a>: Data Lake catalog that is external to the database. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a44e3a57cb038936ac1c0cba40587b3c2">create\_backup\_context</a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#afcdba3877540f96c05bf653086e923dd">create\_backup\_credential</a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2431b562b7c4f2f278c68ab2496dca45">create\_backup\_datasink</a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a5973a4aaad70c65d0ae9095e25bd9f15">create\_backup\_datasource</a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a324d5ae0288c1a691b1d904dccdf67f2">create\_backup\_function\_environment</a>: <a href="/content/udf/python/writing/#udf-python-func-env" target="_top">Python UDF function environment(s)</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a96786a12cf5613528b329e7bf0997bf6">create\_backup\_graph</a>: <a href="/content/graph_solver/network_graph_solver/" target="_top">Graph(s)</a> definition. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae9a4abecc01a8cc450c45ad6b97fae69">create\_backup\_monitor</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 className="el" href="/content/api/cpp/namespacegpudb#a720e18f531ad83c46c2fc90cb0b90a15">create\_backup\_resource\_group</a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9b67f5a0dbca7e23773060f393056665">create\_backup\_role</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 className="el" href="/content/api/cpp/namespacegpudb#a78d0a0a13be222c8d9898b6ef0d5052f">create\_backup\_stored\_procedure</a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a0cb9a37268f3727b008ecf111416b969">create\_backup\_table</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 className="el" href="/content/api/cpp/namespacegpudb#aa86e001f0b5e523b1d76f71bf02a7768">create\_backup\_user</a>: <a href="/content/security/sec_concepts/#security-concepts-users" target="_top">User(s)</a> (internal and external) and associated permissions. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a55c98b5f7252ff61f01762132d74fa1b">create\_backup\_user\_defined\_function</a>: <a href="/content/udf_overview" target="_top">UDF(s)</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/create__backup_8h_source#l00366">366</a> of file <a className="el" href="/content/api/cpp/create__backup_8h_source">create\_backup.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ab761cb1853d3513be41357733c3fdc1f">◆ </a></span>backupType</h2>

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

      <div className="memdoc">
        <p><a className="el" href="/content/api/cpp/classgpudb_1_1Type">Type</a> of snapshot to create. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2054defdcd4d203766463d1d858555d5">create\_backup\_differential</a>: Snapshot of changes in the database objects and data since the last full snapshot. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a1ccf48cfebf436df551cfe63700d84e5">create\_backup\_full</a>: Snapshot of the given database objects and data. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#af763a8d93c789baa3e0822dfbdfd145f">create\_backup\_incremental</a>: Snapshot of changes in the database objects and data since the last snapshot of any kind. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__backup_8h_source#l00299">299</a> of file <a className="el" href="/content/api/cpp/create__backup_8h_source">create\_backup.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Data sink through which the backup will be stored. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__backup_8h_source#l00371">371</a> of file <a className="el" href="/content/api/cpp/create__backup_8h_source">create\_backup.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#aa6940a725ad0e9e33cfb7cba41d968bc">create\_backup\_checksum</a>: Whether or not to calculate checksums for backup files. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab65c3a8b5b94662e274b3ae5e7635ee5">create\_backup\_comment</a>: Comments to store with this backup. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ab2b01d977c6b8b68c20abed16db58313">create\_backup\_ddl\_only</a>: Whether or not, for tables, to only backup DDL and not table data. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a>: For tables, only back up DDL, not data. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>: For tables, back up DDL and data. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a99c4f971adf5d65bb6968875fb6bf2f1">create\_backup\_delete\_intermediate\_backups</a>: Whether or not to delete any intermediate snapshots when the <a className="el" href="#ab761cb1853d3513be41357733c3fdc1f">backupType</a> is set to <a className="el" href="/content/api/cpp/namespacegpudb#a2054defdcd4d203766463d1d858555d5">differential</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>.
          </li>

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

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a879cb3cd79c29df04911c00087f7e8ca">create\_backup\_max\_incremental\_backups\_to\_keep</a>: Maximum number of incremental snapshots to keep. The default value is '-1'. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ab9b18505d61116c56e2b1c34082e39c6">create\_backup\_recreate</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 className="el" href="/content/api/cpp/namespacegpudb#a775715678c38a5d615c4a1d1fbdd5637">create\_backup\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_backup\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a732ceaf11b185b4185a1150da98b73e1">create\_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/create__backup_8h_source#l00442">442</a> of file <a className="el" href="/content/api/cpp/create__backup_8h_source">create\_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/create__backup_8h_source">create\_backup.h</a></li>
    </ul>
  </div>
</div>