> ## 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="a34282710c81f1a106ac96da1e1ce4211" />

  <h2 className="memtitle"><span className="permalink"><a href="#a34282710c81f1a106ac96da1e1ce4211">◆ </a></span>showBackup() <span className="overload">\[1/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">ShowBackupResponse</a> gpudb::GPUdb::showBackup </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupRequest">ShowBackupRequest</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">request\_</span></span></td>
          <td>)</td>
          <td> const</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/cpp/structgpudb_1_1ShowBackupRequest#a4c53beb3d991fb36d95db8360588a455">datasourceName</a>. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupRequest">Request</a> 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"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a7164fd1c1db5357815a5465aadd5f8aa" />

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

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">ShowBackupResponse</a> & gpudb::GPUdb::showBackup </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_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"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">ShowBackupResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</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/cpp/structgpudb_1_1ShowBackupRequest#a4c53beb3d991fb36d95db8360588a455">datasourceName</a>. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">request\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupRequest">Request</a> object containing the parameters for the operation. </td>
            </tr>

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="ac5bb47e7d77debb047c7069ece8a6bba" />

  <h2 className="memtitle"><span className="permalink"><a href="#ac5bb47e7d77debb047c7069ece8a6bba">◆ </a></span>showBackup() <span className="overload">\[3/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">ShowBackupResponse</a> gpudb::GPUdb::showBackup </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">backupName</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">datasourceName</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span> ) const</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 arg">datasourceName</span>. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">backupName</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="paramdir">\[in]</td>
              <td className="paramname">datasourceName</td>
              <td>Data source through which the backup is accessible. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3269c6d9ff10c33f4213d76590effaed">show\_backup\_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/cpp/namespacegpudb#a819635b9225fc4b6afcd8768715c1d11">show\_backup\_backup\_type</a>: Show backups by type. This option is ignored if <a className="el" href="/content/api/cpp/namespacegpudb#a3269c6d9ff10c33f4213d76590effaed">backup\_id</a> is non-empty. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a33a1a3611401c6936cd9cc70688e14da">show\_backup\_all</a>: Show all backup types. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4a6b21c880132a275efce98c09c36131">show\_backup\_full</a>: Show full backups only. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2f7f019b2916c4c3645eb294b8d65afa">show\_backup\_incremental</a>: Show incremental backups only. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac6137ca9b245b82e7da42fb59871634c">show\_backup\_differential</a>: Show differential backups only. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a33a1a3611401c6936cd9cc70688e14da">show\_backup\_all</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a9293fe14d819e7e1a5fc94456f18b8b8">show\_backup\_show\_contents</a>: Show the contents of the backed-up snapshots. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a39bff1c8e36e73d2e34467c0ab71dd89">show\_backup\_none</a>: Don't show snapshot contents. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae3d1c5999b22c1766977f14a9bd0e8bc">show\_backup\_object\_names</a>: Show backed-up object names, and for tables, sizing detail. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a05d969c804a68086f2f082eb00c9e41d">show\_backup\_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/cpp/namespacegpudb#a39bff1c8e36e73d2e34467c0ab71dd89">show\_backup\_none</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a43c6648255e4c1eae0430f0a25a2e12c">show\_backup\_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/cpp/namespacegpudb#a661dcd43a3b8131b46ca569f68e80399">show\_backup\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a67f9b488a9898861f9782b2b2aa648ab">show\_backup\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a67f9b488a9898861f9782b2b2aa648ab">show\_backup\_false</a>.
                  </li>
                </ul>

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

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="afac647eceb0bf839b94ba9e4099a6ee0" />

  <h2 className="memtitle"><span className="permalink"><a href="#afac647eceb0bf839b94ba9e4099a6ee0">◆ </a></span>showBackup() <span className="overload">\[4/4]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="memname">
        <tr>
          <td className="memname"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">ShowBackupResponse</a> & gpudb::GPUdb::showBackup </td>
          <td>(</td>
          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">backupName</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::string &</td>
          <td className="paramname"><span className="paramname"><span className="em">datasourceName</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype">const std::map\< std::string, std::string > &</td>
          <td className="paramname"><span className="paramname"><span className="em">options</span></span>, </td>
        </tr>

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

          <td />

          <td className="paramtype"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">ShowBackupResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</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 arg">datasourceName</span>. </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">backupName</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="paramdir">\[in]</td>
              <td className="paramname">datasourceName</td>
              <td>Data source through which the backup is accessible. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3269c6d9ff10c33f4213d76590effaed">show\_backup\_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/cpp/namespacegpudb#a819635b9225fc4b6afcd8768715c1d11">show\_backup\_backup\_type</a>: Show backups by type. This option is ignored if <a className="el" href="/content/api/cpp/namespacegpudb#a3269c6d9ff10c33f4213d76590effaed">backup\_id</a> is non-empty. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a33a1a3611401c6936cd9cc70688e14da">show\_backup\_all</a>: Show all backup types. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4a6b21c880132a275efce98c09c36131">show\_backup\_full</a>: Show full backups only. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a2f7f019b2916c4c3645eb294b8d65afa">show\_backup\_incremental</a>: Show incremental backups only. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac6137ca9b245b82e7da42fb59871634c">show\_backup\_differential</a>: Show differential backups only. </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a33a1a3611401c6936cd9cc70688e14da">show\_backup\_all</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a9293fe14d819e7e1a5fc94456f18b8b8">show\_backup\_show\_contents</a>: Show the contents of the backed-up snapshots. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a39bff1c8e36e73d2e34467c0ab71dd89">show\_backup\_none</a>: Don't show snapshot contents. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#ae3d1c5999b22c1766977f14a9bd0e8bc">show\_backup\_object\_names</a>: Show backed-up object names, and for tables, sizing detail. </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a05d969c804a68086f2f082eb00c9e41d">show\_backup\_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/cpp/namespacegpudb#a39bff1c8e36e73d2e34467c0ab71dd89">show\_backup\_none</a>.
                  </li>

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a43c6648255e4c1eae0430f0a25a2e12c">show\_backup\_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/cpp/namespacegpudb#a661dcd43a3b8131b46ca569f68e80399">show\_backup\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a67f9b488a9898861f9782b2b2aa648ab">show\_backup\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a67f9b488a9898861f9782b2b2aa648ab">show\_backup\_false</a>.
                  </li>
                </ul>

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

            <tr>
              <td className="paramdir">\[out]</td>
              <td className="paramname">response\_</td>
              <td><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">Response</a> object containing the results of the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd"><a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>