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

# gpudb::ShowBackupRequest

> gpudb::ShowBackupRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a34282710c81f1a106ac96da1e1ce4211">GPUdb::showBackup</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/show__backup_8h_source">gpudb/protocol/show\_backup.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

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

      <tr className="memdesc:a2ba081e33db5ac9553d5deeb44a68dd5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupRequest" title="A set of parameters for GPUdb::showBackup.">ShowBackupRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a4c0a8f447f00d7e0ae6dc7b6862aac2e" id="r_a4c0a8f447f00d7e0ae6dc7b6862aac2e">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4c0a8f447f00d7e0ae6dc7b6862aac2e">ShowBackupRequest</a> (const std::string \&backupName\_, const std::string \&datasourceName\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a4c0a8f447f00d7e0ae6dc7b6862aac2e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1ShowBackupRequest" title="A set of parameters for GPUdb::showBackup.">ShowBackupRequest</a> object with the specified parameters. <br /></td>
      </tr>

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

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:af805c8a03a57dcc55bce0f3091392968" id="r_af805c8a03a57dcc55bce0f3091392968">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af805c8a03a57dcc55bce0f3091392968">backupName</a></td>
      </tr>

      <tr className="memdesc:af805c8a03a57dcc55bce0f3091392968">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the backup. <br /></td>
      </tr>

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

      <tr className="memitem:a4c53beb3d991fb36d95db8360588a455" id="r_a4c53beb3d991fb36d95db8360588a455">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4c53beb3d991fb36d95db8360588a455">datasourceName</a></td>
      </tr>

      <tr className="memdesc:a4c53beb3d991fb36d95db8360588a455">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Data source through which the backup is accessible. <br /></td>
      </tr>

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

      <tr className="memitem:aeb779e0298401e4b39bed93a83b5810b" id="r_aeb779e0298401e4b39bed93a83b5810b">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aeb779e0298401e4b39bed93a83b5810b">options</a></td>
      </tr>

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

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

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

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#a34282710c81f1a106ac96da1e1ce4211">GPUdb::showBackup</a>. </p>
      <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="#a4c53beb3d991fb36d95db8360588a455">datasourceName</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__backup_8h_source#l00021">21</a> of file <a className="el" href="/content/api/cpp/show__backup_8h_source">show\_backup.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a2ba081e33db5ac9553d5deeb44a68dd5">◆ </a></span>ShowBackupRequest() <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">gpudb::ShowBackupRequest::ShowBackupRequest </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/cpp/structgpudb_1_1ShowBackupRequest" title="A set of parameters for GPUdb::showBackup.">ShowBackupRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__backup_8h_source#l00026">26</a> of file <a className="el" href="/content/api/cpp/show__backup_8h_source">show\_backup.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4c0a8f447f00d7e0ae6dc7b6862aac2e">◆ </a></span>ShowBackupRequest() <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">gpudb::ShowBackupRequest::ShowBackupRequest </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>
              </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/cpp/structgpudb_1_1ShowBackupRequest" title="A set of parameters for GPUdb::showBackup.">ShowBackupRequest</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="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>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__backup_8h_source#l00117">117</a> of file <a className="el" href="/content/api/cpp/show__backup_8h_source">show\_backup.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#af805c8a03a57dcc55bce0f3091392968">◆ </a></span>backupName</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::ShowBackupRequest::backupName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the backup. </p>
        <p>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 ''. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__backup_8h_source#l00129">129</a> of file <a className="el" href="/content/api/cpp/show__backup_8h_source">show\_backup.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4c53beb3d991fb36d95db8360588a455">◆ </a></span>datasourceName</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::ShowBackupRequest::datasourceName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Data source through which the backup is accessible. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__backup_8h_source#l00134">134</a> of file <a className="el" href="/content/api/cpp/show__backup_8h_source">show\_backup.h</a>.</p>
      </div>
    </div>

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

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::ShowBackupRequest::options</td>
          </tr>
        </table>
      </div>

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

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

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/show__backup_8h_source#l00192">192</a> of file <a className="el" href="/content/api/cpp/show__backup_8h_source">show\_backup.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/show__backup_8h_source">show\_backup.h</a></li>
    </ul>
  </div>
</div>