> ## 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-javadoc">
  <ul className="member-list">
    <li>
      <div className="section detail" id="showBackup(com.gpudb.protocol.ShowBackupRequest)">
        <h3>showBackup</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/ShowBackupResponse" title="class in com.gpudb.protocol">ShowBackupResponse</a></span> <span className="element-name">showBackup</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest" title="class in com.gpudb.protocol">ShowBackupRequest</a> request)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">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 href="/content/api/java/com/gpudb/protocol/ShowBackupRequest#getDatasourceName()"><code>datasourceName</code></a>.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>request</code> - <a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest" title="class in com.gpudb.protocol"><code>Request</code></a> object containing the parameters for the operation.</div>
          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/ShowBackupResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>

    <li>
      <div className="section detail" id="showBackup(java.lang.String,java.lang.String,java.util.Map)">
        <h3>showBackup</h3>
        <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/ShowBackupResponse" title="class in com.gpudb.protocol">ShowBackupResponse</a></span> <span className="element-name">showBackup</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> backupName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> datasourceName, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
        <div className="block">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 <code>datasourceName</code>.</div>

        <div className="dl notes">
          <div className="dt">Parameters:</div>
          <div className="dd"><code>backupName</code> - 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 ''.</div>
          <div className="dd"><code>datasourceName</code> - Data source through which the backup is accessible.</div>

          <div className="dd">
            <code>options</code> - Optional parameters.

            <ul>
              <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#BACKUP_ID"><code>BACKUP\_ID</code></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 href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#BACKUP_TYPE"><code>BACKUP\_TYPE</code></a>: Show backups by type. This option is ignored if <a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#BACKUP_ID"><code>BACKUP\_ID</code></a> is non-empty. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#ALL"><code>ALL</code></a>: Show all backup types. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#FULL"><code>FULL</code></a>: Show full backups only. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#INCREMENTAL"><code>INCREMENTAL</code></a>: Show incremental backups only. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#DIFFERENTIAL"><code>DIFFERENTIAL</code></a>: Show differential backups only. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#ALL"><code>ALL</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#SHOW_CONTENTS"><code>SHOW\_CONTENTS</code></a>: Show the contents of the backed-up snapshots. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#NONE"><code>NONE</code></a>: Don't show snapshot contents. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#OBJECT_NAMES"><code>OBJECT\_NAMES</code></a>: Show backed-up object names, and for tables, sizing detail. </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#OBJECT_FILES"><code>OBJECT\_FILES</code></a>: Show backed-up object names, and for tables, sizing detail and associated files. </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#NONE"><code>NONE</code></a>.
              </li>

              <li>
                <a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#NO_ERROR_IF_NOT_EXISTS"><code>NO\_ERROR\_IF\_NOT\_EXISTS</code></a>: Whether or not to suppress the error if the specified backup does not exist. Supported values:

                <ul>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#TRUE"><code>TRUE</code></a> </li>
                  <li><a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#FALSE"><code>FALSE</code></a> </li>
                </ul>

                The default value is <a href="/content/api/java/com/gpudb/protocol/ShowBackupRequest.Options#FALSE"><code>FALSE</code></a>.
              </li>
            </ul>

            The default value is an empty <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link"><code>Map</code></a>.
          </div>

          <div className="dt">Returns:</div>
          <div className="dd"><a href="/content/api/java/com/gpudb/protocol/ShowBackupResponse" title="class in com.gpudb.protocol"><code>Response</code></a> object containing the results of the operation.</div>
          <div className="dt">Throws:</div>
          <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if an error occurs during the operation.</div>
        </div>
      </div>
    </li>
  </ul>
</div>