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

> gpudb::DeleteDirectoryRequest — 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#afe45987d438414b862ff310e0232e83e">GPUdb::deleteDirectory</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/delete__directory_8h_source">gpudb/protocol/delete\_directory.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:a55f26566ee6f823511139f17febfa067" id="r_a55f26566ee6f823511139f17febfa067">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a55f26566ee6f823511139f17febfa067">DeleteDirectoryRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a55f26566ee6f823511139f17febfa067">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1DeleteDirectoryRequest" title="A set of parameters for GPUdb::deleteDirectory.">DeleteDirectoryRequest</a> object with default parameters. <br /></td>
      </tr>

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

      <tr className="memitem:a79aeaa7f8c4887f32721249233396a80" id="r_a79aeaa7f8c4887f32721249233396a80">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a79aeaa7f8c4887f32721249233396a80">DeleteDirectoryRequest</a> (const std::string \&directoryName\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:a79aeaa7f8c4887f32721249233396a80">
        <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:a6660239ec10212b3d5297248df7da841" id="r_a6660239ec10212b3d5297248df7da841">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a6660239ec10212b3d5297248df7da841">directoryName</a></td>
      </tr>

      <tr className="memdesc:a6660239ec10212b3d5297248df7da841">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the directory in KiFS to be deleted. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a1f9bba9707392522340a3bea00724613">
        <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#afe45987d438414b862ff310e0232e83e">GPUdb::deleteDirectory</a>. </p>
      <p>Deletes a directory from <a href="/content/tools/kifs/" target="_top">KiFS</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/delete__directory_8h_source#l00019">19</a> of file <a className="el" href="/content/api/cpp/delete__directory_8h_source">delete\_directory.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a55f26566ee6f823511139f17febfa067">◆ </a></span>DeleteDirectoryRequest() <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::DeleteDirectoryRequest::DeleteDirectoryRequest </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_1DeleteDirectoryRequest" title="A set of parameters for GPUdb::deleteDirectory.">DeleteDirectoryRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/delete__directory_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/delete__directory_8h_source">delete\_directory.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a79aeaa7f8c4887f32721249233396a80">◆ </a></span>DeleteDirectoryRequest() <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::DeleteDirectoryRequest::DeleteDirectoryRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">directoryName\_</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_1DeleteDirectoryRequest" title="A set of parameters for GPUdb::deleteDirectory.">DeleteDirectoryRequest</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">directoryName\_</td>
                <td>Name of the directory in KiFS to be deleted. The directory must contain no files, unless <a className="el" href="/content/api/cpp/namespacegpudb#ac25d5650f68f2b9b33931f966c49555f">recursive</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">true</a>. </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#ac25d5650f68f2b9b33931f966c49555f">delete\_directory\_recursive</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">true</a>, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">delete\_directory\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#af326a5e14f6a21cfa77425ee79127247">delete\_directory\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#af326a5e14f6a21cfa77425ee79127247">delete\_directory\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#ac97ecd16041fcdea66f3e53f12c6553c">delete\_directory\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">true</a>, no error is returned if specified directory does not exist. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">delete\_directory\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#af326a5e14f6a21cfa77425ee79127247">delete\_directory\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#af326a5e14f6a21cfa77425ee79127247">delete\_directory\_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/delete__directory_8h_source#l00081">81</a> of file <a className="el" href="/content/api/cpp/delete__directory_8h_source">delete\_directory.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the directory in KiFS to be deleted. </p>
        <p>The directory must contain no files, unless <a className="el" href="/content/api/cpp/namespacegpudb#ac25d5650f68f2b9b33931f966c49555f">recursive</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">true</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/delete__directory_8h_source#l00092">92</a> of file <a className="el" href="/content/api/cpp/delete__directory_8h_source">delete\_directory.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ac25d5650f68f2b9b33931f966c49555f">delete\_directory\_recursive</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">true</a>, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">delete\_directory\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#af326a5e14f6a21cfa77425ee79127247">delete\_directory\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#af326a5e14f6a21cfa77425ee79127247">delete\_directory\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ac97ecd16041fcdea66f3e53f12c6553c">delete\_directory\_no\_error\_if\_not\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">true</a>, no error is returned if specified directory does not exist. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a620d2b4ef97df73c6d9e31e219f1ed42">delete\_directory\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#af326a5e14f6a21cfa77425ee79127247">delete\_directory\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#af326a5e14f6a21cfa77425ee79127247">delete\_directory\_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/delete__directory_8h_source#l00127">127</a> of file <a className="el" href="/content/api/cpp/delete__directory_8h_source">delete\_directory.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/delete__directory_8h_source">delete\_directory.h</a></li>
    </ul>
  </div>
</div>