> ## 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::DropBackupRequest

> gpudb::DropBackupRequest — 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#aa6f1b56740a5cc4a68fb18396971e2cb">GPUdb::dropBackup</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/drop__backup_8h_source">gpudb/protocol/drop\_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:a6b9c8728b8bb98501b80fefc0baa7236" id="r_a6b9c8728b8bb98501b80fefc0baa7236">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a6b9c8728b8bb98501b80fefc0baa7236">DropBackupRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a6b9c8728b8bb98501b80fefc0baa7236">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1DropBackupRequest" title="A set of parameters for GPUdb::dropBackup.">DropBackupRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a7ee3eab3d73df40b954f6e7e118fc1f6">
        <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:a18edcdcc3aca4560e3a890967c8ec9d4" id="r_a18edcdcc3aca4560e3a890967c8ec9d4">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a18edcdcc3aca4560e3a890967c8ec9d4">backupName</a></td>
      </tr>

      <tr className="memdesc:a18edcdcc3aca4560e3a890967c8ec9d4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the backup to be deleted. <br /></td>
      </tr>

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

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

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

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

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

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

      <tr className="separator:a4d21670f2ed6827ba7b42d79112efb01">
        <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#aa6f1b56740a5cc4a68fb18396971e2cb">GPUdb::dropBackup</a>. </p>
      <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="#a4b5c92fb561b0e6d2a480f95cf678a6f">datasinkName</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__backup_8h_source#l00021">21</a> of file <a className="el" href="/content/api/cpp/drop__backup_8h_source">drop\_backup.h</a>.</p>
    </div>

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

    <h2 className="memtitle"><span className="permalink"><a href="#a7ee3eab3d73df40b954f6e7e118fc1f6">◆ </a></span>DropBackupRequest() <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::DropBackupRequest::DropBackupRequest </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>
              </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_1DropBackupRequest" title="A set of parameters for GPUdb::dropBackup.">DropBackupRequest</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 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>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__backup_8h_source#l00097">97</a> of file <a className="el" href="/content/api/cpp/drop__backup_8h_source">drop\_backup.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the backup to be deleted. </p>
        <p>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>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__backup_8h_source#l00111">111</a> of file <a className="el" href="/content/api/cpp/drop__backup_8h_source">drop\_backup.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4b5c92fb561b0e6d2a480f95cf678a6f">◆ </a></span>datasinkName</h2>

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

      <div className="memdoc">
        <p>Data sink through which the backup is accessible. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__backup_8h_source#l00116">116</a> of file <a className="el" href="/content/api/cpp/drop__backup_8h_source">drop\_backup.h</a>.</p>
      </div>
    </div>

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

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

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

        <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 <a className="el" href="#a18edcdcc3aca4560e3a890967c8ec9d4">backupName</a>. 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>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/drop__backup_8h_source#l00154">154</a> of file <a className="el" href="/content/api/cpp/drop__backup_8h_source">drop\_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/drop__backup_8h_source">drop\_backup.h</a></li>
    </ul>
  </div>
</div>