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

# dropBackup

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

  <h2 className="memtitle"><span className="permalink"><a href="#aa6f1b56740a5cc4a68fb18396971e2cb">◆ </a></span>dropBackup() <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_1DropBackupResponse">DropBackupResponse</a> gpudb::GPUdb::dropBackup </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1DropBackupRequest">DropBackupRequest</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>Deletes one or more existing database <a href="/content/admin/backup_restore/#database-backup" target="_top">backups</a> and contained snapshots, accessible via the <a href="/content/concepts/data_sinks/" target="_top">data sink</a> specified by <a className="el" href="/content/api/cpp/structgpudb_1_1DropBackupRequest#a4b5c92fb561b0e6d2a480f95cf678a6f">datasinkName</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_1DropBackupRequest">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_1DropBackupResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="ade81d264162c890bc255e79fa367a368" />

  <h2 className="memtitle"><span className="permalink"><a href="#ade81d264162c890bc255e79fa367a368">◆ </a></span>dropBackup() <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_1DropBackupResponse">DropBackupResponse</a> & gpudb::GPUdb::dropBackup </td>
          <td>(</td>
          <td className="paramtype">const <a className="el" href="/content/api/cpp/structgpudb_1_1DropBackupRequest">DropBackupRequest</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_1DropBackupResponse">DropBackupResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Deletes one or more existing database <a href="/content/admin/backup_restore/#database-backup" target="_top">backups</a> and contained snapshots, accessible via the <a href="/content/concepts/data_sinks/" target="_top">data sink</a> specified by <a className="el" href="/content/api/cpp/structgpudb_1_1DropBackupRequest#a4b5c92fb561b0e6d2a480f95cf678a6f">datasinkName</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_1DropBackupRequest">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_1DropBackupResponse">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_1DropBackupResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>

  <div id="abedce955754617f8bded614fe8ac3af9" />

  <h2 className="memtitle"><span className="permalink"><a href="#abedce955754617f8bded614fe8ac3af9">◆ </a></span>dropBackup() <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_1DropBackupResponse">DropBackupResponse</a> gpudb::GPUdb::dropBackup </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">datasinkName</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>Deletes one or more existing database <a href="/content/admin/backup_restore/#database-backup" target="_top">backups</a> and contained snapshots, accessible via the <a href="/content/concepts/data_sinks/" target="_top">data sink</a> specified by <span className="em arg">datasinkName</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 to be deleted. An empty string or '<span className="em">' will delete all existing backups. Any text followed by a '</span>' will delete backups whose name starts with that text. When deleting multiple backups, <a className="el" href="/content/api/cpp/namespacegpudb#a62edbf4aebeff008a12664411f1127db">delete\_all\_backups</a> must be set to <a className="el" href="/content/api/cpp/namespacegpudb#a434bbb668605b9bef45e0bb179e2ea39">true</a>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">datasinkName</td>
              <td>Data sink 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#a73109498dd431f5e85a083d0a69b18ec">drop\_backup\_dry\_run</a>: Whether or not to perform a dry run of a backup deletion. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a434bbb668605b9bef45e0bb179e2ea39">drop\_backup\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6fbf54aeb57c2b3de5ce6d2e572725a1">drop\_backup\_false</a> </li>
                    </ul>

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

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a62edbf4aebeff008a12664411f1127db">drop\_backup\_delete\_all\_backups</a>: Allow multiple backups to be deleted if <a className="el" href="/content/api/cpp/namespacegpudb#a434bbb668605b9bef45e0bb179e2ea39">true</a> and multiple backup names are found matching <span className="em arg">backupName</span>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a434bbb668605b9bef45e0bb179e2ea39">drop\_backup\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6fbf54aeb57c2b3de5ce6d2e572725a1">drop\_backup\_false</a> </li>
                    </ul>

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

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a855eb532c369e687541a8b142dff1e82">drop\_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#a434bbb668605b9bef45e0bb179e2ea39">drop\_backup\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6fbf54aeb57c2b3de5ce6d2e572725a1">drop\_backup\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6fbf54aeb57c2b3de5ce6d2e572725a1">drop\_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_1DropBackupResponse">Response</a> object containing the result of the operation. </div>
      </div>
    </div>
  </div>

  <div id="a5a27fbd8c029c24986496744913025d4" />

  <h2 className="memtitle"><span className="permalink"><a href="#a5a27fbd8c029c24986496744913025d4">◆ </a></span>dropBackup() <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_1DropBackupResponse">DropBackupResponse</a> & gpudb::GPUdb::dropBackup </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">datasinkName</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_1DropBackupResponse">DropBackupResponse</a> &</td>
          <td className="paramname"><span className="paramname"><span className="em">response\_</span></span> ) const</td>
        </tr>
      </table>
    </div>

    <div className="memdoc">
      <p>Deletes one or more existing database <a href="/content/admin/backup_restore/#database-backup" target="_top">backups</a> and contained snapshots, accessible via the <a href="/content/concepts/data_sinks/" target="_top">data sink</a> specified by <span className="em arg">datasinkName</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 to be deleted. An empty string or '<span className="em">' will delete all existing backups. Any text followed by a '</span>' will delete backups whose name starts with that text. When deleting multiple backups, <a className="el" href="/content/api/cpp/namespacegpudb#a62edbf4aebeff008a12664411f1127db">delete\_all\_backups</a> must be set to <a className="el" href="/content/api/cpp/namespacegpudb#a434bbb668605b9bef45e0bb179e2ea39">true</a>. </td>
            </tr>

            <tr>
              <td className="paramdir">\[in]</td>
              <td className="paramname">datasinkName</td>
              <td>Data sink 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#a73109498dd431f5e85a083d0a69b18ec">drop\_backup\_dry\_run</a>: Whether or not to perform a dry run of a backup deletion. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a434bbb668605b9bef45e0bb179e2ea39">drop\_backup\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6fbf54aeb57c2b3de5ce6d2e572725a1">drop\_backup\_false</a> </li>
                    </ul>

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

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a62edbf4aebeff008a12664411f1127db">drop\_backup\_delete\_all\_backups</a>: Allow multiple backups to be deleted if <a className="el" href="/content/api/cpp/namespacegpudb#a434bbb668605b9bef45e0bb179e2ea39">true</a> and multiple backup names are found matching <span className="em arg">backupName</span>. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a434bbb668605b9bef45e0bb179e2ea39">drop\_backup\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6fbf54aeb57c2b3de5ce6d2e572725a1">drop\_backup\_false</a> </li>
                    </ul>

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

                  <li>
                    <a className="el" href="/content/api/cpp/namespacegpudb#a855eb532c369e687541a8b142dff1e82">drop\_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#a434bbb668605b9bef45e0bb179e2ea39">drop\_backup\_true</a> </li>
                      <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6fbf54aeb57c2b3de5ce6d2e572725a1">drop\_backup\_false</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6fbf54aeb57c2b3de5ce6d2e572725a1">drop\_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_1DropBackupResponse">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_1DropBackupResponse">Response</a> object containing the result of the operation (initially passed in by reference). </div>
      </div>
    </div>
  </div>
</div>