> ## 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#a4691044ea2a5d1fb07e9d16346f9cec3" title="Optional parameters.">RestoreBackupRequest.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:a42fa3674cbca1d563d9bd163a8c55c56" id="r_a42fa3674cbca1d563d9bd163a8c55c56">
        <td className="memItemLeft" align="right" valign="top">const string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a42fa3674cbca1d563d9bd163a8c55c56">BACKUP\_ID</a> = "backup\_id"</td>
      </tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      <tr className="memdesc:a64ca561f6423601fdd263bcc6905b9e2">
        <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="#a65fa3753d7b907c93af5d99744f26c8e">RENAMED\_OBJECTS\_SCHEMA</a>. <br /></td>
      </tr>

      <tr className="separator:a64ca561f6423601fdd263bcc6905b9e2">
        <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_1RestoreBackupRequest#a4691044ea2a5d1fb07e9d16346f9cec3" title="Optional parameters.">RestoreBackupRequest.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_2RestoreBackup_8cs_source#l00101">101</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a42fa3674cbca1d563d9bd163a8c55c56">◆ </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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00106">106</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#abed0e21b45f5eeaa20901ef24e2f727c">◆ </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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00237">237</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a789139dd9c208bbf382e35e618ee0ed0">◆ </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="#ae26cb865c5e2dc9dfd818f290a129adc">TRUE</a> </li>
          <li> <a className="el" href="#ac81adb1a8288dd08a70007bc4e3ced59">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#ac81adb1a8288dd08a70007bc4e3ced59">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_2RestoreBackup_8cs_source#l00125">125</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a24b3f8819d5cb982218b78f586282a50">◆ </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="#ae26cb865c5e2dc9dfd818f290a129adc">TRUE</a>: If the schema containing any restored object does not exist, create it automatically. </li>
          <li> <a className="el" href="#ac81adb1a8288dd08a70007bc4e3ced59">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="#ae26cb865c5e2dc9dfd818f290a129adc">TRUE</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_2RestoreBackup_8cs_source#l00156">156</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a8d1bb3aca6e9dd5fb3811677d104b8b9">◆ </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="#ae26cb865c5e2dc9dfd818f290a129adc">TRUE</a>: Restore table DDL, but do not restore data. </li>
          <li> <a className="el" href="#ac81adb1a8288dd08a70007bc4e3ced59">FALSE</a>: Restore tables and their data. </li>
        </ul>

        <p>The default value is <a className="el" href="#ac81adb1a8288dd08a70007bc4e3ced59">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_2RestoreBackup_8cs_source#l00177">177</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a2c235e75cb353b52148087b276de9b95">◆ </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="#ae26cb865c5e2dc9dfd818f290a129adc">TRUE</a> </li>
          <li> <a className="el" href="#ac81adb1a8288dd08a70007bc4e3ced59">FALSE</a> </li>
        </ul>

        <p>The default value is <a className="el" href="#ac81adb1a8288dd08a70007bc4e3ced59">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_2RestoreBackup_8cs_source#l00196">196</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ac81adb1a8288dd08a70007bc4e3ced59">◆ </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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00133">133</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a3c8e587c6763781bf0a469705ef3d208">◆ </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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00307">307</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ac725a9069edfe834573d1b63591a717a">◆ </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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00234">234</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a04e953f280ff05e88530365d686ce48a">◆ </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="#ae26cb865c5e2dc9dfd818f290a129adc">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="#ac81adb1a8288dd08a70007bc4e3ced59">FALSE</a>: Restore the persisted data files directly. </li>
        </ul>

        <p>The default value is <a className="el" href="#ac81adb1a8288dd08a70007bc4e3ced59">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_2RestoreBackup_8cs_source#l00260">260</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a64ca561f6423601fdd263bcc6905b9e2">◆ </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="#a65fa3753d7b907c93af5d99744f26c8e">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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00319">319</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a65fa3753d7b907c93af5d99744f26c8e">◆ </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="#a42af2a55f2ded38fe6de4e455b598322">RESTORE\_POLICY</a> is <a className="el" href="#a64ca561f6423601fdd263bcc6905b9e2">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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00268">268</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a17407dbbffd9c442cb4255b7bfe0a1a1">◆ </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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00311">311</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a42af2a55f2ded38fe6de4e455b598322">◆ </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="#a3c8e587c6763781bf0a469705ef3d208">NONE</a>: If an object to be restored already exists with the same name, abort and return error. </li>
          <li> <a className="el" href="#a17407dbbffd9c442cb4255b7bfe0a1a1">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="#a64ca561f6423601fdd263bcc6905b9e2">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="#a65fa3753d7b907c93af5d99744f26c8e">RENAMED\_OBJECTS\_SCHEMA</a>. This policy does not apply to non-schema objects. </li>
        </ul>

        <p>The default value is <a className="el" href="#a3c8e587c6763781bf0a469705ef3d208">NONE</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_2RestoreBackup_8cs_source#l00303">303</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a0acc4e1616e833e9f4b702fb1a4c2475">◆ </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="#aac8a81db91dddeea614cd09592fe1147">RESUME</a>: Resume subscriptions that were active when the backup was made. </li>
          <li> <a className="el" href="#ac725a9069edfe834573d1b63591a717a">PAUSE</a>: Pause subscriptions that were active when the backup was made. </li>
          <li> <a className="el" href="#abed0e21b45f5eeaa20901ef24e2f727c">CANCEL</a>: Cancel active subscriptions. </li>
        </ul>

        <p>The default value is <a className="el" href="#aac8a81db91dddeea614cd09592fe1147">RESUME</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_2RestoreBackup_8cs_source#l00226">226</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aac8a81db91dddeea614cd09592fe1147">◆ </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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00230">230</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_2RestoreBackup_8cs_source">RestoreBackup.cs</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ae26cb865c5e2dc9dfd818f290a129adc">◆ </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="/content/api/cs/__build_2public-os__ubuntu24_804-arch__amd64-cc__gcc__13_83_80_2install_2Kinetica_2Protocol_2RestoreBackup_8cs_source#l00129">129</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_2RestoreBackup_8cs_source">RestoreBackup.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_2RestoreBackup_8cs_source">RestoreBackup.cs</a></li>
      <li>Kinetica/Protocol/<a className="el" href="/content/api/cs/Kinetica_2Protocol_2RestoreBackup_8cs_source">RestoreBackup.cs</a></li>
    </ul>
  </div>
</div>