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

> kinetica.CreateBackupRequest.Options — Kinetica C# API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1CreateBackupRequest#a20353db561d5bcf76bcb50a1eb44c450" title="Optional parameters.">CreateBackupRequest.options</a>. <a href="#details">More...</a></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Static Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:af6b191ab4d064b038f97f1f59d20f9a1" id="r_af6b191ab4d064b038f97f1f59d20f9a1">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af6b191ab4d064b038f97f1f59d20f9a1">CHECKSUM</a> = "checksum"</td>
      </tr>

      <tr className="memdesc:af6b191ab4d064b038f97f1f59d20f9a1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Whether or not to calculate checksums for backup files. <br /></td>
      </tr>

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

      <tr className="memitem:a382944fc4d58e3cd57c2254fc759ff7c" id="r_a382944fc4d58e3cd57c2254fc759ff7c">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a382944fc4d58e3cd57c2254fc759ff7c">TRUE</a> = "true"</td>
      </tr>

      <tr className="memdesc:a382944fc4d58e3cd57c2254fc759ff7c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options" title="A set of string constants for the parameter CreateBackupRequest.options.">CreateBackupRequest.Options</a> options. <br /></td>
      </tr>

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

      <tr className="memitem:a5b078ff3d7b1dd5d1fe8e4947e0d86a0" id="r_a5b078ff3d7b1dd5d1fe8e4947e0d86a0">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a> = "false"</td>
      </tr>

      <tr className="memdesc:a5b078ff3d7b1dd5d1fe8e4947e0d86a0">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options" title="A set of string constants for the parameter CreateBackupRequest.options.">CreateBackupRequest.Options</a> options. <br /></td>
      </tr>

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

      <tr className="memitem:a4b544f7be07422ff76cc0afafd426ec2" id="r_a4b544f7be07422ff76cc0afafd426ec2">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4b544f7be07422ff76cc0afafd426ec2">COMMENT</a> = "comment"</td>
      </tr>

      <tr className="memdesc:a4b544f7be07422ff76cc0afafd426ec2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Comments to store with this backup. <br /></td>
      </tr>

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

      <tr className="memitem:a2cb678502bfdffe0b8f6fb29a1856962" id="r_a2cb678502bfdffe0b8f6fb29a1856962">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a2cb678502bfdffe0b8f6fb29a1856962">DDL\_ONLY</a> = "ddl\_only"</td>
      </tr>

      <tr className="memdesc:a2cb678502bfdffe0b8f6fb29a1856962">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Whether or not, for tables, to only backup DDL and not table data. <br /></td>
      </tr>

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

      <tr className="memitem:a46eb513345c67dce3fea49210746ffdb" id="r_a46eb513345c67dce3fea49210746ffdb">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a46eb513345c67dce3fea49210746ffdb">DELETE\_INTERMEDIATE\_BACKUPS</a> = "delete\_intermediate\_backups"</td>
      </tr>

      <tr className="memdesc:a46eb513345c67dce3fea49210746ffdb">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Whether or not to delete any intermediate snapshots when the <a className="el" href="/content/api/cs/classkinetica_1_1CreateBackupRequest#a8038184590892eab09365b3ef49a5972" 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#a8ec93f9956d21c854ce4713f00918e23">DIFFERENTIAL</a>. <br /></td>
      </tr>

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

      <tr className="memitem:ad9463f1e564674a6f1a5fcb866b7c660" id="r_ad9463f1e564674a6f1a5fcb866b7c660">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ad9463f1e564674a6f1a5fcb866b7c660">DRY\_RUN</a> = "dry\_run"</td>
      </tr>

      <tr className="memdesc:ad9463f1e564674a6f1a5fcb866b7c660">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Whether or not to perform a dry run of a backup operation. <br /></td>
      </tr>

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

      <tr className="memitem:a9943c474f1c21de222accd01bc2e799d" id="r_a9943c474f1c21de222accd01bc2e799d">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9943c474f1c21de222accd01bc2e799d">MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</a> = "max\_incremental\_backups\_to\_keep"</td>
      </tr>

      <tr className="memdesc:a9943c474f1c21de222accd01bc2e799d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Maximum number of incremental snapshots to keep. <br /></td>
      </tr>

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

      <tr className="memitem:adaa3a089f2ede6d2a4e7a2d082abbb6b" id="r_adaa3a089f2ede6d2a4e7a2d082abbb6b">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#adaa3a089f2ede6d2a4e7a2d082abbb6b">RECREATE</a> = "recreate"</td>
      </tr>

      <tr className="memdesc:adaa3a089f2ede6d2a4e7a2d082abbb6b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. <br /></td>
      </tr>

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

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

    <div className="textblock">
      <p>A set of string constants for the parameter <a className="el" href="/content/api/cs/classkinetica_1_1CreateBackupRequest#a20353db561d5bcf76bcb50a1eb44c450" title="Optional parameters.">CreateBackupRequest.options</a>. </p>
      <p>Optional parameters.</p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00121">121</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateBackupRequest.Options.CHECKSUM = "checksum"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Whether or not to calculate checksums for backup files. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a382944fc4d58e3cd57c2254fc759ff7c">TRUE</a> </li>
          <li> <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00139">139</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4b544f7be07422ff76cc0afafd426ec2">◆ </a></span>COMMENT</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateBackupRequest.Options.COMMENT = "comment"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Comments to store with this backup. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00150">150</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a2cb678502bfdffe0b8f6fb29a1856962">◆ </a></span>DDL\_ONLY</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateBackupRequest.Options.DDL\_ONLY = "ddl\_only"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Whether or not, for tables, to only backup DDL and not table data. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a382944fc4d58e3cd57c2254fc759ff7c">TRUE</a>: For tables, only back up DDL, not data. </li>
          <li> <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a>: For tables, back up DDL and data. </li>
        </ul>

        <p>The default value is <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00173">173</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a46eb513345c67dce3fea49210746ffdb">◆ </a></span>DELETE\_INTERMEDIATE\_BACKUPS</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateBackupRequest.Options.DELETE\_INTERMEDIATE\_BACKUPS = "delete\_intermediate\_backups"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Whether or not to delete any intermediate snapshots when the <a className="el" href="/content/api/cs/classkinetica_1_1CreateBackupRequest#a8038184590892eab09365b3ef49a5972" 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#a8ec93f9956d21c854ce4713f00918e23">DIFFERENTIAL</a>. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a382944fc4d58e3cd57c2254fc759ff7c">TRUE</a> </li>
          <li> <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00193">193</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ad9463f1e564674a6f1a5fcb866b7c660">◆ </a></span>DRY\_RUN</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateBackupRequest.Options.DRY\_RUN = "dry\_run"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Whether or not to perform a dry run of a backup operation. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a382944fc4d58e3cd57c2254fc759ff7c">TRUE</a> </li>
          <li> <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00211">211</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">◆ </a></span>FALSE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateBackupRequest.Options.FALSE = "false"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options" title="A set of string constants for the parameter CreateBackupRequest.options.">CreateBackupRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00147">147</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a9943c474f1c21de222accd01bc2e799d">◆ </a></span>MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateBackupRequest.Options.MAX\_INCREMENTAL\_BACKUPS\_TO\_KEEP = "max\_incremental\_backups\_to\_keep"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Maximum number of incremental snapshots to keep. </p>
        <p>The default value is '-1'.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00215">215</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#adaa3a089f2ede6d2a4e7a2d082abbb6b">◆ </a></span>RECREATE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateBackupRequest.Options.RECREATE = "recreate"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a382944fc4d58e3cd57c2254fc759ff7c">TRUE</a> </li>
          <li> <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#a5b078ff3d7b1dd5d1fe8e4947e0d86a0">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00233">233</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a382944fc4d58e3cd57c2254fc759ff7c">◆ </a></span>TRUE</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">const string kinetica.CreateBackupRequest.Options.TRUE = "true"</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>A boolean constant for the <a className="el" href="/content/api/cs/structkinetica_1_1CreateBackupRequest_1_1Options" title="A set of string constants for the parameter CreateBackupRequest.options.">CreateBackupRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source#l00143">143</a> of file <a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following files:

    <ul>
      <li>\_build/public-os\_ubuntu24.04-arch\_amd64-cc\_gcc\_13.3.0/install/Kinetica/Protocol/<a className="el" href="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a></li>
      <li>Kinetica/Protocol/<a className="el" href="/content/api/cs/Kinetica_2Protocol_2CreateBackup_8cs_source">CreateBackup.cs</a></li>
    </ul>
  </div>
</div>