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

# kinetica.CreateBackupRequest

> kinetica.CreateBackupRequest — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica/createbackup#ab802babbeac7848fffd033a57f192612">Kinetica.createBackup</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="nested-classes" />

            Classes
          </h2>
        </td>
      </tr>

      <tr className="memitem:">
        <td className="memItemLeft" align="right" valign="top">struct  </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap">BackupObjectsMap</a></td>
      </tr>

      <tr className="memdesc:">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A set of string constants for the parameter <a className="el" href="#af7cd793a068e637c3f60690491f6b7b1" title="Map of objects to be captured in the backup; must be specified when creating a full snapshot and left...">CreateBackupRequest.backup\_objects\_map</a>. <a href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#details">More...</a><br /></td>
      </tr>

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

      <tr className="memitem:">
        <td className="memItemLeft" align="right" valign="top">struct  </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType">BackupType</a></td>
      </tr>

      <tr className="memdesc:">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A set of string constants for the parameter <a className="el" href="#a2ee25b49d7d94f1b7e4c75a8a80ee2ef" title="Type of snapshot to create.">CreateBackupRequest.backup\_type</a>. <a href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType#details">More...</a><br /></td>
      </tr>

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

      <tr className="memitem:">
        <td className="memItemLeft" align="right" valign="top">struct  </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options">Options</a></td>
      </tr>

      <tr className="memdesc:">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A set of string constants for the parameter <a className="el" href="#a821de7da618d9f8caa6f1200cfae17dc" title="Optional parameters.">CreateBackupRequest.options</a>. <a href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#details">More...</a><br /></td>
      </tr>

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

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="pub-methods" />

            Public Member Functions
          </h2>
        </td>
      </tr>

      <tr className="memitem:a265f5ab1520398a574f472a31ea4b42e" id="r_a265f5ab1520398a574f472a31ea4b42e">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a265f5ab1520398a574f472a31ea4b42e">CreateBackupRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a265f5ab1520398a574f472a31ea4b42e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cs/classkinetica_1_1CreateBackupRequest" title="A set of parameters for Kinetica.createBackup.">CreateBackupRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a53f11128c6595470e8b50392e2351177" id="r_a53f11128c6595470e8b50392e2351177">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a53f11128c6595470e8b50392e2351177">CreateBackupRequest</a> (string <a className="el" href="#aada625de783e70e18fcb584735d3f3e4">backup\_name</a>, string <a className="el" href="#a2ee25b49d7d94f1b7e4c75a8a80ee2ef">backup\_type</a>, IDictionary\< string, string > <a className="el" href="#af7cd793a068e637c3f60690491f6b7b1">backup\_objects\_map</a>, string <a className="el" href="#aa6c3e7f7106975f365824b2444388fda">datasink\_name</a>, IDictionary\< string, string > <a className="el" href="#a821de7da618d9f8caa6f1200cfae17dc">options</a>=null)</td>
      </tr>

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

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

      <tr className="inherit_header pub_methods_classkinetica_1_1KineticaData">
        <td colSpan="2"> Public Member Functions inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData" id="r_a6a494237f126f79a7f478b7614323482">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a6a494237f126f79a7f478b7614323482">KineticaData</a> (<a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a> type)</td>
      </tr>

      <tr className="memdesc:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructor from <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica" title="API to talk to Kinetica Database.">Kinetica</a> Type. <br /></td>
      </tr>

      <tr className="separator:a6a494237f126f79a7f478b7614323482 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ac8cbdce08f2dd7d0d02bf0f279d79b79">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ac8cbdce08f2dd7d0d02bf0f279d79b79">KineticaData</a> (System.Type type=null)</td>
      </tr>

      <tr className="memdesc:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Default constructor, with optional System.Type. <br /></td>
      </tr>

      <tr className="separator:ac8cbdce08f2dd7d0d02bf0f279d79b79 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData" id="r_a8fceb0fc6b641ef28b7548bc2820e48f">
        <td className="memItemLeft" align="right" valign="top">object </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a8fceb0fc6b641ef28b7548bc2820e48f">Get</a> (int fieldPos)</td>
      </tr>

      <tr className="memdesc:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Retrieve a specific property from this object. <br /></td>
      </tr>

      <tr className="separator:a8fceb0fc6b641ef28b7548bc2820e48f inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData" id="r_ad02b0bac0aa3f8a64b0ec46a94bd06f0">
        <td className="memItemLeft" align="right" valign="top">void </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ad02b0bac0aa3f8a64b0ec46a94bd06f0">Put</a> (int fieldPos, object fieldValue)</td>
      </tr>

      <tr className="memdesc:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Write a specific property to this object. <br /></td>
      </tr>

      <tr className="separator:ad02b0bac0aa3f8a64b0ec46a94bd06f0 inherit pub_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="properties" />

            Properties
          </h2>
        </td>
      </tr>

      <tr className="memitem:aada625de783e70e18fcb584735d3f3e4" id="r_aada625de783e70e18fcb584735d3f3e4">
        <td className="memItemLeft" align="right" valign="top">string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aada625de783e70e18fcb584735d3f3e4">backup\_name</a><code> \[get, set]</code></td>
      </tr>

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

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

      <tr className="memitem:a2ee25b49d7d94f1b7e4c75a8a80ee2ef" id="r_a2ee25b49d7d94f1b7e4c75a8a80ee2ef">
        <td className="memItemLeft" align="right" valign="top">string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2ee25b49d7d94f1b7e4c75a8a80ee2ef">backup\_type</a><code> \[get, set]</code></td>
      </tr>

      <tr className="memdesc:a2ee25b49d7d94f1b7e4c75a8a80ee2ef">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Type of snapshot to create. <br /></td>
      </tr>

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

      <tr className="memitem:af7cd793a068e637c3f60690491f6b7b1" id="r_af7cd793a068e637c3f60690491f6b7b1">
        <td className="memItemLeft" align="right" valign="top">IDictionary\< string, string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af7cd793a068e637c3f60690491f6b7b1">backup\_objects\_map</a> = new Dictionary\<string, string>()<code> \[get, set]</code></td>
      </tr>

      <tr className="memdesc:af7cd793a068e637c3f60690491f6b7b1">
        <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:af7cd793a068e637c3f60690491f6b7b1">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:aa6c3e7f7106975f365824b2444388fda" id="r_aa6c3e7f7106975f365824b2444388fda">
        <td className="memItemLeft" align="right" valign="top">string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa6c3e7f7106975f365824b2444388fda">datasink\_name</a><code> \[get, set]</code></td>
      </tr>

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

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

      <tr className="memitem:a821de7da618d9f8caa6f1200cfae17dc" id="r_a821de7da618d9f8caa6f1200cfae17dc">
        <td className="memItemLeft" align="right" valign="top">IDictionary\< string, string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a821de7da618d9f8caa6f1200cfae17dc">options</a> = new Dictionary\<string, string>()<code> \[get, set]</code></td>
      </tr>

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

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

      <tr className="inherit_header properties_classkinetica_1_1KineticaData">
        <td colSpan="2"> Properties inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:ae35f20177341ed020cb1c92195621499 inherit properties_classkinetica_1_1KineticaData" id="r_ae35f20177341ed020cb1c92195621499">
        <td className="memItemLeft" align="right" valign="top">Schema </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#ae35f20177341ed020cb1c92195621499">Schema</a><code> \[get]</code></td>
      </tr>

      <tr className="memdesc:ae35f20177341ed020cb1c92195621499 inherit properties_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Avro Schema for this class. <br /></td>
      </tr>

      <tr className="separator:ae35f20177341ed020cb1c92195621499 inherit properties_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader">
            <div id="inherited" />

            Additional Inherited Members
          </h2>
        </td>
      </tr>

      <tr className="inherit_header pub_static_methods_classkinetica_1_1KineticaData">
        <td colSpan="2"> Static Public Member Functions inherited from <a className="el" href="/content/api/cs/classkinetica_1_1KineticaData">kinetica.KineticaData</a></td>
      </tr>

      <tr className="memitem:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData" id="r_a9474d49c9399dbe86f31a3ba07ff4691">
        <td className="memItemLeft" align="right" valign="top">static ? RecordSchema </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="/content/api/cs/classkinetica_1_1KineticaData#a9474d49c9399dbe86f31a3ba07ff4691">SchemaFromType</a> (System.Type t, <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType">KineticaType</a>? ktype=null)</td>
      </tr>

      <tr className="memdesc:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Create an Avro Schema from a System.Type and a <a className="el" href="/content/api/cs/classkinetica_1_1KineticaType" title="Describes a Kinetica record type — its columns, properties, and Avro schema — and can create the type...">KineticaType</a>. <br /></td>
      </tr>

      <tr className="separator:a9474d49c9399dbe86f31a3ba07ff4691 inherit pub_static_methods_classkinetica_1_1KineticaData">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <div id="details" />

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica/createbackup#ab802babbeac7848fffd033a57f192612">Kinetica.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="#aa6c3e7f7106975f365824b2444388fda" title="Data sink through which the backup will be stored.">CreateBackupRequest.datasink\_name</a>.</p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs#L20">20</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs">CreateBackup.cs</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>

    <div id="a265f5ab1520398a574f472a31ea4b42e" />

    <h2 className="memtitle"><span className="permalink"><a href="#a265f5ab1520398a574f472a31ea4b42e">◆ </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">kinetica.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/cs/classkinetica_1_1CreateBackupRequest" title="A set of parameters for Kinetica.createBackup.">CreateBackupRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs#L608">608</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a53f11128c6595470e8b50392e2351177" />

    <h2 className="memtitle"><span className="permalink"><a href="#a53f11128c6595470e8b50392e2351177">◆ </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">kinetica.CreateBackupRequest.CreateBackupRequest </td>
                  <td>(</td>
                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">backup\_name</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">backup\_type</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">IDictionary\< string, string ></td>
                  <td className="paramname"><span className="paramname"><span className="em">backup\_objects\_map</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">datasink\_name</span></span>, </td>
                </tr>

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

                  <td />

                  <td className="paramtype">IDictionary\< string, string ></td>
                  <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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/cs/classkinetica_1_1CreateBackupRequest" title="A set of parameters for Kinetica.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="paramname">backup\_name</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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#adcd1e0d0b2d97178234fa0b5ada760de">RECREATE</a> is set to <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a>.</td>
              </tr>

              <tr>
                <td className="paramname">backup\_type</td>

                <td>
                  Type of snapshot to create. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType#a6a257f43c52bba6b1964702a605af43d">DIFFERENTIAL</a>: Snapshot of changes in the database objects and data since the last full snapshot. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType#af4ed323ca72fa899c2353687bc77ca7b">FULL</a>: Snapshot of the given database objects and data. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType#ad98f5868ffde7bb1fe043ca9bfe41d69">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="paramname">backup\_objects\_map</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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#ac95ce74b861714546db554d60d1cac38">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a65366a80770d0bdadfbdeb99f630cad0">CATALOG</a>: Data Lake catalog that is external to the database. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aaae4a4d193ae0ba4131d0fab1348e10e">CONTEXT</a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a801479e558717ced5a248abb2192aa04">CREDENTIAL</a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a75a53e4703210983fd3ccc4ce4c709a9">DATASINK</a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aed2395508eaa53379020abec6fdf1157">DATASOURCE</a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aa3421aa1d1f6a47407e42030200f3819">DIRECTORY</a>: KiFS <a href="/content/tools/kifs/" target="_top">File directory(ies)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a9b65e4235d1a26d54df9d40377d8b07d">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a8807936ce229486cd3c517ec91d232ac">GRAPH</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 className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a756fb3d8204f32d9eb1d7e5326847aa2">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#abfcd3f36ea5b1f04b7a42569c273b5fb">RESOURCE\_GROUP</a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#adb7558b061bbf9efcc9fa2dbe11d98d0">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aed54cbd943a5bc7353191eabf00275d9">STORED\_PROCEDURE</a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aa6c28b5e22356b712f85be5141d49415">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a71462b14e46a77186c99fae88e668a7b">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#ab96e48c4fafe1ef65872217f79d0a6f4">USER\_DEFINED\_FUNCTION</a>: <a href="/content/udf_overview" target="_top">UDF(s)</a>. </li>
                  </ul>

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

              <tr>
                <td className="paramname">datasink\_name</td>
                <td>Data sink through which the backup will be stored.</td>
              </tr>

              <tr>
                <td className="paramname">options</td>

                <td>
                  Optional parameters.

                  <ul>
                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a9fce05b5f394dcb6c34dca91e2753daf">BLOCK\_TABLE\_MUTATIONS</a>: Whether or not to block all mutations on target tables while they are being backed up. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a>: Block all mutations on target tables while they are being backed up. </li>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>: Only block mutations on a target table at the point a disk eviction is necessary. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#afeacc7d5fe68974f91a837ba217af171">CHECKSUM</a>: Whether or not to calculate checksums for backup files. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a> </li>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a2036da2fb9ee830c0c9b542a145b99fe">COMMENT</a>: Comments to store with this backup. </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a743f1b391739e0209cba7c5eff3d25e4">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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a>: For tables, only back up DDL, not data. </li>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>: For tables, back up DDL and data. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a28d2d52d90444f87c025e2ff7431da29">DELETE\_INTERMEDIATE\_BACKUPS</a>: Whether or not to delete any intermediate snapshots when the <span className="em">backup\_type</span> is set to <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType#a6a257f43c52bba6b1964702a605af43d">DIFFERENTIAL</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a> </li>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#aaa5ee74a65f48d875028ee86ff675869">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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a> </li>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a566390d9e2bb930447e77c618f3a0e42">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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#adcd1e0d0b2d97178234fa0b5ada760de">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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a> </li>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
                    </li>
                  </ul>

                  The default value is an empty Dictionary.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs#L943">943</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Property Documentation</h2>

    <div id="aada625de783e70e18fcb584735d3f3e4" />

    <h2 className="memtitle"><span className="permalink"><a href="#aada625de783e70e18fcb584735d3f3e4">◆ </a></span>backup\_name</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">string kinetica.CreateBackupRequest.backup\_name</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel get">get</span><span className="mlabel set">set</span></span> </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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#adcd1e0d0b2d97178234fa0b5ada760de">RECREATE</a> is set to <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs#L271">271</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <div id="af7cd793a068e637c3f60690491f6b7b1" />

    <h2 className="memtitle"><span className="permalink"><a href="#af7cd793a068e637c3f60690491f6b7b1">◆ </a></span>backup\_objects\_map</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">IDictionary\<string, string> kinetica.CreateBackupRequest.backup\_objects\_map = new Dictionary\<string, string>()</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel get">get</span><span className="mlabel set">set</span></span> </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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#ac95ce74b861714546db554d60d1cac38">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a65366a80770d0bdadfbdeb99f630cad0">CATALOG</a>: Data Lake catalog that is external to the database. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aaae4a4d193ae0ba4131d0fab1348e10e">CONTEXT</a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a801479e558717ced5a248abb2192aa04">CREDENTIAL</a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a75a53e4703210983fd3ccc4ce4c709a9">DATASINK</a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aed2395508eaa53379020abec6fdf1157">DATASOURCE</a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aa3421aa1d1f6a47407e42030200f3819">DIRECTORY</a>: KiFS <a href="/content/tools/kifs/" target="_top">File directory(ies)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a9b65e4235d1a26d54df9d40377d8b07d">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a8807936ce229486cd3c517ec91d232ac">GRAPH</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 className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a756fb3d8204f32d9eb1d7e5326847aa2">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#abfcd3f36ea5b1f04b7a42569c273b5fb">RESOURCE\_GROUP</a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#adb7558b061bbf9efcc9fa2dbe11d98d0">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aed54cbd943a5bc7353191eabf00275d9">STORED\_PROCEDURE</a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#aa6c28b5e22356b712f85be5141d49415">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#a71462b14e46a77186c99fae88e668a7b">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/cs/structkinetica_1_1CreateBackupRequest_1_1BackupObjectsMap#ab96e48c4fafe1ef65872217f79d0a6f4">USER\_DEFINED\_FUNCTION</a>: <a href="/content/udf_overview" target="_top">UDF(s)</a>. </li>
        </ul>

        <p>The default value is an empty Dictionary.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs#L433">433</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a2ee25b49d7d94f1b7e4c75a8a80ee2ef" />

    <h2 className="memtitle"><span className="permalink"><a href="#a2ee25b49d7d94f1b7e4c75a8a80ee2ef">◆ </a></span>backup\_type</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">string kinetica.CreateBackupRequest.backup\_type</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel get">get</span><span className="mlabel set">set</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Type of snapshot to create. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType#a6a257f43c52bba6b1964702a605af43d">DIFFERENTIAL</a>: Snapshot of changes in the database objects and data since the last full snapshot. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType#af4ed323ca72fa899c2353687bc77ca7b">FULL</a>: Snapshot of the given database objects and data. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType#ad98f5868ffde7bb1fe043ca9bfe41d69">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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs#L297">297</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <div id="aa6c3e7f7106975f365824b2444388fda" />

    <h2 className="memtitle"><span className="permalink"><a href="#aa6c3e7f7106975f365824b2444388fda">◆ </a></span>datasink\_name</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">string kinetica.CreateBackupRequest.datasink\_name</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel get">get</span><span className="mlabel set">set</span></span> </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="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs#L436">436</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a821de7da618d9f8caa6f1200cfae17dc" />

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">IDictionary\<string, string> kinetica.CreateBackupRequest.options = new Dictionary\<string, string>()</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel get">get</span><span className="mlabel set">set</span></span> </td>
          </tr>
        </table>
      </div>

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

        <ul>
          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a9fce05b5f394dcb6c34dca91e2753daf">BLOCK\_TABLE\_MUTATIONS</a>: Whether or not to block all mutations on target tables while they are being backed up. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a>: Block all mutations on target tables while they are being backed up. </li>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>: Only block mutations on a target table at the point a disk eviction is necessary. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#afeacc7d5fe68974f91a837ba217af171">CHECKSUM</a>: Whether or not to calculate checksums for backup files. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a> </li>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
          </li>

          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a2036da2fb9ee830c0c9b542a145b99fe">COMMENT</a>: Comments to store with this backup. </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a743f1b391739e0209cba7c5eff3d25e4">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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a>: For tables, only back up DDL, not data. </li>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>: For tables, back up DDL and data. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a28d2d52d90444f87c025e2ff7431da29">DELETE\_INTERMEDIATE\_BACKUPS</a>: Whether or not to delete any intermediate snapshots when the <a className="el" href="#a2ee25b49d7d94f1b7e4c75a8a80ee2ef" title="Type of snapshot to create.">CreateBackupRequest.backup\_type</a> is set to <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1BackupType#a6a257f43c52bba6b1964702a605af43d">DIFFERENTIAL</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a> </li>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#aaa5ee74a65f48d875028ee86ff675869">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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a> </li>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
          </li>

          <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a566390d9e2bb930447e77c618f3a0e42">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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#adcd1e0d0b2d97178234fa0b5ada760de">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/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a1f26993f6748e67ed8bd7b5ec87466a4">TRUE</a> </li>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options#a557d201007642c254de93261df29306c">FALSE</a>.
          </li>
        </ul>

        <p>The default value is an empty Dictionary.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs#L604">604</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this class was generated from the following file:

    <ul>
      <li>Kinetica/Protocol/<a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/CreateBackup.cs">CreateBackup.cs</a></li>
    </ul>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.