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

> gpudb::CreateDirectoryRequest — 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#ad932eb748735980773e9f45a50aaf818">GPUdb::createDirectory</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/create__directory_8h_source">gpudb/protocol/create\_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:af55e014d2f8e3b7c9e9b178de0305d52" id="r_af55e014d2f8e3b7c9e9b178de0305d52">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#af55e014d2f8e3b7c9e9b178de0305d52">CreateDirectoryRequest</a> ()</td>
      </tr>

      <tr className="memdesc:af55e014d2f8e3b7c9e9b178de0305d52">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1CreateDirectoryRequest" title="A set of parameters for GPUdb::createDirectory.">CreateDirectoryRequest</a> object with default parameters. <br /></td>
      </tr>

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

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

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

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

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

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

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

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

      <tr className="separator:a819bed96b2ecbd50223d686f0472b27f">
        <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#ad932eb748735980773e9f45a50aaf818">GPUdb::createDirectory</a>. </p>
      <p>Creates a new directory in <a href="/content/tools/kifs/" target="_top">KiFS</a>. The new directory serves as a location in which the user can upload files using <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#abf858a844a619c04135d680ce9a2fe4c">GPUdb::uploadFiles</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__directory_8h_source#l00022">22</a> of file <a className="el" href="/content/api/cpp/create__directory_8h_source">create\_directory.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#af55e014d2f8e3b7c9e9b178de0305d52">◆ </a></span>CreateDirectoryRequest() <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::CreateDirectoryRequest::CreateDirectoryRequest </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_1CreateDirectoryRequest" title="A set of parameters for GPUdb::createDirectory.">CreateDirectoryRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__directory_8h_source#l00027">27</a> of file <a className="el" href="/content/api/cpp/create__directory_8h_source">create\_directory.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aba8e95fb16f82a386533c839a2a3d752">◆ </a></span>CreateDirectoryRequest() <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::CreateDirectoryRequest::CreateDirectoryRequest </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_1CreateDirectoryRequest" title="A set of parameters for GPUdb::createDirectory.">CreateDirectoryRequest</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 created. </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#a6eea48ad93a90f8e00c194cfe87250d7">create\_directory\_create\_home\_directory</a>: When set, a home directory is created for the user name provided in the value. The <span className="em arg">directoryName\_</span> must be an empty string in this case. The user must exist. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4b6b939da3d5ca9fae8f0e262abe2497">create\_directory\_data\_limit</a>: The maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a0c2b822bf59c127ed06112f8e4fe90eb">create\_directory\_no\_error\_if\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a65fde3c9705cf756aa5f7115e18ca283">true</a>, does not return an error if the directory already exists. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a65fde3c9705cf756aa5f7115e18ca283">create\_directory\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8087053c4f1d8d6fc90cf27e01b1875f">create\_directory\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a8087053c4f1d8d6fc90cf27e01b1875f">create\_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/create__directory_8h_source#l00076">76</a> of file <a className="el" href="/content/api/cpp/create__directory_8h_source">create\_directory.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Name of the directory in KiFS to be created. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/create__directory_8h_source#l00085">85</a> of file <a className="el" href="/content/api/cpp/create__directory_8h_source">create\_directory.h</a>.</p>
      </div>
    </div>

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

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

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

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6eea48ad93a90f8e00c194cfe87250d7">create\_directory\_create\_home\_directory</a>: When set, a home directory is created for the user name provided in the value. The <a className="el" href="#ab86db72ef771382c6f87c1fe65a515a1">directoryName</a> must be an empty string in this case. The user must exist. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4b6b939da3d5ca9fae8f0e262abe2497">create\_directory\_data\_limit</a>: The maximum capacity, in bytes, to apply to the created directory. Set to -1 to indicate no upper limit. If empty, the system default limit is applied. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a0c2b822bf59c127ed06112f8e4fe90eb">create\_directory\_no\_error\_if\_exists</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a65fde3c9705cf756aa5f7115e18ca283">true</a>, does not return an error if the directory already exists. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a65fde3c9705cf756aa5f7115e18ca283">create\_directory\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8087053c4f1d8d6fc90cf27e01b1875f">create\_directory\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a8087053c4f1d8d6fc90cf27e01b1875f">create\_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/create__directory_8h_source#l00116">116</a> of file <a className="el" href="/content/api/cpp/create__directory_8h_source">create\_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/create__directory_8h_source">create\_directory.h</a></li>
    </ul>
  </div>
</div>