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

# showBackup

<div className="kinetica-doxygen">
  <div id="ae657010c0cb175e020e434279c2e0b84" />

  <h2 className="memtitle"><span className="permalink"><a href="#ae657010c0cb175e020e434279c2e0b84">◆ </a></span>showBackup() <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"><a className="el" href="/content/api/cs/classkinetica_1_1ShowBackupResponse">ShowBackupResponse</a> kinetica.Kinetica.showBackup </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1ShowBackupRequest">ShowBackupRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>Shows information about one or more <a href="/content/admin/backup_restore/#database-backup" target="_top">backups</a> accessible via the <a href="/content/concepts/data_sources/" target="_top">data source</a> specified by <a className="el" href="/content/api/cs/classkinetica_1_1ShowBackupRequest#a76e5b2cdc7a37b933ecfd40cabb2b020">datasource\_name</a>. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

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

  <div id="ae2ec24dc7b1737d1235a416637a84299" />

  <h2 className="memtitle"><span className="permalink"><a href="#ae2ec24dc7b1737d1235a416637a84299">◆ </a></span>showBackup() <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"><a className="el" href="/content/api/cs/classkinetica_1_1ShowBackupResponse">ShowBackupResponse</a> kinetica.Kinetica.showBackup </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">backup\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">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>Shows information about one or more <a href="/content/admin/backup_restore/#database-backup" target="_top">backups</a> accessible via the <a href="/content/concepts/data_sources/" target="_top">data source</a> specified by <span className="em">datasource\_name</span> . </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. An empty string or '<span className="em">' will show all existing backups. Any text followed by a '</span>' will show backups whose name starts with that text. The default value is ''. </td>
            </tr>

            <tr>
              <td className="paramname">datasource\_name</td>
              <td>Data source through which the backup is accessible.</td>
            </tr>

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

              <td>
                Optional parameters.

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

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a020be78d3819b67197115d818f061b33">BACKUP\_TYPE</a>: Show backups by type. This option is ignored if <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a47a6073eebbda51ee4329d03fe970532">BACKUP\_ID</a> is non-empty. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#aa10c81bd930350b06a123319d43d2574">ALL</a>: Show all backup types. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a942b5a861fafe7132c5c269b22cf9ff1">FULL</a>: Show full backups only. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a8df86b5f6dc41fae63e19e7a17065ccc">INCREMENTAL</a>: Show incremental backups only. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a9cc03b635b73a58f9ec8806e8dafe692">DIFFERENTIAL</a>: Show differential backups only. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#aa10c81bd930350b06a123319d43d2574">ALL</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a6d335239a91f3ff55f662e05d6ec0771">SHOW\_CONTENTS</a>: Show the contents of the backed-up snapshots. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#ab5596047c705586c4ad85efb0274949d">NONE</a>: Don't show snapshot contents. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#ad3f59977bcdc86891c5437aa6ea0eabe">OBJECT\_NAMES</a>: Show backed-up object names, and for tables, sizing detail. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a8523a1aeffdbcc89793efe92ef6cf363">OBJECT\_FILES</a>: Show backed-up object names, and for tables, sizing detail and associated files. </li>
                    </ul>

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

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a47655492ccc1a606eb123e162080ef34">NO\_ERROR\_IF\_NOT\_EXISTS</a>: Whether or not to suppress the error if the specified backup does not exist. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a5407a05431dcb0731b9076706fdaece7">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a05d0100ebc1d73bb925bfb83690f9e02">FALSE</a> </li>
                    </ul>

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

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

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

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

  <div id="a1d28d264fcc825d212df15240994d3b6" />

  <h2 className="memtitle"><span className="permalink"><a href="#a1d28d264fcc825d212df15240994d3b6">◆ </a></span>ShowBackupAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1ShowBackupResponse">ShowBackupResponse</a> > kinetica.Kinetica.ShowBackupAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1ShowBackupRequest">ShowBackupRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Shows information about one or more <a href="/content/admin/backup_restore/#database-backup" target="_top">backups</a> accessible via the <a href="/content/concepts/data_sources/" target="_top">data source</a> specified by <a className="el" href="/content/api/cs/classkinetica_1_1ShowBackupRequest#a76e5b2cdc7a37b933ecfd40cabb2b020">datasource\_name</a>. </p>
      <p>(async)</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

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

  <div id="a6c6468ca8cb182c925197b123f40ada9" />

  <h2 className="memtitle"><span className="permalink"><a href="#a6c6468ca8cb182c925197b123f40ada9">◆ </a></span>ShowBackupAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1ShowBackupResponse">ShowBackupResponse</a> > kinetica.Kinetica.ShowBackupAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">backup\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">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>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Shows information about one or more <a href="/content/admin/backup_restore/#database-backup" target="_top">backups</a> accessible via the <a href="/content/concepts/data_sources/" target="_top">data source</a> specified by <span className="em">datasource\_name</span> . </p>
      <p>(async)</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. An empty string or '<span className="em">' will show all existing backups. Any text followed by a '</span>' will show backups whose name starts with that text. The default value is ''. </td>
            </tr>

            <tr>
              <td className="paramname">datasource\_name</td>
              <td>Data source through which the backup is accessible.</td>
            </tr>

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

              <td>
                Optional parameters.

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

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a020be78d3819b67197115d818f061b33">BACKUP\_TYPE</a>: Show backups by type. This option is ignored if <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a47a6073eebbda51ee4329d03fe970532">BACKUP\_ID</a> is non-empty. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#aa10c81bd930350b06a123319d43d2574">ALL</a>: Show all backup types. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a942b5a861fafe7132c5c269b22cf9ff1">FULL</a>: Show full backups only. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a8df86b5f6dc41fae63e19e7a17065ccc">INCREMENTAL</a>: Show incremental backups only. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a9cc03b635b73a58f9ec8806e8dafe692">DIFFERENTIAL</a>: Show differential backups only. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#aa10c81bd930350b06a123319d43d2574">ALL</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a6d335239a91f3ff55f662e05d6ec0771">SHOW\_CONTENTS</a>: Show the contents of the backed-up snapshots. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#ab5596047c705586c4ad85efb0274949d">NONE</a>: Don't show snapshot contents. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#ad3f59977bcdc86891c5437aa6ea0eabe">OBJECT\_NAMES</a>: Show backed-up object names, and for tables, sizing detail. </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a8523a1aeffdbcc89793efe92ef6cf363">OBJECT\_FILES</a>: Show backed-up object names, and for tables, sizing detail and associated files. </li>
                    </ul>

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

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a47655492ccc1a606eb123e162080ef34">NO\_ERROR\_IF\_NOT\_EXISTS</a>: Whether or not to suppress the error if the specified backup does not exist. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a5407a05431dcb0731b9076706fdaece7">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1ShowBackupRequest_1_1Options#a05d0100ebc1d73bb925bfb83690f9e02">FALSE</a> </li>
                    </ul>

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

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

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

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