Deploying to gh-pages from @ 5ef90c3 🚀

_modules/index.html

@@ -282,6 +282,7 @@ <h1>All modules for which code is available</h1>
 <ul><li><a href="exasol/bucketfs/_buckets.html">exasol.bucketfs._buckets</a></li>
 <li><a href="exasol/bucketfs/_convert.html">exasol.bucketfs._convert</a></li>
 <li><a href="exasol/bucketfs/_error.html">exasol.bucketfs._error</a></li>
+<li><a href="exasol/bucketfs/_path.html">exasol.bucketfs._path</a></li>
 <li><a href="exasol/bucketfs/_service.html">exasol.bucketfs._service</a></li>
 </ul>
         </article>

_sources/api.rst.txt

@@ -9,13 +9,45 @@ exasol.bucketfs.Service
    :undoc-members:
    :show-inheritance:
 
+exasol.bucketfs.BucketLike
+--------------------------
+.. autoclass:: exasol.bucketfs.BucketLike
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 exasol.bucketfs.Bucket
 -----------------------
 .. autoclass:: exasol.bucketfs.Bucket
    :members:
    :undoc-members:
    :show-inheritance:
 
+exasol.bucketfs.SaaSBucket
+--------------------------
+.. autoclass:: exasol.bucketfs.SaaSBucket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+exasol.bucketfs.MountedBucket
+-----------------------------
+.. autoclass:: exasol.bucketfs.MountedBucket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+exasol.bucketfs.path.PathLike
+-----------------------------
+.. autoclass:: exasol.bucketfs._path.PathLike
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+exasol.bucketfs.path.build_path
+-------------------------------
+.. autofunction:: exasol.bucketfs._path.build_path
+
 exasol.bucketfs.as_bytes
 ------------------------
 .. autofunction:: exasol.bucketfs.as_bytes

_sources/changes/unreleased.md.txt

@@ -11,3 +11,4 @@ The current release adds a dependency to plugin `pytest_exasol_saas` and replace
 ## Documentation
 
 * #144: Added comment on using fixtures from pytest-plugin `pytest-exasol-saas`
+* #147: Added documentation for the SaaS and the PathLike interface.

_sources/user_guide/basics.rst.txt

@@ -3,8 +3,8 @@ Basic's
 
 The Bucketfs Service
 --------------------
-A single bucketfs service can host multiple buckets. In order to interact with a bucketfs service one
-can use the :ref:`exasol.bucketfs.Service <api:exasol.bucketfs.Service>` class.
+In the On-Prem database, a single bucketfs service can host multiple buckets. In order to interact with a
+bucketfs service one can use the :ref:`exasol.bucketfs.Service <api:exasol.bucketfs.Service>` class.
 
 List buckets
 ++++++++++++
@@ -23,10 +23,16 @@ Get a Bucket reference
 
 
 Bucket class
--------------
+------------
 A Bucket contains a set of files which may be restricted, depending on the credentials of the requester.
-Using :ref:`exasol.bucketfs.Bucket <api:exasol.bucketfs.Bucket>` class the user can interact (download, upload, list and delete) files.
-with the files in the bucket.
+The Bucket class for an On-Prem database is :ref:`exasol.bucketfs.Bucket <api:exasol.bucketfs.Bucket>`.
+The correspondent class for a SaaS database is exasol.bucketfs.SaaSBucket.
+Using these classes the user can interact with the files in the bucket (download, upload, list and delete them).
+
+Most of the examples below are based on the On-Prem implementation of the BucketFS. In the SaaS implementation
+there is only one BucketFS service, providing a single bucket. To access the BucketFS in SaaS the Bucket
+object should be created directly, as it is demonstrated in the last example. The interface of the Bucket
+object for the SaaS database is identical to that of the On-Prem database.
 
 List files in a Bucket
 ++++++++++++++++++++++
@@ -73,6 +79,21 @@ Delete files from Bucket
    :language: python3
    :end-before: # Expert/Mapped bucket API
 
+Create bucket object in SaaS
+++++++++++++++++++++++++++++
+
+.. literalinclude:: /examples/bucket_saas.py
+   :language: python3
+
+PathLike interface
+------------------
+A PathLike is an interface similar to the pathlib.Path and should feel familiar to most users.
+
+Using the PathLike interface
+++++++++++++++++++++++++++++
+
+.. literalinclude:: /examples/path_like.py
+   :language: python3
 
 Configure logging
 +++++++++++++++++

_sources/user_guide/user_guide.rst.txt

