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

> kinetica.RestoreBackupRequest — Kinetica C# API

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

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

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

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

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

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

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

      <tr className="memdesc:">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A set of string constants for the parameter <a className="el" href="#a5ca4bbcede2ef194db4a4d5738486bd8" title="Map of database objects to be restored from the backup.">RestoreBackupRequest.restore\_objects\_map</a>. <a href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#details">More...</a><br /></td>
      </tr>

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

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

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

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

      <tr className="memdesc:a168f101561702ee265c8285bc3f900d9">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cs/classkinetica_1_1RestoreBackupRequest" title="A set of parameters for Kinetica.restoreBackup.">RestoreBackupRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a1e11b37788ca691f13c4ac734aa60d5f" id="r_a1e11b37788ca691f13c4ac734aa60d5f">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a1e11b37788ca691f13c4ac734aa60d5f">RestoreBackupRequest</a> (string <a className="el" href="#aa0108b6b3cad6705ca50e3edd71d11df">backup\_name</a>, IDictionary\< string, string > <a className="el" href="#a5ca4bbcede2ef194db4a4d5738486bd8">restore\_objects\_map</a>, string <a className="el" href="#ab3500066b0e84c08b7ff39d04fe39cb2">datasource\_name</a>, IDictionary\< string, string > <a className="el" href="#aaa723aa6ec8482bafdec0c4ff9f96fee">options</a>=null)</td>
      </tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      <tr className="memdesc:aa0108b6b3cad6705ca50e3edd71d11df">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the backup to restore from, which must refer to an existing backup. <br /></td>
      </tr>

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

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

      <tr className="memdesc:a5ca4bbcede2ef194db4a4d5738486bd8">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Map of database objects to be restored from the backup. <br /></td>
      </tr>

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

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

      <tr className="memdesc:ab3500066b0e84c08b7ff39d04fe39cb2">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Data source through which the backup will be restored. <br /></td>
      </tr>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    <div id="details" />

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

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cs/classkinetica_1_1Kinetica/restorebackup#a7219b89c4316e73291cfa6100c8363c1">Kinetica.restoreBackup</a>. </p>
      <p>Restores database objects from a <a href="/content/admin/backup_restore/#database-backup" target="_top">backup</a> accessible via the <a href="/content/concepts/data_sources/" target="_top">data source</a> specified by <a className="el" href="#ab3500066b0e84c08b7ff39d04fe39cb2" title="Data source through which the backup will be restored.">RestoreBackupRequest.datasource\_name</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#L20">20</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">Constructor & Destructor Documentation</h2>

    <div id="a168f101561702ee265c8285bc3f900d9" />

    <h2 className="memtitle"><span className="permalink"><a href="#a168f101561702ee265c8285bc3f900d9">◆ </a></span>RestoreBackupRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.RestoreBackupRequest.RestoreBackupRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cs/classkinetica_1_1RestoreBackupRequest" title="A set of parameters for Kinetica.restoreBackup.">RestoreBackupRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L844">844</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="a1e11b37788ca691f13c4ac734aa60d5f" />

    <h2 className="memtitle"><span className="permalink"><a href="#a1e11b37788ca691f13c4ac734aa60d5f">◆ </a></span>RestoreBackupRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">kinetica.RestoreBackupRequest.RestoreBackupRequest </td>
                  <td>(</td>
                  <td className="paramtype">string</td>
                  <td className="paramname"><span className="paramname"><span className="em">backup\_name</span></span>, </td>
                </tr>

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

                  <td />

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

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

                  <td />

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

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

                  <td />

                  <td className="paramtype">IDictionary\< string, string ></td>
                  <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span> )</td>
                </tr>
              </table>
            </td>

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

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cs/classkinetica_1_1RestoreBackupRequest" title="A set of parameters for Kinetica.restoreBackup.">RestoreBackupRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramname">backup\_name</td>
                <td>Name of the backup to restore from, which must refer to an existing backup. The default value is ''.</td>
              </tr>

              <tr>
                <td className="paramname">restore\_objects\_map</td>

                <td>
                  Map of database objects to be restored from the backup.

                  <ul>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a41f94185c6d913a57ff304b0261cfe65">ALL</a>: All object types and data contained in the given <a href="/content/concepts/schemas/" target="_top">schema(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a5b6633955757c18fdadedffe1b018531">CATALOG</a>: Data Lake catalog that is external to the database. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a50c6f9d81d2587dfd2fbf73cf7336758">CONTEXT</a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a6f9fe84ecda89c64779f7879a5b4097c">CREDENTIAL</a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#ae3e2cac350d32a753fb9f2bb5798c322">DATASINK</a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#ab38387b6391849b628cc1805c1c26656">DATASOURCE</a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#afb3a572f7a9955537caf15cc84038f1b">DIRECTORY</a>: KiFS <a href="/content/tools/kifs/" target="_top">File directory(ies)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a8a0a590236021cc0b633ef72eae40055">FUNCTION\_ENVIRONMENT</a>: <a href="/content/udf/python/writing/#udf-python-func-env" target="_top">Python UDF function environment(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a50fabbdb09295dba2a565ceb525ccabd">GRAPH</a>: <a href="/content/graph_solver/network_graph_solver/" target="_top">Graph</a> definition(s). Source table(s), if applicable, are required in order to restore graph objects. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a3d35d2fd3930d3b1ebac6704bcb2a502">MONITOR</a>: <a href="/content/concepts/table_monitors/" target="_top">Table monitor(s)</a> / <a href="/content/sql/ddl/create-stream" target="_top">SQL stream(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#aad0a13715a8e90b8f023c2188771cb72">RESOURCE\_GROUP</a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#adacbdd86be8dd3dc67eee858073dcc0b">ROLE</a>: <a href="/content/security/sec_concepts/#roles" target="_top">Role(s)</a>, role members (roles or users, recursively), and associated permissions. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a75d0300053fa2bae476786af24b5f9f4">STORED\_PROCEDURE</a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a39272d64b77cde79880c1e92f217d39b">TABLE</a>: <a href="/content/concepts/tables/" target="_top">Table(s)</a> and <a href="/content/sql/ddl/create-view" target="_top">SQL view(s)</a>. Tables with subscriptions will by default be restored in the state they were in at the time of the snapshot. See <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a5f009f72d853bb4caa5a1fbe7bb9733b">RESTORE\_SUBSCRIPTIONS</a> for options to override the default behavior. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a3d639a87ec0b53d41736a9845517df67">USER</a>: <a href="/content/security/sec_concepts/#security-concepts-users" target="_top">User(s)</a> (internal and external) and associated permissions. </li>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#aa2b68b0006e4a0966944af1daa718bf5">USER\_DEFINED\_FUNCTION</a>: <a href="/content/udf_overview" target="_top">UDF(s)</a>. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramname">datasource\_name</td>
                <td>Data source through which the backup will be restored.</td>
              </tr>

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

                <td>
                  Optional parameters.

                  <ul>
                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a1f54e4f1acae1734a806d70ec7d100f4">BACKUP\_ID</a>: ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup. The default value is ''. </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a6d4409486478eb9d9bdcfe9dbca13ae5">CHECKSUM</a>: Whether or not to verify checksums for backup files when restoring. Supported values:

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

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

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a3eadc4ec83f82842b244035d0a7e8757">CASCADE\_FOREIGN\_KEYS</a>: Whether to drop live foreign-key-referencing tables that are not themselves part of the backup, when the table they reference is being replaced. Only applies when <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a> is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#ac3446eb6a76aab1e875260e8be239b70">REPLACE</a>. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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>

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

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a203ec21f4cc2059ed50f8de13bbd675c">CREATE\_SCHEMA\_IF\_NOT\_EXIST</a>: Behavior to apply when the schema containing any database object to restore does not already exist. Supported values:

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

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a63a1399078e94273f4840dfd3ff6be19">TRUE</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a08929da7340c4915a7d7c38ee72aecc9">DDL\_ONLY</a>: Behavior to apply when restoring tables. Supported values:

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

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

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a8189815066a8d444618305d86e324889">DRY\_RUN</a>: Whether or not to perform a dry run of the restoration operation. Supported values:

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

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

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a5f009f72d853bb4caa5a1fbe7bb9733b">RESTORE\_SUBSCRIPTIONS</a>: Behavior to apply when restoring datasource subscriptions on tables. Supported values:

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

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a9c0d7761c50c780a25b758a80e5b62f2">RESUME</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a5abe71733cb4aa98a3e00a1788a9dd6e">REINGEST</a>: Behavior to apply when restoring table data. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>: Restore the persisted data files directly. </li>
                      </ul>

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

                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a488a4e8c2e2c9780fea210bc93e39e79">RENAMED\_OBJECTS\_SCHEMA</a>: If the <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a> is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#aade58739cc2973a7ff3d35bf1219f494">RENAME</a>, use this schema for relocated existing objects instead of the default generated one. The default value is ''. </li>

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a50d863d1068657c17b3719c119193659">RESTORE\_ALL\_PERMISSIONS</a>: Whether or not all permissions of restored principals should be restored or scoped to the restored objects. Supported values:

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

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

                    <li>
                      <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a>: Behavior to apply when any database object to restore already exists. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a488a4e8c2e2c9780fea210bc93e39e79">RENAMED\_OBJECTS\_SCHEMA</a>. This policy does not apply to non-schema objects. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a4cd096123ab7593c9abd793b56249581">NONE</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#aebbfaa89ac3befedb2f70a18c61221aa">TARGET\_SCHEMA\_MAP</a>: Restore schema-based objects to alternate schema. 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 ''. </li>
                  </ul>

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

        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L1286">1286</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>

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

    <div id="aa0108b6b3cad6705ca50e3edd71d11df" />

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

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

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

      <div className="memdoc">
        <p>Name of the backup to restore from, which must refer to an existing backup. </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#L399">399</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="ab3500066b0e84c08b7ff39d04fe39cb2" />

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

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

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

      <div className="memdoc">
        <p>Data source through which the backup will be restored. </p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L539">539</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="aaa723aa6ec8482bafdec0c4ff9f96fee" />

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

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

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

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

        <ul>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a1f54e4f1acae1734a806d70ec7d100f4">BACKUP\_ID</a>: ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup. The default value is ''. </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a6d4409486478eb9d9bdcfe9dbca13ae5">CHECKSUM</a>: Whether or not to verify checksums for backup files when restoring. Supported values:

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

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

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a3eadc4ec83f82842b244035d0a7e8757">CASCADE\_FOREIGN\_KEYS</a>: Whether to drop live foreign-key-referencing tables that are not themselves part of the backup, when the table they reference is being replaced. Only applies when <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a> is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#ac3446eb6a76aab1e875260e8be239b70">REPLACE</a>. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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>

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

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a203ec21f4cc2059ed50f8de13bbd675c">CREATE\_SCHEMA\_IF\_NOT\_EXIST</a>: Behavior to apply when the schema containing any database object to restore does not already exist. Supported values:

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

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a63a1399078e94273f4840dfd3ff6be19">TRUE</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a08929da7340c4915a7d7c38ee72aecc9">DDL\_ONLY</a>: Behavior to apply when restoring tables. Supported values:

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

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

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a8189815066a8d444618305d86e324889">DRY\_RUN</a>: Whether or not to perform a dry run of the restoration operation. Supported values:

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

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

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a5f009f72d853bb4caa5a1fbe7bb9733b">RESTORE\_SUBSCRIPTIONS</a>: Behavior to apply when restoring datasource subscriptions on tables. Supported values:

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

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a9c0d7761c50c780a25b758a80e5b62f2">RESUME</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a5abe71733cb4aa98a3e00a1788a9dd6e">REINGEST</a>: Behavior to apply when restoring table data. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#ae7fe7ae5c38d277162726a6d01faede4">FALSE</a>: Restore the persisted data files directly. </li>
            </ul>

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

          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a488a4e8c2e2c9780fea210bc93e39e79">RENAMED\_OBJECTS\_SCHEMA</a>: If the <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a> is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#aade58739cc2973a7ff3d35bf1219f494">RENAME</a>, use this schema for relocated existing objects instead of the default generated one. The default value is ''. </li>

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a50d863d1068657c17b3719c119193659">RESTORE\_ALL\_PERMISSIONS</a>: Whether or not all permissions of restored principals should be restored or scoped to the restored objects. Supported values:

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

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

          <li>
            <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#adf736ad7637ab58d24110df481e83711">RESTORE\_POLICY</a>: Behavior to apply when any database object to restore already exists. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#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="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a488a4e8c2e2c9780fea210bc93e39e79">RENAMED\_OBJECTS\_SCHEMA</a>. This policy does not apply to non-schema objects. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a4cd096123ab7593c9abd793b56249581">NONE</a>.
          </li>

          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#aebbfaa89ac3befedb2f70a18c61221aa">TARGET\_SCHEMA\_MAP</a>: Restore schema-based objects to alternate schema. 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 ''. </li>
        </ul>

        <p>The default value is an empty Dictionary.</p>
        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L840">840</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="a5ca4bbcede2ef194db4a4d5738486bd8" />

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

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

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

      <div className="memdoc">
        <p>Map of database objects to be restored from the backup. </p>

        <ul>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a41f94185c6d913a57ff304b0261cfe65">ALL</a>: All object types and data contained in the given <a href="/content/concepts/schemas/" target="_top">schema(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a5b6633955757c18fdadedffe1b018531">CATALOG</a>: Data Lake catalog that is external to the database. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a50c6f9d81d2587dfd2fbf73cf7336758">CONTEXT</a>: <a href="/content/sql-gpt/concepts/#sql-gpt-context" target="_top">Context(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a6f9fe84ecda89c64779f7879a5b4097c">CREDENTIAL</a>: <a href="/content/concepts/credentials/" target="_top">Credential(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#ae3e2cac350d32a753fb9f2bb5798c322">DATASINK</a>: <a href="/content/concepts/data_sinks/" target="_top">Data sink(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#ab38387b6391849b628cc1805c1c26656">DATASOURCE</a>: <a href="/content/concepts/data_sources/" target="_top">Data source(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#afb3a572f7a9955537caf15cc84038f1b">DIRECTORY</a>: KiFS <a href="/content/tools/kifs/" target="_top">File directory(ies)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a8a0a590236021cc0b633ef72eae40055">FUNCTION\_ENVIRONMENT</a>: <a href="/content/udf/python/writing/#udf-python-func-env" target="_top">Python UDF function environment(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a50fabbdb09295dba2a565ceb525ccabd">GRAPH</a>: <a href="/content/graph_solver/network_graph_solver/" target="_top">Graph</a> definition(s). Source table(s), if applicable, are required in order to restore graph objects. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a3d35d2fd3930d3b1ebac6704bcb2a502">MONITOR</a>: <a href="/content/concepts/table_monitors/" target="_top">Table monitor(s)</a> / <a href="/content/sql/ddl/create-stream" target="_top">SQL stream(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#aad0a13715a8e90b8f023c2188771cb72">RESOURCE\_GROUP</a>: <a href="/content/rm/concepts/#resource-groups" target="_top">Resource group(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#adacbdd86be8dd3dc67eee858073dcc0b">ROLE</a>: <a href="/content/security/sec_concepts/#roles" target="_top">Role(s)</a>, role members (roles or users, recursively), and associated permissions. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a75d0300053fa2bae476786af24b5f9f4">STORED\_PROCEDURE</a>: <a href="/content/sql/procedure/" target="_top">SQL procedure(s)</a>. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a39272d64b77cde79880c1e92f217d39b">TABLE</a>: <a href="/content/concepts/tables/" target="_top">Table(s)</a> and <a href="/content/sql/ddl/create-view" target="_top">SQL view(s)</a>. Tables with subscriptions will by default be restored in the state they were in at the time of the snapshot. See <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1Options#a5f009f72d853bb4caa5a1fbe7bb9733b">RESTORE\_SUBSCRIPTIONS</a> for options to override the default behavior. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#a3d639a87ec0b53d41736a9845517df67">USER</a>: <a href="/content/security/sec_concepts/#security-concepts-users" target="_top">User(s)</a> (internal and external) and associated permissions. </li>
          <li> <a className="el" href="/content/api/cs/structkinetica_1_1RestoreBackupRequest_1_1RestoreObjectsMap#aa2b68b0006e4a0966944af1daa718bf5">USER\_DEFINED\_FUNCTION</a>: <a href="/content/udf_overview" target="_top">UDF(s)</a>. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/Protocol/RestoreBackup.cs#L535">535</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 class was generated from the following file:

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


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