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

> kinetica.RestoreBackupRequest.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_1RestoreBackupRequest#aaa723aa6ec8482bafdec0c4ff9f96fee" title="Optional parameters.">RestoreBackupRequest.options</a>. <a href="#details">More...</a></p>

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

            Static Public Attributes
          </h2>
        </td>
      </tr>

      <tr className="memitem:a1f54e4f1acae1734a806d70ec7d100f4" id="r_a1f54e4f1acae1734a806d70ec7d100f4">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a1f54e4f1acae1734a806d70ec7d100f4">BACKUP\_ID</a> = "backup\_id"</td>
      </tr>

      <tr className="memdesc:a1f54e4f1acae1734a806d70ec7d100f4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">ID of the snapshot to restore. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a6d4409486478eb9d9bdcfe9dbca13ae5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Whether or not to verify checksums for backup files when restoring. <br /></td>
      </tr>

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

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

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

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

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

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

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

      <tr className="memitem:a3eadc4ec83f82842b244035d0a7e8757" id="r_a3eadc4ec83f82842b244035d0a7e8757">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a3eadc4ec83f82842b244035d0a7e8757">CASCADE\_FOREIGN\_KEYS</a> = "cascade\_foreign\_keys"</td>
      </tr>

      <tr className="memdesc:a3eadc4ec83f82842b244035d0a7e8757">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Whether to drop live foreign-key-referencing tables that are not themselves part of the backup, when the table they reference is being replaced. <br /></td>
      </tr>

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

      <tr className="memitem:a203ec21f4cc2059ed50f8de13bbd675c" id="r_a203ec21f4cc2059ed50f8de13bbd675c">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a203ec21f4cc2059ed50f8de13bbd675c">CREATE\_SCHEMA\_IF\_NOT\_EXIST</a> = "create\_schema\_if\_not\_exist"</td>
      </tr>

      <tr className="memdesc:a203ec21f4cc2059ed50f8de13bbd675c">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Behavior to apply when the schema containing any database object to restore does not already exist. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a08929da7340c4915a7d7c38ee72aecc9">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Behavior to apply when restoring tables. <br /></td>
      </tr>

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

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

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

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

      <tr className="memitem:a5f009f72d853bb4caa5a1fbe7bb9733b" id="r_a5f009f72d853bb4caa5a1fbe7bb9733b">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5f009f72d853bb4caa5a1fbe7bb9733b">RESTORE\_SUBSCRIPTIONS</a> = "restore\_subscriptions"</td>
      </tr>

      <tr className="memdesc:a5f009f72d853bb4caa5a1fbe7bb9733b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Behavior to apply when restoring datasource subscriptions on tables. <br /></td>
      </tr>

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

      <tr className="memitem:a9c0d7761c50c780a25b758a80e5b62f2" id="r_a9c0d7761c50c780a25b758a80e5b62f2">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a9c0d7761c50c780a25b758a80e5b62f2">RESUME</a> = "resume"</td>
      </tr>

      <tr className="memdesc:a9c0d7761c50c780a25b758a80e5b62f2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Resume subscriptions that were active when the backup was made. <br /></td>
      </tr>

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

      <tr className="memitem:aa0aa37a4073c0486ac0d636b0dc32df4" id="r_aa0aa37a4073c0486ac0d636b0dc32df4">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aa0aa37a4073c0486ac0d636b0dc32df4">PAUSE</a> = "pause"</td>
      </tr>

      <tr className="memdesc:aa0aa37a4073c0486ac0d636b0dc32df4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Pause subscriptions that were active when the backup was made. <br /></td>
      </tr>

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

      <tr className="memitem:acf4d577ecf28ae4f437ab7d4fc2c85bb" id="r_acf4d577ecf28ae4f437ab7d4fc2c85bb">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#acf4d577ecf28ae4f437ab7d4fc2c85bb">CANCEL</a> = "cancel"</td>
      </tr>

      <tr className="memdesc:acf4d577ecf28ae4f437ab7d4fc2c85bb">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Cancel active subscriptions. <br /></td>
      </tr>

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

      <tr className="memitem:a5abe71733cb4aa98a3e00a1788a9dd6e" id="r_a5abe71733cb4aa98a3e00a1788a9dd6e">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a5abe71733cb4aa98a3e00a1788a9dd6e">REINGEST</a> = "reingest"</td>
      </tr>

      <tr className="memdesc:a5abe71733cb4aa98a3e00a1788a9dd6e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Behavior to apply when restoring table data. <br /></td>
      </tr>

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

      <tr className="memitem:a488a4e8c2e2c9780fea210bc93e39e79" id="r_a488a4e8c2e2c9780fea210bc93e39e79">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a488a4e8c2e2c9780fea210bc93e39e79">RENAMED\_OBJECTS\_SCHEMA</a> = "renamed\_objects\_schema"</td>
      </tr>

      <tr className="memdesc:a488a4e8c2e2c9780fea210bc93e39e79">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If the <a className="el" href="#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a> is <a className="el" href="#aade58739cc2973a7ff3d35bf1219f494">RENAME</a>, use this schema for relocated existing objects instead of the default generated one. <br /></td>
      </tr>

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

      <tr className="memitem:a50d863d1068657c17b3719c119193659" id="r_a50d863d1068657c17b3719c119193659">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a50d863d1068657c17b3719c119193659">RESTORE\_ALL\_PERMISSIONS</a> = "restore\_all\_permissions"</td>
      </tr>

      <tr className="memdesc:a50d863d1068657c17b3719c119193659">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Whether or not all permissions of restored principals should be restored or scoped to the restored objects. <br /></td>
      </tr>

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

      <tr className="memitem:adf736ad7637ab58d24110df481e83711" id="r_adf736ad7637ab58d24110df481e83711">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a> = "restore\_policy"</td>
      </tr>

      <tr className="memdesc:adf736ad7637ab58d24110df481e83711">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Behavior to apply when any database object to restore already exists. <br /></td>
      </tr>

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

      <tr className="memitem:a4cd096123ab7593c9abd793b56249581" id="r_a4cd096123ab7593c9abd793b56249581">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4cd096123ab7593c9abd793b56249581">NONE</a> = "none"</td>
      </tr>

      <tr className="memdesc:a4cd096123ab7593c9abd793b56249581">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If an object to be restored already exists with the same name, abort and return error. <br /></td>
      </tr>

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

      <tr className="memitem:ac3446eb6a76aab1e875260e8be239b70" id="r_ac3446eb6a76aab1e875260e8be239b70">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ac3446eb6a76aab1e875260e8be239b70">REPLACE</a> = "replace"</td>
      </tr>

      <tr className="memdesc:ac3446eb6a76aab1e875260e8be239b70">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If an object to be restored already exists with the same name, replace it with the backup version. <br /></td>
      </tr>

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

      <tr className="memitem:aade58739cc2973a7ff3d35bf1219f494" id="r_aade58739cc2973a7ff3d35bf1219f494">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aade58739cc2973a7ff3d35bf1219f494">RENAME</a> = "rename"</td>
      </tr>

      <tr className="memdesc:aade58739cc2973a7ff3d35bf1219f494">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">If an object to be restored already exists with the same name, move that existing one to the schema specified by <a className="el" href="#a488a4e8c2e2c9780fea210bc93e39e79">RENAMED\_OBJECTS\_SCHEMA</a>. <br /></td>
      </tr>

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

      <tr className="memitem:aebbfaa89ac3befedb2f70a18c61221aa" id="r_aebbfaa89ac3befedb2f70a18c61221aa">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aebbfaa89ac3befedb2f70a18c61221aa">TARGET\_SCHEMA\_MAP</a> = "target\_schema\_map"</td>
      </tr>

      <tr className="memdesc:aebbfaa89ac3befedb2f70a18c61221aa">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Restore schema-based objects to alternate schema. <br /></td>
      </tr>

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

    <div id="details" />

    <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_1RestoreBackupRequest#aaa723aa6ec8482bafdec0c4ff9f96fee" title="Optional parameters.">RestoreBackupRequest.options</a>. </p>
      <p>Optional parameters.</p>
      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L111">111</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>

    <div id="a1f54e4f1acae1734a806d70ec7d100f4" />

    <h2 className="memtitle"><span className="permalink"><a href="#a1f54e4f1acae1734a806d70ec7d100f4">◆ </a></span>BACKUP\_ID</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.RestoreBackupRequest.Options.BACKUP\_ID = "backup\_id"</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>ID of the snapshot to restore. </p>
        <p>Leave empty to restore the most recent snapshot in the backup. The default value is ''.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L116">116</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="acf4d577ecf28ae4f437ab7d4fc2c85bb" />

    <h2 className="memtitle"><span className="permalink"><a href="#acf4d577ecf28ae4f437ab7d4fc2c85bb">◆ </a></span>CANCEL</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.RestoreBackupRequest.Options.CANCEL = "cancel"</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>Cancel active subscriptions. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L278">278</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a3eadc4ec83f82842b244035d0a7e8757" />

    <h2 className="memtitle"><span className="permalink"><a href="#a3eadc4ec83f82842b244035d0a7e8757">◆ </a></span>CASCADE\_FOREIGN\_KEYS</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.RestoreBackupRequest.Options.CASCADE\_FOREIGN\_KEYS = "cascade\_foreign\_keys"</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 to drop live foreign-key-referencing tables that are not themselves part of the backup, when the table they reference is being replaced. </p>
        <p>Only applies when <a className="el" href="#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a> is <a className="el" href="#ac3446eb6a76aab1e875260e8be239b70">REPLACE</a>. Supported values:</p>

        <ul>
          <li> <a className="el" href="#a63a1399078e94273f4840dfd3ff6be19">TRUE</a>: Drop any live table whose foreign key references a table being replaced, even when that table is not in the backup and therefore will not be restored. </li>
          <li> <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>: Fail the restore of a table that is referenced by a live foreign-key table which is not part of the backup, rather than destroying data the backup cannot restore. </li>
        </ul>

        <p>The default value is <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L174">174</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a6d4409486478eb9d9bdcfe9dbca13ae5" />

    <h2 className="memtitle"><span className="permalink"><a href="#a6d4409486478eb9d9bdcfe9dbca13ae5">◆ </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.RestoreBackupRequest.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 verify checksums for backup files when restoring. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a63a1399078e94273f4840dfd3ff6be19">TRUE</a> </li>
          <li> <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L135">135</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a203ec21f4cc2059ed50f8de13bbd675c" />

    <h2 className="memtitle"><span className="permalink"><a href="#a203ec21f4cc2059ed50f8de13bbd675c">◆ </a></span>CREATE\_SCHEMA\_IF\_NOT\_EXIST</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.RestoreBackupRequest.Options.CREATE\_SCHEMA\_IF\_NOT\_EXIST = "create\_schema\_if\_not\_exist"</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>Behavior to apply when the schema containing any database object to restore does not already exist. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a63a1399078e94273f4840dfd3ff6be19">TRUE</a>: If the schema containing any restored object does not exist, create it automatically. </li>
          <li> <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>: If the schema containing any restored object does not exist, return an error. </li>
        </ul>

        <p>The default value is <a className="el" href="#a63a1399078e94273f4840dfd3ff6be19">TRUE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L197">197</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a08929da7340c4915a7d7c38ee72aecc9" />

    <h2 className="memtitle"><span className="permalink"><a href="#a08929da7340c4915a7d7c38ee72aecc9">◆ </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.RestoreBackupRequest.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>Behavior to apply when restoring tables. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a63a1399078e94273f4840dfd3ff6be19">TRUE</a>: Restore table DDL, but do not restore data. </li>
          <li> <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>: Restore tables and their data. </li>
        </ul>

        <p>The default value is <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L218">218</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a8189815066a8d444618305d86e324889" />

    <h2 className="memtitle"><span className="permalink"><a href="#a8189815066a8d444618305d86e324889">◆ </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.RestoreBackupRequest.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 the restoration operation. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a63a1399078e94273f4840dfd3ff6be19">TRUE</a> </li>
          <li> <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L237">237</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="ae7fe7ae5c38d277162726a6d01faede4" />

    <h2 className="memtitle"><span className="permalink"><a href="#ae7fe7ae5c38d277162726a6d01faede4">◆ </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.RestoreBackupRequest.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_1RestoreBackupRequest_1_1Options" title="A set of string constants for the parameter RestoreBackupRequest.options.">RestoreBackupRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L143">143</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a4cd096123ab7593c9abd793b56249581" />

    <h2 className="memtitle"><span className="permalink"><a href="#a4cd096123ab7593c9abd793b56249581">◆ </a></span>NONE</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.RestoreBackupRequest.Options.NONE = "none"</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>If an object to be restored already exists with the same name, abort and return error. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L370">370</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="aa0aa37a4073c0486ac0d636b0dc32df4" />

    <h2 className="memtitle"><span className="permalink"><a href="#aa0aa37a4073c0486ac0d636b0dc32df4">◆ </a></span>PAUSE</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.RestoreBackupRequest.Options.PAUSE = "pause"</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>Pause subscriptions that were active when the backup was made. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L275">275</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a5abe71733cb4aa98a3e00a1788a9dd6e" />

    <h2 className="memtitle"><span className="permalink"><a href="#a5abe71733cb4aa98a3e00a1788a9dd6e">◆ </a></span>REINGEST</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.RestoreBackupRequest.Options.REINGEST = "reingest"</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>Behavior to apply when restoring table data. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a63a1399078e94273f4840dfd3ff6be19">TRUE</a>: Restore table data by re-ingesting it. This is the default behavior if the cluster topology differs from that of the contained backup. </li>
          <li> <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>: Restore the persisted data files directly. </li>
        </ul>

        <p>The default value is <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L301">301</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="aade58739cc2973a7ff3d35bf1219f494" />

    <h2 className="memtitle"><span className="permalink"><a href="#aade58739cc2973a7ff3d35bf1219f494">◆ </a></span>RENAME</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.RestoreBackupRequest.Options.RENAME = "rename"</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>If an object to be restored already exists with the same name, move that existing one to the schema specified by <a className="el" href="#a488a4e8c2e2c9780fea210bc93e39e79">RENAMED\_OBJECTS\_SCHEMA</a>. </p>
        <p>This policy does not apply to non-schema objects. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L382">382</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a488a4e8c2e2c9780fea210bc93e39e79" />

    <h2 className="memtitle"><span className="permalink"><a href="#a488a4e8c2e2c9780fea210bc93e39e79">◆ </a></span>RENAMED\_OBJECTS\_SCHEMA</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.RestoreBackupRequest.Options.RENAMED\_OBJECTS\_SCHEMA = "renamed\_objects\_schema"</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>If the <a className="el" href="#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a> is <a className="el" href="#aade58739cc2973a7ff3d35bf1219f494">RENAME</a>, use this schema for relocated existing objects instead of the default generated one. </p>
        <p>The default value is ''.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L309">309</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="ac3446eb6a76aab1e875260e8be239b70" />

    <h2 className="memtitle"><span className="permalink"><a href="#ac3446eb6a76aab1e875260e8be239b70">◆ </a></span>REPLACE</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.RestoreBackupRequest.Options.REPLACE = "replace"</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>If an object to be restored already exists with the same name, replace it with the backup version. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L374">374</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a50d863d1068657c17b3719c119193659" />

    <h2 className="memtitle"><span className="permalink"><a href="#a50d863d1068657c17b3719c119193659">◆ </a></span>RESTORE\_ALL\_PERMISSIONS</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.RestoreBackupRequest.Options.RESTORE\_ALL\_PERMISSIONS = "restore\_all\_permissions"</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 all permissions of restored principals should be restored or scoped to the restored objects. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a63a1399078e94273f4840dfd3ff6be19">TRUE</a>: Restore all permissions. </li>
          <li> <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>: Restore only permissions on restored objects. </li>
        </ul>

        <p>The default value is <a className="el" href="#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L331">331</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="adf736ad7637ab58d24110df481e83711" />

    <h2 className="memtitle"><span className="permalink"><a href="#adf736ad7637ab58d24110df481e83711">◆ </a></span>RESTORE\_POLICY</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.RestoreBackupRequest.Options.RESTORE\_POLICY = "restore\_policy"</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>Behavior to apply when any database object to restore already exists. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a4cd096123ab7593c9abd793b56249581">NONE</a>: If an object to be restored already exists with the same name, abort and return error. </li>
          <li> <a className="el" href="#ac3446eb6a76aab1e875260e8be239b70">REPLACE</a>: If an object to be restored already exists with the same name, replace it with the backup version. </li>
          <li> <a className="el" href="#aade58739cc2973a7ff3d35bf1219f494">RENAME</a>: If an object to be restored already exists with the same name, move that existing one to the schema specified by <a className="el" href="#a488a4e8c2e2c9780fea210bc93e39e79">RENAMED\_OBJECTS\_SCHEMA</a>. This policy does not apply to non-schema objects. </li>
        </ul>

        <p>The default value is <a className="el" href="#a4cd096123ab7593c9abd793b56249581">NONE</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L366">366</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a5f009f72d853bb4caa5a1fbe7bb9733b" />

    <h2 className="memtitle"><span className="permalink"><a href="#a5f009f72d853bb4caa5a1fbe7bb9733b">◆ </a></span>RESTORE\_SUBSCRIPTIONS</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.RestoreBackupRequest.Options.RESTORE\_SUBSCRIPTIONS = "restore\_subscriptions"</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>Behavior to apply when restoring datasource subscriptions on tables. </p>
        <p>Supported values:</p>

        <ul>
          <li> <a className="el" href="#a9c0d7761c50c780a25b758a80e5b62f2">RESUME</a>: Resume subscriptions that were active when the backup was made. </li>
          <li> <a className="el" href="#aa0aa37a4073c0486ac0d636b0dc32df4">PAUSE</a>: Pause subscriptions that were active when the backup was made. </li>
          <li> <a className="el" href="#acf4d577ecf28ae4f437ab7d4fc2c85bb">CANCEL</a>: Cancel active subscriptions. </li>
        </ul>

        <p>The default value is <a className="el" href="#a9c0d7761c50c780a25b758a80e5b62f2">RESUME</a>.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L267">267</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a9c0d7761c50c780a25b758a80e5b62f2" />

    <h2 className="memtitle"><span className="permalink"><a href="#a9c0d7761c50c780a25b758a80e5b62f2">◆ </a></span>RESUME</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.RestoreBackupRequest.Options.RESUME = "resume"</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>Resume subscriptions that were active when the backup was made. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L271">271</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="aebbfaa89ac3befedb2f70a18c61221aa" />

    <h2 className="memtitle"><span className="permalink"><a href="#aebbfaa89ac3befedb2f70a18c61221aa">◆ </a></span>TARGET\_SCHEMA\_MAP</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.RestoreBackupRequest.Options.TARGET\_SCHEMA\_MAP = "target\_schema\_map"</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>Restore schema-based objects to alternate schema. </p>
        <p>Value is a comma delimitted list of key:value pairs mapping the original (source) schema name as it exists in the backup to a target (destination) schema namespace: "src: dst \[, src: dst \[, ...]]". Note that schema names are case sensitive and must adhere to the database schema <a href="/content/concepts/schemas/" target="_top">naming criteria</a>. The default value is ''.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L393">393</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <div id="a63a1399078e94273f4840dfd3ff6be19" />

    <h2 className="memtitle"><span className="permalink"><a href="#a63a1399078e94273f4840dfd3ff6be19">◆ </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.RestoreBackupRequest.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_1RestoreBackupRequest_1_1Options" title="A set of string constants for the parameter RestoreBackupRequest.options.">RestoreBackupRequest.Options</a> options. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L139">139</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct 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/RestoreBackup.cs">RestoreBackup.cs</a></li>
    </ul>
  </div>
</div>


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