@@ -6,10 +6,10 @@ Bucketfs
 Depending on the database configuration, the bucketfs setup can range from straight forward to fairly complex.
 This is due to the fact that:
 
-* Each database can have one or more BucketFS services
+* Each database can have one or more BucketFS services (in the On-Prem database)
 * Each BucketFS service is available on all worker cluster of a database
 * Each BucketFS service runs on all data nodes of a database
-* Each BucketFS service can have one or more Buckets
+* Each BucketFS service can have one or more Buckets (in the On-Prem database)
 * Each Bucket can hold one or more files
 
 The overview bellow tries to illustrate this in a more tangible manner.

changes/unreleased.html

@@ -301,6 +301,7 @@ <h2>Refactorings<a class="headerlink" href="#refactorings" title="Permalink to t
 <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading">¶</a></h2>
 <ul class="simple">
 <li><p>#144: Added comment on using fixtures from pytest-plugin <code class="docutils literal notranslate"><span class="pre">pytest-exasol-saas</span></code></p></li>
+<li><p>#147: Added documentation for the SaaS and the PathLike interface.</p></li>
 </ul>
 </section>
 </section>

genindex.html

@@ -280,18 +280,14 @@
 
 <section class="genindex-section">
   <h1 id="index">Index</h1>
-  <div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#U"><strong>U</strong></a></div>
+  <div class="genindex-jumpbox"><a href="#_"><strong>_</strong></a> | <a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#J"><strong>J</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#W"><strong>W</strong></a></div>
 </section>
 <section id="_" class="genindex-section">
   <h2>_</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="api.html#exasol.bucketfs.Bucket.__init__">__init__() (exasol.bucketfs.Bucket method)</a>
-
-        <ul>
-          <li><a href="api.html#exasol.bucketfs.MappedBucket.__init__">(exasol.bucketfs.MappedBucket method)</a>
+        <li><a href="api.html#exasol.bucketfs.MappedBucket.__init__">__init__() (exasol.bucketfs.MappedBucket method)</a>
 </li>
-        </ul></li>
     </ul></td>
   </tr></table>
 </section>
@@ -304,11 +300,15 @@ <h2>A</h2>
 </li>
         <li><a href="api.html#exasol.bucketfs.as_file">as_file() (in module exasol.bucketfs)</a>
 </li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api.html#exasol.bucketfs.as_hash">as_hash() (in module exasol.bucketfs)</a>
 </li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api.html#exasol.bucketfs.as_string">as_string() (in module exasol.bucketfs)</a>
+</li>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.as_udf_path">as_udf_path() (exasol.bucketfs._path.PathLike method)</a>
+</li>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.as_uri">as_uri() (exasol.bucketfs._path.PathLike method)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -319,10 +319,14 @@ <h2>B</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api.html#exasol.bucketfs.Bucket">Bucket (class in exasol.bucketfs)</a>
+</li>
+        <li><a href="api.html#exasol.bucketfs.BucketFsError">BucketFsError</a>
 </li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="api.html#exasol.bucketfs.BucketFsError">BucketFsError</a>
+        <li><a href="api.html#exasol.bucketfs.BucketLike">BucketLike (class in exasol.bucketfs)</a>
+</li>
+        <li><a href="api.html#exasol.bucketfs._path.build_path">build_path() (in module exasol.bucketfs._path)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -343,10 +347,36 @@ <h2>D</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api.html#exasol.bucketfs.Bucket.delete">delete() (exasol.bucketfs.Bucket method)</a>
+
+        <ul>
+          <li><a href="api.html#exasol.bucketfs.BucketLike.delete">(exasol.bucketfs.BucketLike method)</a>
 </li>
