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

# show_backup

<div className="kinetica-pydoc">
  <div className="dl py method">
    <div className="dt sig sig-object py" id="gpudb.GPUdb.show_backup"> <span className="sig-name descname"><span className="pre">show\_backup</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">backup\_name</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">''</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">datasource\_name</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">options</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">{"{"}{"}"}</span></span></span><span className="sig-paren">)</span><a href="https://github.com/kineticadb/kinetica-api-python/blob/master/gpudb/gpudb.py#L38195"><span className="viewcode-link"><span className="pre">\[source]</span></span></a></div>

    <div className="dd">
      <p>Shows information about one or more <a className="reference external" href="/content/admin/backup_restore/#database-backup">backups</a> accessible via the <a className="reference external" href="/content/concepts/data_sources/">data source</a> specified by input parameter <span className="em">datasource\_name</span>.</p>
      <p><strong>Parameters</strong></p>

      <div className="blockquote">
        <div>
          <div className="dl">
            <div className="dt">backup\_name (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>Name of the backup. An empty string or ‘\*’ will show all existing backups. Any text followed by a ‘\*’ will show backups whose name starts with that text. The default value is ‘’.</p>
            </div>

            <div className="dt">datasource\_name (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>Data source through which the backup is accessible.</p>
            </div>

            <div className="dt">options (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Optional parameters. Allowed keys are:</p>

              <ul>
                <li>
                  <p><strong>backup\_id</strong> – ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ‘’.</p>
                </li>

                <li>
                  <p><strong>backup\_type</strong> – Show backups by type. This option is ignored if <span className="em">backup\_id</span> is non-empty. Allowed values are:</p>

                  <ul className="simple">
                    <li>
                      <p><strong>all</strong> – Show all backup types.</p>
                    </li>

                    <li>
                      <p><strong>full</strong> – Show full backups only.</p>
                    </li>

                    <li>
                      <p><strong>incremental</strong> – Show incremental backups only.</p>
                    </li>

                    <li>
                      <p><strong>differential</strong> – Show differential backups only.</p>
                    </li>
                  </ul>

                  <p>The default value is ‘all’.</p>
                </li>

                <li>
                  <p><strong>show\_contents</strong> – Show the contents of the backed-up snapshots. Allowed values are:</p>

                  <ul className="simple">
                    <li>
                      <p><strong>none</strong> – Don’t show snapshot contents.</p>
                    </li>

                    <li>
                      <p><strong>object\_names</strong> – Show backed-up object names, and for tables, sizing detail.</p>
                    </li>

                    <li>
                      <p><strong>object\_files</strong> – Show backed-up object names, and for tables, sizing detail and associated files.</p>
                    </li>
                  </ul>

                  <p>The default value is ‘none’.</p>
                </li>

                <li>
                  <p><strong>no\_error\_if\_not\_exists</strong> – Whether or not to suppress the error if the specified backup does not exist. Allowed values are:</p>

                  <ul className="simple">
                    <li>
                      <p>true</p>
                    </li>

                    <li>
                      <p>false</p>
                    </li>
                  </ul>

                  <p>The default value is ‘false’.</p>
                </li>
              </ul>

              <p>The default value is an empty dict ( {"{"}{"}"} ).</p>
            </div>
          </div>
        </div>
      </div>

      <p><strong>Returns</strong></p>

      <div className="blockquote">
        <div>
          <p>A dict with the following entries–</p>

          <div className="dl simple">
            <div className="dt">backup\_name (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>Value of input parameter <span className="em">backup\_name</span>.</p>
            </div>

            <div className="dt">backup\_description (<span className="em">list of dicts of str to str</span>) –</div>

            <div className="dd">
              <p>Details about the overall backup(s).</p>
            </div>

            <div className="dt">backup\_ids (<span className="em">list of dicts of str to str</span>) –</div>

            <div className="dd">
              <p>Details about the individual snapshots contained within the backup(s).</p>
            </div>

            <div className="dt">backup\_contents (<span className="em">list of dicts of str to str</span>) –</div>

            <div className="dd">
              <p>When <span className="em">show\_contents</span> is <span className="em">object\_names</span>, the names of the backed-up objects as well as sizing detail of any backed-up tables; when <span className="em">object\_files</span>, the names of the backed-up objects as well as sizing detail and associated data files of any backed-up tables.</p>
            </div>

            <div className="dt">deleted\_backup\_ids (<span className="em">list of dicts of str to str</span>) –</div>

            <div className="dd">
              <p>IDs of any snapshots that have been deleted from the containing backup(s).</p>
            </div>

            <div className="dt">info (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Additional information.</p>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>