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

# gpudbfilehandler

> gpudbfilehandler — Kinetica Python API

<div className="kinetica-pydoc">
  <div itemprop="articleBody">
    <div id="class-gpudbfilehandler" className="section">
      <h1>Class GPUdbFileHandler</h1>

      <div className="dl py class">
        <div className="dt sig sig-object py" id="gpudb.GPUdbFileHandler"> <span className="em property"><span className="k"><span className="pre">class</span></span><span className="w"> </span></span><span className="sig-prename descclassname"><span className="pre">gpudb.</span></span><span className="sig-name descname"><span className="pre">GPUdbFileHandler</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">db</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><a className="reference internal" href="/content/api/python/source/gpudb#gpudb.GPUdb" title="gpudb.GPUdb"><span className="pre">GPUdb</span></a></span></span><span className="sig-paren">)</span></div>

        <div className="dd">
          <p>This class exposes convenience methods to upload/download files to/from KIFS from local/KIFS directory.</p>

          <div id="methods" className="section">
            <h2>Methods</h2>

            <ol className="arabic simple">
              <li>
                <p>upload\_files - Upload a list of files - <a className="reference internal" href="#gpudb.GPUdbFileHandler.upload_files" title="gpudb.GPUdbFileHandler.upload_files"><code className="xref py py-meth docutils literal notranslate"><span className="pre">upload\_files()</span></code></a></p>
              </li>

              <li>
                <p>upload\_file - Upload a single file - <a className="reference internal" href="#gpudb.GPUdbFileHandler.upload_file" title="gpudb.GPUdbFileHandler.upload_file"><code className="xref py py-meth docutils literal notranslate"><span className="pre">upload\_file()</span></code></a></p>
              </li>

              <li>
                <p>download\_files - Download a list of files - <a className="reference internal" href="#gpudb.GPUdbFileHandler.download_files" title="gpudb.GPUdbFileHandler.download_files"><code className="xref py py-meth docutils literal notranslate"><span className="pre">download\_files()</span></code></a></p>
              </li>

              <li>
                <p>download\_file - Download a single file - <a className="reference internal" href="#gpudb.GPUdbFileHandler.download_file" title="gpudb.GPUdbFileHandler.download_file"><code className="xref py py-meth docutils literal notranslate"><span className="pre">download\_file()</span></code></a></p>
              </li>
            </ol>

            <p>Example</p>

            <div className="highlight-default notranslate">
              ```
              file_handler = GPUdbFileHandler.from_url_info(host = "http://127.0.0.1.2:9191", username="user", password="password")
              file_handler.upload_file(file_name="/home/user/some_file_name", kifs_path="~anonymous")
              file_handler.download_file(file_name="~anonymous/some_file_name", local_dir="/home/user/download")
              ```
            </div>

            <p>Initialize a <a className="reference internal" href="#gpudb.GPUdbFileHandler" title="gpudb.GPUdbFileHandler"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdbFileHandler</span></code></a>.</p>
            <p><strong>Parameters</strong></p>

            <blockquote>
              <div>
                <div className="dl simple">
                  <div className="dt">db (<span className="em">GPUdb</span>) –</div>

                  <div className="dd">
                    <p>A <a className="reference internal" href="/content/api/python/source/gpudb#gpudb.GPUdb" title="gpudb.GPUdb"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdb</span></code></a> instance</p>
                  </div>
                </div>
              </div>
            </blockquote>

            <div className="dl py method">
              <div className="dt sig sig-object py" id="gpudb.GPUdbFileHandler.from_url_info"> <span className="em property"><span className="k"><span className="pre">classmethod</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">from\_url\_info</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">host</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span><span className="w"> </span><span className="o"><span className="pre">=</span></span><span className="w"> </span><span className="default_value"><span className="pre">'[http://127.0.0.1:9191](http://127.0.0.1:9191)'</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">username</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span><span className="w"> </span><span className="o"><span className="pre">=</span></span><span className="w"> </span><span className="default_value"><span className="pre">None</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">password</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span><span className="w"> </span><span className="o"><span className="pre">=</span></span><span className="w"> </span><span className="default_value"><span className="pre">None</span></span></span><span className="sig-paren">)</span></div>

              <div className="dd">
                <p>Create a <a className="reference internal" href="#gpudb.GPUdbFileHandler" title="gpudb.GPUdbFileHandler"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdbFileHandler</span></code></a> instance from a host URL, user name, and password.</p>
                <p><strong>Parameters</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">host (<span className="em">str, optional</span>) –</div>

                      <div className="dd">
                        <p>A Kinetica host URL. Defaults to “<a className="reference external" href="http://127.0.0.1:9191">[http://127.0.0.1:9191](http://127.0.0.1:9191)</a>”.</p>
                      </div>

                      <div className="dt">username (<span className="em">str, optional</span>) –</div>

                      <div className="dd">
                        <p>Kinetica user name. Defaults to None.</p>
                      </div>

                      <div className="dt">password (<span className="em">str, optional</span>) –</div>

                      <div className="dd">
                        <p>Password for the user. Defaults to None.</p>
                      </div>
                    </div>
                  </div>
                </blockquote>

                <p><strong>Returns</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">GPUdbFileHandler –</div>

                      <div className="dd">
                        <p>a <a className="reference internal" href="#gpudb.GPUdbFileHandler" title="gpudb.GPUdbFileHandler"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdbFileHandler</span></code></a> instance</p>
                      </div>
                    </div>
                  </div>
                </blockquote>
              </div>
            </div>

            <div className="dl py method">
              <div className="dt sig sig-object py" id="gpudb.GPUdbFileHandler.from_db_instance"> <span className="em property"><span className="k"><span className="pre">classmethod</span></span><span className="w"> </span></span><span className="sig-name descname"><span className="pre">from\_db\_instance</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">db</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><a className="reference internal" href="/content/api/python/source/gpudb#gpudb.GPUdb" title="gpudb.GPUdb"><span className="pre">GPUdb</span></a></span></span><span className="sig-paren">)</span></div>

              <div className="dd">
                <p>Create a <a className="reference internal" href="#gpudb.GPUdbFileHandler" title="gpudb.GPUdbFileHandler"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdbFileHandler</span></code></a> from a <a className="reference internal" href="/content/api/python/source/gpudb#gpudb.GPUdb" title="gpudb.GPUdb"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdb</span></code></a> instance.</p>
                <p><strong>Parameters</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">db (<span className="em">GPUdb</span>) –</div>

                      <div className="dd">
                        <p>a <a className="reference internal" href="/content/api/python/source/gpudb#gpudb.GPUdb" title="gpudb.GPUdb"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdb</span></code></a> instance</p>
                      </div>
                    </div>
                  </div>
                </blockquote>

                <p><strong>Returns</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">GPUdbFileHandler –</div>

                      <div className="dd">
                        <p>a <a className="reference internal" href="#gpudb.GPUdbFileHandler" title="gpudb.GPUdbFileHandler"><code className="xref py py-class docutils literal notranslate"><span className="pre">GPUdbFileHandler</span></code></a> instance</p>
                      </div>
                    </div>
                  </div>
                </blockquote>
              </div>
            </div>

            <div className="dl py method">
              <div className="dt sig sig-object py" id="gpudb.GPUdbFileHandler.upload_file"> <span className="sig-name descname"><span className="pre">upload\_file</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">file\_name</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">kifs\_path</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span></span><span className="sig-paren">)</span> <span className="sig-return"><span className="sig-return-icon">→</span> <span className="sig-return-typehint"><span className="pre">None</span></span></span></div>

              <div className="dd">
                <p>Upload a single file to a KIFS directory.</p>
                <p><strong>Parameters</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">file\_name (<span className="em">str</span>) –</div>

                      <div className="dd">
                        <p>Full path to the local file to upload</p>
                      </div>

                      <div className="dt">kifs\_path (<span className="em">str</span>) –</div>

                      <div className="dd">
                        <p>A KIFS directory to upload (must be existing)</p>
                      </div>
                    </div>
                  </div>
                </blockquote>
              </div>
            </div>

            <div className="dl py method">
              <div className="dt sig sig-object py" id="gpudb.GPUdbFileHandler.upload_files"> <span className="sig-name descname"><span className="pre">upload\_files</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">file\_names</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">list</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">kifs\_path</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span></span><span className="sig-paren">)</span> <span className="sig-return"><span className="sig-return-icon">→</span> <span className="sig-return-typehint"><span className="pre">None</span></span></span></div>

              <div className="dd">
                <p>Upload a list of files to a KIFS directory.</p>
                <p><strong>Parameters</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">file\_names (<span className="em">list</span>) –</div>

                      <div className="dd">
                        <p>List of full local file paths</p>
                      </div>

                      <div className="dt">kifs\_path (<span className="em">str</span>) –</div>

                      <div className="dd">
                        <p>Name of an existent KIFS directory</p>
                      </div>
                    </div>
                  </div>
                </blockquote>
              </div>
            </div>

            <div className="dl py method">
              <div className="dt sig sig-object py" id="gpudb.GPUdbFileHandler.download_file"> <span className="sig-name descname"><span className="pre">download\_file</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">file\_name</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">local\_dir</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span></span><span className="sig-paren">)</span> <span className="sig-return"><span className="sig-return-icon">→</span> <span className="sig-return-typehint"><span className="pre">None</span></span></span></div>

              <div className="dd">
                <div className="dl simple">
                  <div className="dt">Download a single file to a local directory.</div>

                  <div className="dd">
                    <p>A large file greater than 60MB in size will be downloaded in parts.</p>
                  </div>
                </div>

                <p><strong>Parameters</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">file\_name (<span className="em">str</span>) –</div>

                      <div className="dd">
                        <p>Name of the file to download (full KIFS path)</p>
                      </div>

                      <div className="dt">local\_dir (<span className="em">str</span>) –</div>

                      <div className="dd">
                        <p>Name of the local directory to save the file in</p>
                      </div>
                    </div>
                  </div>
                </blockquote>

                <p><strong>Raises</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">gpudb.GPUdbException –</div>

                      <div className="dd">
                        <p>In case of an exception thrown by the server or in case the local directory doesn’t exist</p>
                      </div>
                    </div>
                  </div>
                </blockquote>
              </div>
            </div>

            <div className="dl py method">
              <div className="dt sig sig-object py" id="gpudb.GPUdbFileHandler.download_files"> <span className="sig-name descname"><span className="pre">download\_files</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">file\_names</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">list</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">local\_dir</span></span><span className="p"><span className="pre">:</span></span><span className="w"> </span><span className="n"><span className="pre">str</span></span></span><span className="sig-paren">)</span> <span className="sig-return"><span className="sig-return-icon">→</span> <span className="sig-return-typehint"><span className="pre">None</span></span></span></div>

              <div className="dd">
                <p>Download a list of files from KIFS.</p>
                <p><strong>Parameters</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">file\_names (<span className="em">list</span>) –</div>

                      <div className="dd">
                        <p>A list of file names (full KIFS paths)</p>
                      </div>

                      <div className="dt">local\_dir (<span className="em">str</span>) –</div>

                      <div className="dd">
                        <p>Name of the local directory to save the files in</p>
                      </div>
                    </div>
                  </div>
                </blockquote>

                <p><strong>Raises</strong></p>

                <blockquote>
                  <div>
                    <div className="dl simple">
                      <div className="dt">gpudb.GPUdbException –</div>

                      <div className="dd">
                        <p>In case of an exception thrown by the server or in case the local directory doesn’t exist</p>
                      </div>
                    </div>
                  </div>
                </blockquote>
              </div>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>