+          <li><a href="api.html#exasol.bucketfs.MountedBucket.delete">(exasol.bucketfs.MountedBucket method)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.SaaSBucket.delete">(exasol.bucketfs.SaaSBucket method)</a>
+</li>
+        </ul></li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api.html#exasol.bucketfs.Bucket.download">download() (exasol.bucketfs.Bucket method)</a>
+
+        <ul>
+          <li><a href="api.html#exasol.bucketfs.BucketLike.download">(exasol.bucketfs.BucketLike method)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.MountedBucket.download">(exasol.bucketfs.MountedBucket method)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.SaaSBucket.download">(exasol.bucketfs.SaaSBucket method)</a>
+</li>
+        </ul></li>
+    </ul></td>
+  </tr></table>
+</section>
+
+<section id="E" class="genindex-section">
+  <h2>E</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.exists">exists() (exasol.bucketfs._path.PathLike method)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -357,6 +387,40 @@ <h2>F</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api.html#exasol.bucketfs.Bucket.files">files (exasol.bucketfs.Bucket property)</a>
+
+        <ul>
+          <li><a href="api.html#exasol.bucketfs.BucketLike.files">(exasol.bucketfs.BucketLike property)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.MountedBucket.files">(exasol.bucketfs.MountedBucket property)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.SaaSBucket.files">(exasol.bucketfs.SaaSBucket property)</a>
+</li>
+        </ul></li>
+    </ul></td>
+  </tr></table>
+</section>
+
+<section id="I" class="genindex-section">
+  <h2>I</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.is_dir">is_dir() (exasol.bucketfs._path.PathLike method)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.is_file">is_file() (exasol.bucketfs._path.PathLike method)</a>
+</li>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.iterdir">iterdir() (exasol.bucketfs._path.PathLike method)</a>
+</li>
+    </ul></td>
+  </tr></table>
+</section>
+
+<section id="J" class="genindex-section">
+  <h2>J</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.joinpath">joinpath() (exasol.bucketfs._path.PathLike method)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -367,6 +431,10 @@ <h2>M</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api.html#exasol.bucketfs.MappedBucket">MappedBucket (class in exasol.bucketfs)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs.MountedBucket">MountedBucket (class in exasol.bucketfs)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -376,7 +444,63 @@ <h2>M</h2>
   <h2>N</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="api.html#exasol.bucketfs.Bucket.name">name (exasol.bucketfs.Bucket property)</a>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.name">name (exasol.bucketfs._path.PathLike property)</a>
+
+        <ul>
+          <li><a href="api.html#exasol.bucketfs.Bucket.name">(exasol.bucketfs.Bucket property)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.BucketLike.name">(exasol.bucketfs.BucketLike property)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.MountedBucket.name">(exasol.bucketfs.MountedBucket property)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.SaaSBucket.name">(exasol.bucketfs.SaaSBucket property)</a>
+</li>
+        </ul></li>
+    </ul></td>
+  </tr></table>
+</section>
+
+<section id="P" class="genindex-section">
+  <h2>P</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.parent">parent (exasol.bucketfs._path.PathLike property)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike">PathLike (class in exasol.bucketfs._path)</a>
+</li>
+    </ul></td>
+  </tr></table>
+</section>
+
+<section id="R" class="genindex-section">
+  <h2>R</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.read">read() (exasol.bucketfs._path.PathLike method)</a>
+</li>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.rm">rm() (exasol.bucketfs._path.PathLike method)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.rmdir">rmdir() (exasol.bucketfs._path.PathLike method)</a>
+</li>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.root">root (exasol.bucketfs._path.PathLike property)</a>
+</li>
+    </ul></td>
+  </tr></table>
+</section>
+
+<section id="S" class="genindex-section">
+  <h2>S</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs.SaaSBucket">SaaSBucket (class in exasol.bucketfs)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.suffix">suffix (exasol.bucketfs._path.PathLike property)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -387,10 +511,40 @@ <h2>U</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api.html#exasol.bucketfs.Bucket.udf_path">udf_path (exasol.bucketfs.Bucket property)</a>
+
+        <ul>
+          <li><a href="api.html#exasol.bucketfs.BucketLike.udf_path">(exasol.bucketfs.BucketLike property)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.MountedBucket.udf_path">(exasol.bucketfs.MountedBucket property)</a>
 </li>
+          <li><a href="api.html#exasol.bucketfs.SaaSBucket.udf_path">(exasol.bucketfs.SaaSBucket property)</a>
+</li>
+        </ul></li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="api.html#exasol.bucketfs.Bucket.upload">upload() (exasol.bucketfs.Bucket method)</a>
+
+        <ul>
+          <li><a href="api.html#exasol.bucketfs.BucketLike.upload">(exasol.bucketfs.BucketLike method)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.MountedBucket.upload">(exasol.bucketfs.MountedBucket method)</a>
+</li>
+          <li><a href="api.html#exasol.bucketfs.SaaSBucket.upload">(exasol.bucketfs.SaaSBucket method)</a>
+</li>
+        </ul></li>
+    </ul></td>
+  </tr></table>
+</section>
+
+<section id="W" class="genindex-section">
+  <h2>W</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.walk">walk() (exasol.bucketfs._path.PathLike method)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="api.html#exasol.bucketfs._path.PathLike.write">write() (exasol.bucketfs._path.PathLike method)</a>
 </li>
     </ul></td>
   </tr></table>