diff --git a/.doctrees/changes/unreleased.doctree b/.doctrees/changes/unreleased.doctree
index 4b2ec140..f5a92d0e 100644
Binary files a/.doctrees/changes/unreleased.doctree and b/.doctrees/changes/unreleased.doctree differ
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
index 6d3b5533..8716f333 100644
Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ
diff --git a/_modules/exasol/bucketfs/_path.html b/_modules/exasol/bucketfs/_path.html
index e5848fc1..9cce38ea 100644
--- a/_modules/exasol/bucketfs/_path.html
+++ b/_modules/exasol/bucketfs/_path.html
@@ -684,6 +684,11 @@ <h1>Source code for exasol.bucketfs._path</h1><div class="highlight"><pre>
         <span class="n">new_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">/</span> <span class="p">(</span><span class="n">other</span><span class="o">.</span><span class="n">_path</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="bp">cls</span><span class="p">)</span> <span class="k">else</span> <span class="n">other</span><span class="p">)</span>
         <span class="k">return</span> <span class="bp">cls</span><span class="p">(</span><span class="n">new_path</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bucket_api</span><span class="p">)</span>
 
+    <span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">BucketPath</span><span class="p">):</span>
+            <span class="k">return</span> <span class="kc">False</span>
+        <span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_bucket_api</span><span class="p">)</span> <span class="o">==</span> <span class="p">(</span><span class="n">other</span><span class="o">.</span><span class="n">_path</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">_bucket_api</span><span class="p">)</span>
+
     <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="p">)</span>
 
diff --git a/_sources/changes/unreleased.md.txt b/_sources/changes/unreleased.md.txt
index 79e701b8..5c463342 100644
--- a/_sources/changes/unreleased.md.txt
+++ b/_sources/changes/unreleased.md.txt
@@ -1 +1,5 @@
 # Unreleased
+
+## Bugfixes
+
+* #158: Implemented operator `__eq__` for BucketPath to compare string representation
diff --git a/changes/unreleased.html b/changes/unreleased.html
index 4ecc2043..2f5e9721 100644
--- a/changes/unreleased.html
+++ b/changes/unreleased.html
@@ -192,7 +192,7 @@
           <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
         </button>
       </div>
-      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
         <div class="visually-hidden">Toggle table of contents sidebar</div>
         <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
       </label>
@@ -281,7 +281,7 @@
               <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
             </button>
           </div>
-          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
             <div class="visually-hidden">Toggle table of contents sidebar</div>
             <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
           </label>
@@ -289,6 +289,12 @@
         <article role="main" id="furo-main-content">
           <section id="unreleased">
 <h1>Unreleased<a class="headerlink" href="#unreleased" title="Permalink to this heading">¶</a></h1>
+<section id="bugfixes">
+<h2>Bugfixes<a class="headerlink" href="#bugfixes" title="Permalink to this heading">¶</a></h2>
+<ul class="simple">
+<li><p>#158: Implemented operator <code class="docutils literal notranslate"><span class="pre">__eq__</span></code> for BucketPath to compare string representation</p></li>
+</ul>
+</section>
 </section>
 
         </article>
@@ -334,8 +340,27 @@ <h1>Unreleased<a class="headerlink" href="#unreleased" title="Permalink to this
         
       </footer>
     </div>
-    <aside class="toc-drawer no-toc">
+    <aside class="toc-drawer">
+      
       
+      <div class="toc-sticky toc-scroll">
+        <div class="toc-title-container">
+          <span class="toc-title">
+            On this page
+          </span>
+        </div>
+        <div class="toc-tree-container">
+          <div class="toc-tree">
+            <ul>
+<li><a class="reference internal" href="#">Unreleased</a><ul>
+<li><a class="reference internal" href="#bugfixes">Bugfixes</a></li>
+</ul>
+</li>
+</ul>
+
+          </div>
+        </div>
+      </div>
       
       
     </aside>
diff --git a/objects.inv b/objects.inv
index fafbac1e..5dcd4bd1 100644
Binary files a/objects.inv and b/objects.inv differ
diff --git a/searchindex.js b/searchindex.js
index 4419af17..67b5ba84 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api", "changes/changelog", "changes/changes_0.1.0", "changes/changes_0.10.0", "changes/changes_0.11.0", "changes/changes_0.12.0", "changes/changes_0.13.0", "changes/changes_0.2.0", "changes/changes_0.3.0", "changes/changes_0.4.0", "changes/changes_0.5.0", "changes/changes_0.6.0", "changes/changes_0.7.0", "changes/changes_0.8.0", "changes/changes_0.9.0", "changes/unreleased", "design/bucketpath", "design/design", "developer_guide/developer_guide", "index", "user_guide/advanced", "user_guide/basics", "user_guide/upload_github_release_to_bucket", "user_guide/user_guide"], "filenames": ["api.rst", "changes/changelog.md", "changes/changes_0.1.0.md", "changes/changes_0.10.0.md", "changes/changes_0.11.0.md", "changes/changes_0.12.0.md", "changes/changes_0.13.0.md", "changes/changes_0.2.0.md", "changes/changes_0.3.0.md", "changes/changes_0.4.0.md", "changes/changes_0.5.0.md", "changes/changes_0.6.0.md", "changes/changes_0.7.0.md", "changes/changes_0.8.0.md", "changes/changes_0.9.0.md", "changes/unreleased.md", "design/bucketpath.rst", "design/design.rst", "developer_guide/developer_guide.rst", "index.rst", "user_guide/advanced.rst", "user_guide/basics.rst", "user_guide/upload_github_release_to_bucket.rst", "user_guide/user_guide.rst"], "titles": ["\ud83e\uddf0 API Reference", "\ud83d\udcdd Changes", "BucketFs Utils Python 0.1.0, released 2022-01-18", "BucketFs Python 0.10.0, released 2024-05-15", "0.11.0 - 2024-05-23", "0.12.0 - 2024-07-11", "0.13.0 - 2024-08-07", "BucketFs Utils Python 0.2.0, released 2022-04-29", "BucketFs Utils Python 0.3.0, released 2022-07-20", "BucketFs Python 0.4.0, released 2022-09-28", "BucketFs Python 0.5.0, released 2022-10-12", "BucketFs Python 0.6.0, released 2022-11-11", "BucketFs Python 0.7.0, released 2022-12-22", "BucketFs Python 0.8.0, released 2023-03-21", "BucketFs Python 0.9.0, released 2024-02-16", "Unreleased", "Design Document Bucket Path(s)", "\ud83d\udcd1 Design Documents", "\ud83d\udee0 Developer Guide", "Exasol Bucketfs", "Advanced", "Basic\u2019s", "Github Artifacts", "\ud83d\udc64 User Guide"], "terms": {"class": [0, 16], "url": [0, 9, 20, 21, 23], "str": [0, 16], "credenti": [0, 16, 20, 21, 23], "map": 0, "none": [0, 9, 16], "verifi": [0, 3, 21], "bool": [0, 16], "true": [0, 16, 21], "service_nam": [0, 21], "sourc": [0, 7, 8, 22], "base": [0, 3, 16, 21], "object": [0, 2, 3, 16, 20], "provid": [0, 2, 5, 11, 16, 20, 21], "simpl": [0, 16], "us": [0, 3, 4, 5, 7, 11, 13, 16, 18, 22], "access": [0, 10, 16, 21], "list": [0, 7, 8, 10, 16, 19, 23], "all": [0, 10, 16, 19, 20, 21, 23], "avail": [0, 10, 11, 18, 23], "__init__": [0, 16], "creat": [0, 16], "new": [0, 7, 9, 11, 16, 18], "instanc": [0, 18], "paramet": [0, 3, 16, 18, 21], "e": [0, 13, 16, 18], "g": [0, 13, 16, 18], "http": [0, 16, 20, 21, 22, 23], "": [0, 9, 11, 17, 19, 22, 23], "127": [0, 16], "0": [0, 1, 16, 20, 21, 23], "1": [0, 1, 3, 9, 16, 18, 20, 23], "2580": 0, "A": [0, 16, 21], "contain": [0, 2, 18, 21], "usernam": [0, 20, 21, 23], "password": [0, 20, 21, 22, 23], "bucket1": 0, "foo": 0, "bar": 0, "either": [0, 16], "boolean": 0, "which": [0, 11, 16, 18, 20, 21], "case": [0, 3, 16, 18, 20, 21], "control": 0, "whether": 0, "we": [0, 7, 13, 16, 21], "server": 0, "tl": [0, 14], "certif": 0, "string": [0, 2, 7, 9, 16, 20, 21], "must": [0, 16, 18], "ca": 0, "bundl": 0, "default": [0, 16, 20, 21, 23], "option": [0, 16, 21], "name": [0, 2, 7, 8, 9, 16, 18, 21], "properti": [0, 16], "mutablemap": 0, "arg": [0, 16], "kwarg": [0, 16], "protocol": [0, 3, 16], "definit": [0, 16, 21], "interfac": [0, 3, 5], "It": [0, 2, 16, 20, 21], "i": [0, 2, 4, 8, 11, 16, 18, 19, 20, 21, 23], "compat": [0, 16], "both": [0, 16, 18], "premis": 0, "an": [0, 4, 9, 16, 21, 22], "saa": [0, 3, 5, 18], "system": [0, 2, 3, 14, 16], "delet": [0, 7, 16, 18, 19, 23], "file": [0, 2, 7, 16, 18, 19, 22, 23], "q": 0, "what": [0, 16], "happen": 0, "doesn": [0, 21], "t": [0, 16, 21], "exist": [0, 11, 16, 21], "doe": [0, 11, 16], "noth": [0, 16], "error": [0, 16], "point": [0, 16], "directori": [0, 3, 16, 21], "same": [0, 21], "There": [0, 16], "ar": [0, 8, 16, 18, 20, 21, 23], "henc": [0, 13], "just": [0, 3, 16], "non": [0, 16], "download": [0, 2, 19, 23], "chunk_siz": [0, 16], "int": [0, 16], "8192": [0, 16], "iter": [0, 16, 21], "bytestr": [0, 16, 21], "from": [0, 2, 3, 5, 7, 8, 16, 18, 19, 22, 23], "The": [0, 3, 5, 11, 16, 19, 23], "content": [0, 16, 20, 21, 23], "chunk": [0, 16, 21], "specifi": [0, 16, 21], "size": 0, "full": 0, "can": [0, 2, 3, 16, 18, 19, 21, 22, 23], "construct": 0, "code": [0, 2, 7, 8, 11, 12, 16], "similar": [0, 16, 21], "line": 0, "below": [0, 5, 18, 21], "b": [0, 20, 21, 23], "join": [0, 16, 21], "download_fil": 0, "should": [0, 3, 16, 18, 20, 21], "deliv": 0, "rais": [0, 16, 21], "sinc": [0, 21], "return": [0, 16, 21], "over": [0, 2, 16, 21], "usag": [0, 16, 21], "exampl": [0, 12, 14, 18, 21, 22, 23], "print": [0, 21], "bucket_api": 0, "output": 0, "dir1": 0, "subdir1": 0, "file1": [0, 20, 21], "dat": 0, "subdir2": 0, "file2": [0, 20, 21], "txt": [0, 20, 21, 23], "note": [0, 16, 20, 21], "look": [0, 21, 23], "like": [0, 13, 16, 20, 21], "abov": [0, 16], "posix": 0, "style": 0, "backslash": 0, "start": [0, 18], "end": [0, 16], "udf_path": [0, 16], "seen": [0, 21], "udf": [0, 2, 8, 9, 16, 21], "upload": [0, 2, 8, 18, 19, 22, 23], "data": [0, 16, 20, 21, 23], "binaryio": [0, 16], "where": [0, 16, 20, 21], "binari": 0, "arrai": 0, "stream": 0, "open": [0, 18, 20, 21, 22], "mode": [0, 16], "parent": [0, 6, 16, 21], "miss": 0, "care": 0, "about": 0, "structur": [0, 11, 16], "prospect": 0, "realiti": 0, "store": [0, 21], "index": 0, "That": 0, "fine": 0, "updat": [0, 3, 4, 5, 9, 12, 13, 14, 18], "how": [0, 10], "ani": [0, 16, 21], "ntf": 0, "invalid": [0, 12], "charact": 0, "have": [0, 13, 16, 18, 21, 23], "lead": [0, 18], "subsequ": [0, 16], "remov": [0, 2, 4, 7, 8, 11, 16], "If": [0, 16, 21], "conform": 0, "thi": [0, 2, 7, 8, 11, 16, 18, 20, 21, 22, 23], "format": 0, "implement": [0, 2, 3, 6, 16, 21], "On": [0, 18, 21, 23], "databas": [0, 16, 18, 21, 23], "host": [0, 21, 22], "authent": 0, "account_id": [0, 21], "database_id": [0, 21], "pat": [0, 21], "user": [0, 12, 13, 16, 21, 22], "account": 0, "id": 0, "person": 0, "token": 0, "bfsdefault": [0, 21], "bucket_nam": [0, 21], "base_path": [0, 9], "back": [0, 21], "normal": 0, "target": 0, "instead": 0, "one": [0, 16, 21, 22, 23], "root": [0, 3, 16, 20], "test": [0, 5, 9], "when": [0, 16, 21], "backend": [0, 21], "local": [0, 2, 16, 18, 21], "set": [0, 16, 20, 21], "_path": 0, "view": [0, 3], "as_udf_path": [0, 4, 16, 21], "method": [0, 7, 8, 9, 16, 21], "specif": [0, 7, 16], "flavour": [0, 3], "correspond": [0, 21], "as_uri": [0, 16], "repres": [0, 16], "uri": [0, 16], "reconstruct": [0, 16], "locat": [0, 2, 16, 18], "is_dir": [0, 16, 21], "fals": [0, 16, 21], "anoth": [0, 16, 21], "kind": [0, 16], "is_fil": [0, 16, 21], "regular": [0, 16, 18], "iterdir": [0, 16, 21], "gener": [0, 8, 9, 16, 20, 21], "yield": [0, 16], "direct": [0, 16], "children": [0, 16], "joinpath": [0, 9, 16], "path_seg": 0, "call": [0, 16, 21], "equival": [0, 16], "combin": [0, 16], "each": [0, 16, 18, 21, 23], "given": [0, 16], "segment": 0, "turn": [0, 16], "final": [0, 16, 18, 21], "compon": [0, 16], "exclud": [0, 16], "drive": [0, 16], "logic": [0, 16], "read": [0, 2, 16, 21], "behind": [0, 16], "onli": [0, 16, 18, 21], "work": [0, 16], "filenotfounderror": [0, 16], "isadirectoryerror": 0, "rm": [0, 16, 21], "otherwis": [0, 16], "except": [0, 16], "thrown": [0, 16], "rmdir": [0, 16, 21], "recurs": [0, 16, 21], "In": [0, 8, 16, 21], "order": [0, 3, 16, 18, 21], "stai": [0, 16], "close": [0, 16], "pathlib": [0, 16, 21], "won": [0, 16, 21], "empti": [0, 9, 16, 21], "itself": [0, 11, 16], "its": [0, 16, 21], "entir": [0, 11, 16], "subdir": [0, 16], "permissionerror": [0, 16], "suffix": [0, 4, 16, 21], "extens": [0, 4], "walk": [0, 16, 21], "top_down": 0, "tupl": [0, 16], "tree": [0, 13, 16], "top": [0, 16, 21], "down": [0, 16], "bottom": [0, 16], "up": [0, 16], "try": [0, 16, 21], "mimik": [0, 16], "doc": [0, 16, 20], "python": [0, 16, 18, 19, 20], "org": [0, 16, 20], "3": [0, 1, 5, 16, 19, 20, 23], "librari": [0, 11, 13, 16, 19, 20], "html": [0, 16, 20], "possibl": [0, 16, 21], "function": [0, 3, 16, 21, 22], "associ": [0, 16], "dirpath": [0, 16], "dirnam": [0, 16], "filenam": [0, 16, 20, 21], "write": [0, 16, 20, 21, 23], "exit": 0, "ye": 0, "after": [0, 16, 21], "successfulli": [0, 16, 18], "alreadi": [0, 16], "overwritten": [0, 16], "shall": [0, 16], "writen": [0, 16], "notafileerror": [0, 16], "storag": 0, "follow": [0, 16, 18, 20], "mount": 0, "mandatori": 0, "indic": [0, 16], "defin": [0, 16], "storagebackend": [0, 21], "enumer": 0, "current": [0, 5], "onprem": [0, 21], "valu": [0, 16], "enum": 0, "select": [0, 18], "within": [0, 16], "altern": [0, 2], "wai": [0, 16], "particular": 0, "the_desired_path": 0, "rest": 0, "argument": 0, "prem": [0, 21, 23], "differ": [0, 16, 21], "db": [0, 16, 21], "cannot": 0, "span": 0, "multipl": [0, 21], "cloud": 0, "com": [0, 18], "org_lveoj4pwxhpatnz5": 0, "valid": [0, 14], "msduzklmr8qcp_mslsvrwi": 0, "exa_pat_aj39asm3byr9bq4qk2wig8swhxbrugncthnep5yv73az6a": 0, "explicitli": 0, "transform": 0, "byte": [0, 20, 21], "concaten": 0, "singl": [0, 21], "continu": [0, 21], "encod": [0, 20, 21], "utf": [0, 20, 21], "8": [0, 1, 8, 19, 20, 21], "convert": [0, 16], "represent": 0, "written": 0, "algorithm": 0, "sha1": 0, "calcul": 0, "hash": 0, "input": [0, 9, 21], "checksum": 0, "hex": 0, "digest": 0, "wrap": 0, "variou": [0, 16], "conveni": [0, 20], "featur": [0, 16, 20], "even": [0, 16, 20], "though": [0, 20], "veri": [0, 20], "mai": [0, 16, 20, 21], "obviou": [0, 20], "do": [0, 11, 16, 20, 21], "involv": [0, 18, 20], "interact": [0, 19, 20, 21], "background": [0, 20], "sync": [0, 20], "etc": [0, 16, 20], "keep": [0, 21], "mind": 0, "occur": 0, "while": [0, 16, 18], "f": [0, 16, 20, 21], "unreleas": 1, "13": [1, 2], "12": [1, 4], "11": [1, 20], "10": [1, 20, 21], "9": 1, "7": [1, 2], "6": [1, 2], "5": [1, 23], "4": [1, 3, 10, 14, 23], "2": [1, 5, 9, 18, 20, 21, 23], "initi": 2, "version": [2, 4, 5, 7, 8, 9, 13, 14, 18], "allow": [2, 16, 18, 21], "you": [2, 18, 20, 22], "insid": 2, "also": [2, 16, 21, 23], "bucket": [2, 3, 7, 8, 9, 10, 17, 19, 22, 23], "ad": [2, 3, 5, 7, 8, 9, 10, 12, 14, 16, 18], "fileobj": 2, "fileboj": 2, "29": 2, "add": [2, 5, 8, 10, 11, 12, 16], "sphinx": 2, "joblib": 2, "obj": 2, "languag": 2, "45": 2, "droid": 2, "github": [2, 14, 18, 23], "workflow": [2, 4, 14, 16, 18], "prepar": [2, 9], "49": 2, "complaint": 2, "regard": [2, 16, 21], "changelog": [2, 18], "47": 2, "15": 2, "dephel": 2, "depend": [2, 3, 5, 11, 12, 16, 21, 23], "becaus": [2, 7, 21], "maintain": [2, 16, 18], "anymor": 2, "42": 2, "move": 2, "exasol_data_science_utils_python": 2, "n": 2, "log": 3, "support": [3, 10, 12, 14, 16, 21], "overview": [3, 14, 23], "logger": [3, 20], "referenc": 3, "via": [3, 5, 16], "exasol": [3, 4, 5, 11, 12, 16, 18, 20, 21, 22, 23], "import": [3, 16, 20, 21, 22, 23], "get": [3, 20, 23], "getlogg": [3, 20], "For": [3, 16, 18, 21, 23], "most": [3, 21], "suffici": [3, 20], "configur": [3, 14, 23], "retriev": 3, "basicconfig": [3, 20, 21], "level": [3, 16, 20, 21], "info": [3, 20, 21], "pathlik": [3, 5], "describ": [3, 20], "design": 3, "document": [3, 23], "extract": 3, "bucketlik": 3, "path": [3, 4, 7, 8, 9, 17, 20, 21, 22], "factori": 3, "old": [3, 8, 11], "propag": 3, "flag": 3, "servic": [3, 10, 16, 19, 20, 23], "relock": 3, "abatilo": 3, "action": [3, 16, 18], "poetri": [3, 9, 13, 18], "v2": 3, "v3": 3, "setup": [3, 12, 23], "v5": 3, "build": [3, 7, 8], "section": [3, 12, 18, 23], "project": [3, 9, 11, 12], "pyproject": 3, "toml": 3, "restructur": 3, "packag": [3, 11, 18], "slc": 3, "python3": 3, "lockfil": [4, 14], "align": [4, 16], "toolbox": [4, 5, 12, 14], "139": 4, "archiv": 4, "bucketpath": [4, 6, 16], "releas": [5, 22], "plugin": 5, "pytest_exasol_saa": 5, "replac": [5, 8, 18], "individu": 5, "fixtur": [5, 18], "those": [5, 20], "addition": 5, "fix": [5, 6, 12, 14, 18], "vulner": [5, 7, 11, 13], "cve": [5, 11, 13], "21503": 5, "transit": [5, 16], "black": 5, "24": 5, "35195": 5, "request": [5, 18, 21], "32": 5, "141": 5, "144": 5, "comment": [5, 16], "pytest": [5, 11], "147": 5, "156": 6, "introduc": [7, 16], "two": [7, 16, 18], "certain": [7, 21], "under": 7, "furthermor": [7, 8], "numpi": [7, 8], "against": [7, 18], "buffer": 7, "overflow": 7, "55": 7, "61": 7, "54": 7, "posixpath": 7, "convers": 7, "alter": 7, "session": 7, "58": [7, 13], "type": [7, 16, 21], "hint": 7, "51": 7, "bucketfsloc": [8, 9], "upgrad": 8, "generate_bucket_udf_path": 8, "bucketfsloct": 8, "addit": [8, 16, 18], "72": [8, 9], "63": 8, "correct": 8, "fileobject": 8, "mock": 8, "66": 8, "localf": 8, "74": 8, "53": 8, "again": [8, 21], "38": 8, "bash": 8, "script": [8, 20], "sphinx_github": 8, "page": 8, "migrat": 8, "nox": [8, 11, 18], "68": 8, "instal": 8, "instruct": 8, "readm": 8, "first": [9, 21], "pypi": [9, 18], "handl": [9, 16, 20, 21], "79": 9, "81": 9, "ci": 9, "prerequisit": 9, "adjust": [9, 16], "contributor": 9, "inform": [10, 16], "trigger": 10, "major": [11, 18, 21], "api": [11, 16, 19], "rework": 11, "still": [11, 18, 20, 21], "consid": [11, 16, 21], "deprec": 11, "futur": [11, 16, 21], "integr": [11, 16, 18], "more": [11, 21, 23], "easili": 11, "abil": 11, "standard": [11, 16], "built": 11, "mechan": 11, "achiev": [11, 18], "desir": 11, "outcom": 11, "without": [11, 20], "need": [11, 16, 18, 20, 21], "extend": [11, 16], "match": 11, "warn": 11, "issu": [11, 13, 16, 18], "evalu": 11, "42969": 11, "silenc": 11, "affect": 11, "our": [11, 13, 16], "nor": [11, 16], "pull": [11, 18], "check": [11, 13], "search": 11, "track": 11, "command": [12, 18], "develop": [12, 16], "guid": 12, "basic": [12, 23], "pre": 12, "commit": [12, 21], "hook": 12, "attent": [13, 16, 20, 21], "been": [13, 21], "address": [13, 16], "advis": 13, "own": 13, "scanner": 13, "trivi": 13, "intern": [13, 16, 21], "lock": [13, 16], "0286": 13, "23931": 13, "restrict": [13, 16, 21], "typeguard": [13, 14], "ssl": 14, "typo": 14, "60": 14, "pin": [14, 16], "diffrent": 16, "context": 16, "outsid": 16, "common": 16, "task": [16, 18], "pretti": 16, "tediou": 16, "due": [16, 21, 23], "fact": [16, 23], "know": 16, "concept": 16, "so": [16, 18, 21], "simplifi": 16, "streamlin": 16, "frequent": 16, "oper": 16, "uniform": 16, "accross": 16, "actual": 16, "abstract": 16, "filesystem": 16, "part": 16, "share": 16, "howev": 16, "experi": [16, 21], "present": 16, "sever": [16, 21], "particularli": [16, 18], "term": 16, "versatil": 16, "eas": 16, "across": 16, "extern": 16, "dual": 16, "complex": [16, 23], "ineffici": 16, "especi": 16, "focus": 16, "manag": 16, "aim": 16, "ensur": [16, 20], "reflect": 16, "scope": 16, "These": [16, 21, 23], "relev": [16, 21, 23], "conceal": 16, "contextu": 16, "face": 16, "difficulti": 16, "switch": 16, "between": 16, "versu": 16, "dure": 16, "execut": [16, 18], "lack": 16, "seamless": 16, "hinder": 16, "product": [16, 21], "additon": 16, "inher": 16, "understood": 16, "tradit": 16, "absenc": 16, "complic": 16, "make": [16, 18], "cumbersom": 16, "time": [16, 21], "consum": 16, "forc": 16, "lower": 16, "counterintuit": 16, "notabl": 16, "underli": 16, "inconsist": 16, "pattern": [16, 20], "being": [16, 21], "To": [16, 18, 21], "identifi": 16, "layer": 16, "approach": 16, "modul": 16, "mirror": 16, "By": [16, 20], "adopt": 16, "proven": 16, "decis": 16, "leverag": 16, "intuit": 16, "model": 16, "fit": [16, 21], "requir": [16, 18, 21], "focu": 16, "essenti": [16, 20], "although": 16, "inspir": 16, "includ": [16, 20], "necessari": 16, "effect": 16, "diverg": 16, "area": 16, "tailor": 16, "enhanc": 16, "facilit": 16, "unifi": 16, "regardless": 16, "meet": 16, "uniqu": 16, "practic": 16, "improv": 16, "effici": [16, 21], "primari": 16, "additionali": 16, "wan": 16, "wide": 16, "implent": 16, "persist": 16, "process": [16, 18], "reduc": 16, "learn": 16, "curv": 16, "familiar": [16, 21], "sure": [16, 18], "behaviour": 16, "wherev": 16, "flexibl": [16, 21], "enough": 16, "accommod": 16, "divid": 16, "four": 16, "main": [16, 18], "central": 16, "opt": 16, "elimin": 16, "inherit": 16, "unnecessari": 16, "clear": 16, "least": 16, "purpos": 16, "capabl": 16, "plan": 16, "prevent": 16, "travers": [16, 21], "emul": 16, "custom": [16, 21], "behavior": 16, "natur": 16, "appropri": [16, 18], "Not": 16, "uniformli": 16, "applic": 16, "determin": 16, "openli": 16, "compil": 16, "straightforward": 16, "some": [16, 20, 21, 22], "aspect": 16, "fulli": 16, "feasibl": 16, "along": 16, "semant": 16, "signific": 16, "deviat": 16, "choos": 16, "distinct": [16, 21], "clariti": 16, "guidelin": 16, "embrac": 16, "convent": 16, "avoid": 16, "confus": 16, "terminologi": 16, "subsect": 16, "snippet": 16, "intend": 16, "primarili": 16, "refer": [16, 20], "therefor": [16, 21], "docstr": 16, "sudo": 16, "adapt": 16, "def": [16, 21], "self": 16, "pathslik": 16, "yiel": 16, "pathseg": 16, "overload": 16, "see": [16, 18], "__truediv__": 16, "other": [16, 20, 21], "member": 16, "clearli": 16, "implment": 16, "serv": 16, "bf": [16, 21], "bfss": 16, "accss": 16, "localpath": 16, "bfsl": 16, "encapsul": 16, "exactli": 16, "chang": [16, 18, 21], "potenti": 16, "rectrict": 16, "protect": [16, 18], "stop": 16, "proect": 16, "whith": 16, "proection": 16, "throw": 16, "pathbuild": 16, "credentails_stor": 16, "init": 16, "besid": 16, "credentail_stor": 16, "yet": [16, 18], "pleas": [16, 21, 23], "bellow": [16, 23], "tbd": 16, "alias": 16, "pass": 16, "__call__": 16, "assembl": 16, "apropri": 16, "_determine_typ": 16, "facori": 16, "_create_udf_path": 16, "_create_bucket_path": 16, "_create_chroot_path": 16, "tar": 16, "gz": 16, "http_bucket_path": 16, "8888": 16, "https_bucket_path": 16, "chroot_path": 16, "sub": 16, "subsub": 16, "readonly_path": 16, "ro": 16, "udfpath": 16, "git": 18, "bucketf": [18, 20, 22], "bfspy": 18, "declar": 18, "repositori": [18, 22], "pytest_saa": 18, "folder": 18, "test_saa": 18, "separ": [18, 21], "group": 18, "gate": 18, "g1": 18, "fast": 18, "cheap": 18, "push": 18, "your": [18, 20], "branch": 18, "g2": 18, "expens": 18, "manual": 18, "merg": 18, "enabl": 18, "cycl": 18, "failur": 18, "infrastructur": 18, "cost": 18, "temporarili": 18, "guard": 18, "dedic": 18, "enviro": 18, "befor": 18, "result": 18, "job": 18, "termin": 18, "succesfulli": 18, "scroll": 18, "pend": 18, "ask": 18, "click": 18, "link": 18, "detail": [18, 21, 23], "right": 18, "hand": 18, "side": 18, "review": [18, 21], "deplopy": 18, "checkbox": 18, "green": 18, "button": 18, "deploi": 18, "number": 18, "templat": 18, "autom": 18, "minor": 18, "patch": 18, "onc": [18, 21], "pr": 18, "next": 18, "tag": 18, "latest": [18, 19, 22], "master": 18, "further": 18, "cd": 18, "yml": 18, "x": 18, "y": 18, "z": 18, "origin": 18, "d": 18, "remot": 18, "begin": [18, 20], "finish": 18, "redo": 18, "scenario": 18, "publish": 18, "wa": [18, 21], "got": 18, "interrupt": 18, "solut": 18, "pip": 19, "found": [19, 21], "here": [19, 21], "come": [20, 21], "handi": 20, "localhost": [20, 21, 23], "6666": [20, 21, 23], "w": [20, 21, 23], "default_bucket": [20, 21, 23], "io": [20, 21], "65": [20, 21], "bin": [20, 21], "myfile1": 20, "rb": [20, 21], "destin": [20, 21], "file_lik": [20, 21], "bytesio": [20, 21], "conent": 20, "text": [20, 21], "abcd": [20, 21], "_": [20, 21], "rang": [20, 21, 23], "raw": [20, 21], "as_byt": [20, 21, 23], "as_fil": [20, 21], "myfil": [20, 21, 23], "my_utf8_str": [20, 21], "as_str": [20, 21], "utf8": [20, 21], "my_ascii_str": [20, 21], "ascii": [20, 21], "del": 20, "messag": 20, "correctli": 20, "proper": 20, "might": 20, "appear": 20, "expect": [20, 21], "explicityli": 20, "bucketfs_logg": 20, "notset": 20, "lot": 20, "approri": 20, "setlevel": 20, "debug": 20, "saasbucket": 21, "them": 21, "directli": 21, "demonstr": 21, "last": 21, "ident": 21, "myfile2": 21, "caller": 21, "recept": 21, "memori": 21, "prefer": 21, "tangibl": [21, 23], "as_hash": 21, "creation": 21, "o": 21, "let": 21, "assum": 21, "connect": 21, "environ": 21, "variabl": 21, "saas_url": 21, "saas_account_id": 21, "saas_database_id": 21, "saas_pat": 21, "feel": 21, "tutori": 21, "tempfil": 21, "build_path": 21, "take": 21, "docker": 21, "run": [21, 23], "machin": 21, "accord": 21, "better": 21, "secur": 21, "elif": 21, "els": 21, "runtimeerror": 21, "unknown": 21, "good": 21, "good_review": 21, "john_h_review": 21, "john": 21, "h": 21, "had": 21, "amaz": 21, "compani": 21, "notch": 21, "exceed": 21, "my": 21, "highli": 21, "recommend": 21, "anyon": 21, "qualiti": 21, "excel": 21, "sarah_l_review": 21, "sarah": 21, "l": 21, "am": 21, "repeat": 21, "busi": 21, "thei": 21, "never": 21, "disappoint": 21, "team": 21, "alwai": 21, "friendli": 21, "help": 21, "outstand": 21, "friend": 21, "famili": 21, "david_w_review": 21, "david": 21, "perfect": 21, "Their": 21, "satisfact": 21, "unparallel": 21, "now": 21, "bad": 21, "subdirectori": 21, "bad_review": 21, "previous": 21, "But": 21, "shown": 21, "temporaryfil": 21, "file_obj": 21, "began": 21, "unfortun": 21, "overwhelmingli": 21, "neg": 21, "bill": 21, "than": 21, "600": 21, "euro": 21, "vast": 21, "did": 21, "consent": 21, "were": 21, "carri": 21, "out": 21, "seek": 21, "mike_s_review": 21, "mike": 21, "posixpurepath": 21, "path_obj": 21, "tname": 21, "tsuffix": 21, "tparent": 21, "texist": 21, "tis_dir": 21, "tis_fil": 21, "find": 21, "whole": 21, "read_cont": 21, "bfs_path": 21, "item": 21, "said": 21, "all_review": 21, "node": [21, 23], "internod": 21, "synchronis": 21, "procedur": 21, "left": 21, "surpris": 21, "why": 21, "entiti": 21, "With": 22, "public": 22, "want": 22, "artefact": 22, "exasol_bucketfs_utils_python": 22, "github_release_file_bucketfs_upload": 22, "githubreleasefilebucketfsupload": 22, "release_upload": 22, "file_to_download_nam": 22, "github_us": 22, "repository_nam": 22, "release_nam": 22, "path_inside_bucket": 22, "port": 22, "straight": 23, "forward": 23, "fairli": 23, "worker": 23, "cluster": 23, "hold": 23, "tri": 23, "illustr": 23, "manner": 23, "advanc": 23, "artifact": 23}, "objects": {"exasol.bucketfs": [[0, 0, 1, "", "Bucket"], [0, 3, 1, "", "BucketFsError"], [0, 0, 1, "", "BucketLike"], [0, 0, 1, "", "MappedBucket"], [0, 0, 1, "", "MountedBucket"], [0, 0, 1, "", "SaaSBucket"], [0, 4, 1, "", "as_bytes"], [0, 4, 1, "", "as_file"], [0, 4, 1, "", "as_hash"], [0, 4, 1, "", "as_string"]], "exasol.bucketfs.Bucket": [[0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 2, 1, "", "udf_path"], [0, 1, 1, "", "upload"]], "exasol.bucketfs.BucketLike": [[0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 2, 1, "", "udf_path"], [0, 1, 1, "", "upload"]], "exasol.bucketfs.MappedBucket": [[0, 1, 1, "", "__init__"], [0, 2, 1, "", "chunk_size"]], "exasol.bucketfs.MountedBucket": [[0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 2, 1, "", "udf_path"], [0, 1, 1, "", "upload"]], "exasol.bucketfs.SaaSBucket": [[0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 2, 1, "", "udf_path"], [0, 1, 1, "", "upload"]], "exasol.bucketfs._path": [[0, 0, 1, "", "PathLike"], [0, 4, 1, "", "build_path"]], "exasol.bucketfs._path.PathLike": [[0, 1, 1, "", "as_udf_path"], [0, 1, 1, "", "as_uri"], [0, 1, 1, "", "exists"], [0, 1, 1, "", "is_dir"], [0, 1, 1, "", "is_file"], [0, 1, 1, "", "iterdir"], [0, 1, 1, "", "joinpath"], [0, 2, 1, "", "name"], [0, 2, 1, "", "parent"], [0, 1, 1, "", "read"], [0, 1, 1, "", "rm"], [0, 1, 1, "", "rmdir"], [0, 2, 1, "", "root"], [0, 2, 1, "", "suffix"], [0, 1, 1, "", "walk"], [0, 1, 1, "", "write"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:property", "3": "py:exception", "4": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "property", "Python property"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"]}, "titleterms": {"api": 0, "refer": [0, 21], "exasol": [0, 19], "bucketf": [0, 2, 3, 7, 8, 9, 10, 11, 12, 13, 14, 16, 19, 21, 23], "servic": [0, 21], "bucketlik": 0, "bucket": [0, 16, 20, 21], "saasbucket": 0, "mountedbucket": 0, "path": [0, 16], "pathlik": [0, 16, 21], "build_path": 0, "as_byt": 0, "as_str": 0, "as_fil": 0, "as_hash": 0, "mappedbucket": [0, 20], "bucketfserror": 0, "chang": [1, 12], "util": [2, 7, 8, 16], "python": [2, 3, 7, 8, 9, 10, 11, 12, 13, 14], "0": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14], "1": 2, "releas": [2, 3, 7, 8, 9, 10, 11, 12, 13, 14, 18], "2022": [2, 7, 8, 9, 10, 11, 12], "01": 2, "18": 2, "summari": [2, 5, 7, 8, 9, 10, 11, 12, 13], "featur": [2, 3, 7, 8, 9, 10, 11, 14, 19], "enhanc": [2, 7, 8, 9, 10, 11], "bug": [2, 3, 4, 7, 8, 9], "fix": [2, 3, 4, 7, 8, 9], "document": [2, 5, 8, 9, 10, 11, 12, 14, 16, 17, 19], "refactor": [2, 5, 7, 8, 9, 11], "secur": [2, 5, 7, 11, 13], "10": [3, 10], "2024": [3, 4, 5, 6, 14], "05": [3, 4], "15": 3, "intern": [3, 4, 14], "11": [4, 5, 11], "23": 4, "12": [5, 10, 12], "07": [5, 6, 8], "13": 6, "08": 6, "bugfix": 6, "2": 7, "04": 7, "29": 7, "3": 8, "20": 8, "4": 9, "09": 9, "28": 9, "5": 10, "6": 11, "7": 12, "22": 12, "8": 13, "2023": 13, "03": 13, "21": 13, "depend": [13, 14, 18], "9": 14, "02": 14, "16": 14, "unreleas": 15, "design": [16, 17], "": [16, 18, 21], "problem": 16, "descript": 16, "delimit": 16, "challeng": 16, "current": 16, "interact": 16, "propos": 16, "solut": 16, "desgin": 16, "goal": 16, "architectur": 16, "overview": 16, "interfac": [16, 21], "backend": 16, "extens": 16, "chroot": 16, "readonli": 16, "creation": 16, "detail": 16, "concret": 16, "modifi": 16, "factori": 16, "builder": 16, "exampl": 16, "develop": 18, "guid": [18, 23], "set": 18, "up": [18, 23], "workspac": 18, "checkout": 18, "project": 18, "instal": [18, 19], "setup": 18, "pre": 18, "commit": 18, "hook": 18, "test": 18, "pytest": 18, "plugin": 18, "run": 18, "ci": 18, "build": 18, "approv": 18, "slow": 18, "creat": [18, 21], "prepar": 18, "trigger": 18, "what": 18, "do": 18, "fail": 18, "The": [18, 20, 21], "dure": 18, "check": 18, "One": 18, "step": 18, "partial": 18, "prerequisit": 19, "advanc": 20, "list": [20, 21], "file": [20, 21], "upload": [20, 21], "download": [20, 21], "from": [20, 21], "delet": [20, 21], "configur": [20, 21], "log": [20, 21], "basic": 21, "get": 21, "class": 21, "avail": 21, "convert": 21, "object": 21, "saa": 21, "us": 21, "github": 22, "artifact": 22, "user": 23, "quickstart": 23, "follow": 23}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"\ud83e\uddf0 API Reference": [[0, "api-reference"]], "exasol.bucketfs.Service": [[0, "exasol-bucketfs-service"]], "exasol.bucketfs.BucketLike": [[0, "exasol-bucketfs-bucketlike"]], "exasol.bucketfs.Bucket": [[0, "exasol-bucketfs-bucket"]], "exasol.bucketfs.SaaSBucket": [[0, "exasol-bucketfs-saasbucket"]], "exasol.bucketfs.MountedBucket": [[0, "exasol-bucketfs-mountedbucket"]], "exasol.bucketfs.path.PathLike": [[0, "exasol-bucketfs-path-pathlike"]], "exasol.bucketfs.path.build_path": [[0, "exasol-bucketfs-path-build-path"]], "exasol.bucketfs.as_bytes": [[0, "exasol-bucketfs-as-bytes"]], "exasol.bucketfs.as_string": [[0, "exasol-bucketfs-as-string"]], "exasol.bucketfs.as_file": [[0, "exasol-bucketfs-as-file"]], "exasol.bucketfs.as_hash": [[0, "exasol-bucketfs-as-hash"]], "exasol.bucketfs.MappedBucket": [[0, "exasol-bucketfs-mappedbucket"]], "exasol.bucketfs.BucketFsError": [[0, "exasol-bucketfs-bucketfserror"]], "\ud83d\udcdd Changes": [[1, "changes"]], "BucketFs Utils Python 0.1.0, released 2022-01-18": [[2, "bucketfs-utils-python-0-1-0-released-2022-01-18"]], "Summary": [[2, "summary"], [5, "summary"], [7, "summary"], [8, "summary"], [9, "summary"], [10, "summary"], [11, "summary"], [12, "summary"], [13, "summary"]], "Features / Enhancements": [[2, "features-enhancements"], [7, "features-enhancements"], [8, "features-enhancements"], [9, "features-enhancements"], [10, "features-enhancements"], [11, "features-enhancements"]], "Bug Fixes": [[2, "bug-fixes"], [4, "bug-fixes"], [7, "bug-fixes"], [8, "bug-fixes"], [9, "bug-fixes"]], "Documentation": [[2, "documentation"], [5, "documentation"], [8, "documentation"], [9, "documentation"], [10, "documentation"], [11, "documentation"], [12, "documentation"], [14, "documentation"]], "Refactoring": [[2, "refactoring"], [7, "refactoring"], [8, "refactoring"], [9, "refactoring"], [11, "refactoring"]], "Security": [[2, "security"], [5, "security"], [7, "security"], [11, "security"], [13, "security"]], "BucketFs Python 0.10.0, released 2024-05-15": [[3, "bucketfs-python-0-10-0-released-2024-05-15"]], "Feature": [[3, "feature"], [14, "feature"]], "Bug Fixing": [[3, "bug-fixing"]], "Internal": [[3, "internal"], [4, "internal"], [14, "internal"]], "0.11.0 - 2024-05-23": [[4, "id1"]], "0.12.0 - 2024-07-11": [[5, "id1"]], "Refactorings": [[5, "refactorings"]], "0.13.0 - 2024-08-07": [[6, "id1"]], "Bugfixes": [[6, "bugfixes"]], "BucketFs Utils Python 0.2.0, released 2022-04-29": [[7, "bucketfs-utils-python-0-2-0-released-2022-04-29"]], "BucketFs Utils Python 0.3.0, released 2022-07-20": [[8, "bucketfs-utils-python-0-3-0-released-2022-07-20"]], "BucketFs Python 0.4.0, released 2022-09-28": [[9, "bucketfs-python-0-4-0-released-2022-09-28"]], "BucketFs Python 0.5.0, released 2022-10-12": [[10, "bucketfs-python-0-5-0-released-2022-10-12"]], "BucketFs Python 0.6.0, released 2022-11-11": [[11, "bucketfs-python-0-6-0-released-2022-11-11"]], "BucketFs Python 0.7.0, released 2022-12-22": [[12, "bucketfs-python-0-7-0-released-2022-12-22"]], "Changes": [[12, "changes"]], "BucketFs Python 0.8.0, released 2023-03-21": [[13, "bucketfs-python-0-8-0-released-2023-03-21"]], "Dependencies": [[13, "dependencies"], [14, "dependencies"]], "BucketFs Python 0.9.0, released 2024-02-16": [[14, "bucketfs-python-0-9-0-released-2024-02-16"]], "Unreleased": [[15, "unreleased"]], "Design Document Bucket Path(s)": [[16, "design-document-bucket-path-s"]], "Problem Description": [[16, "problem-description"]], "Delimitation": [[16, "delimitation"]], "Challenges with Current BucketFS Interactions": [[16, "challenges-with-current-bucketfs-interactions"]], "Proposed Solution": [[16, "proposed-solution"]], "Desgin": [[16, "desgin"]], "Design Goals": [[16, "design-goals"]], "Architecture": [[16, "architecture"]], "Overview": [[16, "overview"]], "Interface": [[16, "interface"]], "Backends": [[16, "backends"]], "Extensions": [[16, "extensions"]], "Chroot": [[16, "chroot"]], "ReadOnly": [[16, "readonly"]], "Path Creation": [[16, "path-creation"]], "Detailed Design": [[16, "detailed-design"]], "Pathlike": [[16, "pathlike"]], "Concrete Paths (Backends)": [[16, "concrete-paths-backends"]], "Modifiers (Extensions)": [[16, "modifiers-extensions"]], "Factory & Builders": [[16, "factory-builders"]], "Examples": [[16, "examples"]], "Utilities": [[16, "utilities"]], "\ud83d\udcd1 Design Documents": [[17, "design-documents"]], "\ud83d\udee0 Developer Guide": [[18, "developer-guide"]], "Setting up the workspace": [[18, "setting-up-the-workspace"]], "Checkout the Project": [[18, "checkout-the-project"]], "Install project dependencies": [[18, "install-project-dependencies"]], "Setup pre-commit hook(s)": [[18, "setup-pre-commit-hook-s"]], "Tests": [[18, "tests"]], "Pytest Plugins": [[18, "pytest-plugins"]], "Running Tests in CI Builds": [[18, "running-tests-in-ci-builds"]], "Approving Slow Tests": [[18, "approving-slow-tests"]], "Creating a Release": [[18, "creating-a-release"]], "Prepare the Release": [[18, "prepare-the-release"]], "Triggering the Release": [[18, "triggering-the-release"]], "What to do if the release failed?": [[18, "what-to-do-if-the-release-failed"]], "The release failed during pre-release checks": [[18, "the-release-failed-during-pre-release-checks"]], "One of the release steps failed (Partial Release)": [[18, "one-of-the-release-steps-failed-partial-release"]], "Exasol Bucketfs": [[19, "exasol-bucketfs"]], "\ud83d\ude80 Features": [[19, "features"]], "\ud83d\udd0c\ufe0f Prerequisites": [[19, "prerequisites"]], "\ud83d\udcbe Installation": [[19, "installation"]], "\ud83d\udcda Documentation": [[19, "documentation"]], "Advanced": [[20, "advanced"]], "The MappedBucket": [[20, "the-mappedbucket"]], "List files in a Bucket": [[20, "list-files-in-a-bucket"], [21, "list-files-in-a-bucket"]], "Upload files to a Bucket": [[20, "upload-files-to-a-bucket"], [21, "upload-files-to-a-bucket"]], "Download files from a Bucket": [[20, "download-files-from-a-bucket"], [21, "download-files-from-a-bucket"]], "Delete files from Bucket": [[20, "delete-files-from-bucket"], [21, "delete-files-from-bucket"]], "Configure logging": [[20, "configure-logging"], [21, "configure-logging"]], "Basic\u2019s": [[21, "basic-s"]], "The Bucketfs Service": [[21, "the-bucketfs-service"]], "List buckets": [[21, "list-buckets"]], "Get a Bucket reference": [[21, "get-a-bucket-reference"]], "Bucket class": [[21, "bucket-class"]], "Available Converters": [[21, "available-converters"]], "Create bucket object in SaaS": [[21, "create-bucket-object-in-saas"]], "PathLike interface": [[21, "pathlike-interface"]], "Using the PathLike interface": [[21, "using-the-pathlike-interface"]], "Github Artifacts": [[22, "github-artifacts"]], "\ud83d\udc64 User Guide": [[23, "user-guide"]], "Bucketfs": [[23, "bucketfs"]], "Quickstart": [[23, "quickstart"]], "Follow Up": [[23, "follow-up"]]}, "indexentries": {"bucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.Bucket"]], "bucketfserror": [[0, "exasol.bucketfs.BucketFsError"]], "bucketlike (class in exasol.bucketfs)": [[0, "exasol.bucketfs.BucketLike"]], "mappedbucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.MappedBucket"]], "mountedbucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.MountedBucket"]], "pathlike (class in exasol.bucketfs._path)": [[0, "exasol.bucketfs._path.PathLike"]], "saasbucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.SaaSBucket"]], "__init__() (exasol.bucketfs.mappedbucket method)": [[0, "exasol.bucketfs.MappedBucket.__init__"]], "as_bytes() (in module exasol.bucketfs)": [[0, "exasol.bucketfs.as_bytes"]], "as_file() (in module exasol.bucketfs)": [[0, "exasol.bucketfs.as_file"]], "as_hash() (in module exasol.bucketfs)": [[0, "exasol.bucketfs.as_hash"]], "as_string() (in module exasol.bucketfs)": [[0, "exasol.bucketfs.as_string"]], "as_udf_path() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.as_udf_path"]], "as_uri() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.as_uri"]], "build_path() (in module exasol.bucketfs._path)": [[0, "exasol.bucketfs._path.build_path"]], "chunk_size (exasol.bucketfs.mappedbucket property)": [[0, "exasol.bucketfs.MappedBucket.chunk_size"]], "delete() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.delete"]], "delete() (exasol.bucketfs.bucketlike method)": [[0, "exasol.bucketfs.BucketLike.delete"]], "delete() (exasol.bucketfs.mountedbucket method)": [[0, "exasol.bucketfs.MountedBucket.delete"]], "delete() (exasol.bucketfs.saasbucket method)": [[0, "exasol.bucketfs.SaaSBucket.delete"]], "download() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.download"]], "download() (exasol.bucketfs.bucketlike method)": [[0, "exasol.bucketfs.BucketLike.download"]], "download() (exasol.bucketfs.mountedbucket method)": [[0, "exasol.bucketfs.MountedBucket.download"]], "download() (exasol.bucketfs.saasbucket method)": [[0, "exasol.bucketfs.SaaSBucket.download"]], "exists() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.exists"]], "files (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.files"]], "files (exasol.bucketfs.bucketlike property)": [[0, "exasol.bucketfs.BucketLike.files"]], "files (exasol.bucketfs.mountedbucket property)": [[0, "exasol.bucketfs.MountedBucket.files"]], "files (exasol.bucketfs.saasbucket property)": [[0, "exasol.bucketfs.SaaSBucket.files"]], "is_dir() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.is_dir"]], "is_file() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.is_file"]], "iterdir() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.iterdir"]], "joinpath() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.joinpath"]], "name (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.name"]], "name (exasol.bucketfs.bucketlike property)": [[0, "exasol.bucketfs.BucketLike.name"]], "name (exasol.bucketfs.mountedbucket property)": [[0, "exasol.bucketfs.MountedBucket.name"]], "name (exasol.bucketfs.saasbucket property)": [[0, "exasol.bucketfs.SaaSBucket.name"]], "name (exasol.bucketfs._path.pathlike property)": [[0, "exasol.bucketfs._path.PathLike.name"]], "parent (exasol.bucketfs._path.pathlike property)": [[0, "exasol.bucketfs._path.PathLike.parent"]], "read() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.read"]], "rm() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.rm"]], "rmdir() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.rmdir"]], "root (exasol.bucketfs._path.pathlike property)": [[0, "exasol.bucketfs._path.PathLike.root"]], "suffix (exasol.bucketfs._path.pathlike property)": [[0, "exasol.bucketfs._path.PathLike.suffix"]], "udf_path (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.udf_path"]], "udf_path (exasol.bucketfs.bucketlike property)": [[0, "exasol.bucketfs.BucketLike.udf_path"]], "udf_path (exasol.bucketfs.mountedbucket property)": [[0, "exasol.bucketfs.MountedBucket.udf_path"]], "udf_path (exasol.bucketfs.saasbucket property)": [[0, "exasol.bucketfs.SaaSBucket.udf_path"]], "upload() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.upload"]], "upload() (exasol.bucketfs.bucketlike method)": [[0, "exasol.bucketfs.BucketLike.upload"]], "upload() (exasol.bucketfs.mountedbucket method)": [[0, "exasol.bucketfs.MountedBucket.upload"]], "upload() (exasol.bucketfs.saasbucket method)": [[0, "exasol.bucketfs.SaaSBucket.upload"]], "walk() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.walk"]], "write() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.write"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api", "changes/changelog", "changes/changes_0.1.0", "changes/changes_0.10.0", "changes/changes_0.11.0", "changes/changes_0.12.0", "changes/changes_0.13.0", "changes/changes_0.2.0", "changes/changes_0.3.0", "changes/changes_0.4.0", "changes/changes_0.5.0", "changes/changes_0.6.0", "changes/changes_0.7.0", "changes/changes_0.8.0", "changes/changes_0.9.0", "changes/unreleased", "design/bucketpath", "design/design", "developer_guide/developer_guide", "index", "user_guide/advanced", "user_guide/basics", "user_guide/upload_github_release_to_bucket", "user_guide/user_guide"], "filenames": ["api.rst", "changes/changelog.md", "changes/changes_0.1.0.md", "changes/changes_0.10.0.md", "changes/changes_0.11.0.md", "changes/changes_0.12.0.md", "changes/changes_0.13.0.md", "changes/changes_0.2.0.md", "changes/changes_0.3.0.md", "changes/changes_0.4.0.md", "changes/changes_0.5.0.md", "changes/changes_0.6.0.md", "changes/changes_0.7.0.md", "changes/changes_0.8.0.md", "changes/changes_0.9.0.md", "changes/unreleased.md", "design/bucketpath.rst", "design/design.rst", "developer_guide/developer_guide.rst", "index.rst", "user_guide/advanced.rst", "user_guide/basics.rst", "user_guide/upload_github_release_to_bucket.rst", "user_guide/user_guide.rst"], "titles": ["\ud83e\uddf0 API Reference", "\ud83d\udcdd Changes", "BucketFs Utils Python 0.1.0, released 2022-01-18", "BucketFs Python 0.10.0, released 2024-05-15", "0.11.0 - 2024-05-23", "0.12.0 - 2024-07-11", "0.13.0 - 2024-08-07", "BucketFs Utils Python 0.2.0, released 2022-04-29", "BucketFs Utils Python 0.3.0, released 2022-07-20", "BucketFs Python 0.4.0, released 2022-09-28", "BucketFs Python 0.5.0, released 2022-10-12", "BucketFs Python 0.6.0, released 2022-11-11", "BucketFs Python 0.7.0, released 2022-12-22", "BucketFs Python 0.8.0, released 2023-03-21", "BucketFs Python 0.9.0, released 2024-02-16", "Unreleased", "Design Document Bucket Path(s)", "\ud83d\udcd1 Design Documents", "\ud83d\udee0 Developer Guide", "Exasol Bucketfs", "Advanced", "Basic\u2019s", "Github Artifacts", "\ud83d\udc64 User Guide"], "terms": {"class": [0, 16], "url": [0, 9, 20, 21, 23], "str": [0, 16], "credenti": [0, 16, 20, 21, 23], "map": 0, "none": [0, 9, 16], "verifi": [0, 3, 21], "bool": [0, 16], "true": [0, 16, 21], "service_nam": [0, 21], "sourc": [0, 7, 8, 22], "base": [0, 3, 16, 21], "object": [0, 2, 3, 16, 20], "provid": [0, 2, 5, 11, 16, 20, 21], "simpl": [0, 16], "us": [0, 3, 4, 5, 7, 11, 13, 16, 18, 22], "access": [0, 10, 16, 21], "list": [0, 7, 8, 10, 16, 19, 23], "all": [0, 10, 16, 19, 20, 21, 23], "avail": [0, 10, 11, 18, 23], "__init__": [0, 16], "creat": [0, 16], "new": [0, 7, 9, 11, 16, 18], "instanc": [0, 18], "paramet": [0, 3, 16, 18, 21], "e": [0, 13, 16, 18], "g": [0, 13, 16, 18], "http": [0, 16, 20, 21, 22, 23], "": [0, 9, 11, 17, 19, 22, 23], "127": [0, 16], "0": [0, 1, 16, 20, 21, 23], "1": [0, 1, 3, 9, 16, 18, 20, 23], "2580": 0, "A": [0, 16, 21], "contain": [0, 2, 18, 21], "usernam": [0, 20, 21, 23], "password": [0, 20, 21, 22, 23], "bucket1": 0, "foo": 0, "bar": 0, "either": [0, 16], "boolean": 0, "which": [0, 11, 16, 18, 20, 21], "case": [0, 3, 16, 18, 20, 21], "control": 0, "whether": 0, "we": [0, 7, 13, 16, 21], "server": 0, "tl": [0, 14], "certif": 0, "string": [0, 2, 7, 9, 15, 16, 20, 21], "must": [0, 16, 18], "ca": 0, "bundl": 0, "default": [0, 16, 20, 21, 23], "option": [0, 16, 21], "name": [0, 2, 7, 8, 9, 16, 18, 21], "properti": [0, 16], "mutablemap": 0, "arg": [0, 16], "kwarg": [0, 16], "protocol": [0, 3, 16], "definit": [0, 16, 21], "interfac": [0, 3, 5], "It": [0, 2, 16, 20, 21], "i": [0, 2, 4, 8, 11, 16, 18, 19, 20, 21, 23], "compat": [0, 16], "both": [0, 16, 18], "premis": 0, "an": [0, 4, 9, 16, 21, 22], "saa": [0, 3, 5, 18], "system": [0, 2, 3, 14, 16], "delet": [0, 7, 16, 18, 19, 23], "file": [0, 2, 7, 16, 18, 19, 22, 23], "q": 0, "what": [0, 16], "happen": 0, "doesn": [0, 21], "t": [0, 16, 21], "exist": [0, 11, 16, 21], "doe": [0, 11, 16], "noth": [0, 16], "error": [0, 16], "point": [0, 16], "directori": [0, 3, 16, 21], "same": [0, 21], "There": [0, 16], "ar": [0, 8, 16, 18, 20, 21, 23], "henc": [0, 13], "just": [0, 3, 16], "non": [0, 16], "download": [0, 2, 19, 23], "chunk_siz": [0, 16], "int": [0, 16], "8192": [0, 16], "iter": [0, 16, 21], "bytestr": [0, 16, 21], "from": [0, 2, 3, 5, 7, 8, 16, 18, 19, 22, 23], "The": [0, 3, 5, 11, 16, 19, 23], "content": [0, 16, 20, 21, 23], "chunk": [0, 16, 21], "specifi": [0, 16, 21], "size": 0, "full": 0, "can": [0, 2, 3, 16, 18, 19, 21, 22, 23], "construct": 0, "code": [0, 2, 7, 8, 11, 12, 16], "similar": [0, 16, 21], "line": 0, "below": [0, 5, 18, 21], "b": [0, 20, 21, 23], "join": [0, 16, 21], "download_fil": 0, "should": [0, 3, 16, 18, 20, 21], "deliv": 0, "rais": [0, 16, 21], "sinc": [0, 21], "return": [0, 16, 21], "over": [0, 2, 16, 21], "usag": [0, 16, 21], "exampl": [0, 12, 14, 18, 21, 22, 23], "print": [0, 21], "bucket_api": 0, "output": 0, "dir1": 0, "subdir1": 0, "file1": [0, 20, 21], "dat": 0, "subdir2": 0, "file2": [0, 20, 21], "txt": [0, 20, 21, 23], "note": [0, 16, 20, 21], "look": [0, 21, 23], "like": [0, 13, 16, 20, 21], "abov": [0, 16], "posix": 0, "style": 0, "backslash": 0, "start": [0, 18], "end": [0, 16], "udf_path": [0, 16], "seen": [0, 21], "udf": [0, 2, 8, 9, 16, 21], "upload": [0, 2, 8, 18, 19, 22, 23], "data": [0, 16, 20, 21, 23], "binaryio": [0, 16], "where": [0, 16, 20, 21], "binari": 0, "arrai": 0, "stream": 0, "open": [0, 18, 20, 21, 22], "mode": [0, 16], "parent": [0, 6, 16, 21], "miss": 0, "care": 0, "about": 0, "structur": [0, 11, 16], "prospect": 0, "realiti": 0, "store": [0, 21], "index": 0, "That": 0, "fine": 0, "updat": [0, 3, 4, 5, 9, 12, 13, 14, 18], "how": [0, 10], "ani": [0, 16, 21], "ntf": 0, "invalid": [0, 12], "charact": 0, "have": [0, 13, 16, 18, 21, 23], "lead": [0, 18], "subsequ": [0, 16], "remov": [0, 2, 4, 7, 8, 11, 16], "If": [0, 16, 21], "conform": 0, "thi": [0, 2, 7, 8, 11, 16, 18, 20, 21, 22, 23], "format": 0, "implement": [0, 2, 3, 6, 15, 16, 21], "On": [0, 18, 21, 23], "databas": [0, 16, 18, 21, 23], "host": [0, 21, 22], "authent": 0, "account_id": [0, 21], "database_id": [0, 21], "pat": [0, 21], "user": [0, 12, 13, 16, 21, 22], "account": 0, "id": 0, "person": 0, "token": 0, "bfsdefault": [0, 21], "bucket_nam": [0, 21], "base_path": [0, 9], "back": [0, 21], "normal": 0, "target": 0, "instead": 0, "one": [0, 16, 21, 22, 23], "root": [0, 3, 16, 20], "test": [0, 5, 9], "when": [0, 16, 21], "backend": [0, 21], "local": [0, 2, 16, 18, 21], "set": [0, 16, 20, 21], "_path": 0, "view": [0, 3], "as_udf_path": [0, 4, 16, 21], "method": [0, 7, 8, 9, 16, 21], "specif": [0, 7, 16], "flavour": [0, 3], "correspond": [0, 21], "as_uri": [0, 16], "repres": [0, 16], "uri": [0, 16], "reconstruct": [0, 16], "locat": [0, 2, 16, 18], "is_dir": [0, 16, 21], "fals": [0, 16, 21], "anoth": [0, 16, 21], "kind": [0, 16], "is_fil": [0, 16, 21], "regular": [0, 16, 18], "iterdir": [0, 16, 21], "gener": [0, 8, 9, 16, 20, 21], "yield": [0, 16], "direct": [0, 16], "children": [0, 16], "joinpath": [0, 9, 16], "path_seg": 0, "call": [0, 16, 21], "equival": [0, 16], "combin": [0, 16], "each": [0, 16, 18, 21, 23], "given": [0, 16], "segment": 0, "turn": [0, 16], "final": [0, 16, 18, 21], "compon": [0, 16], "exclud": [0, 16], "drive": [0, 16], "logic": [0, 16], "read": [0, 2, 16, 21], "behind": [0, 16], "onli": [0, 16, 18, 21], "work": [0, 16], "filenotfounderror": [0, 16], "isadirectoryerror": 0, "rm": [0, 16, 21], "otherwis": [0, 16], "except": [0, 16], "thrown": [0, 16], "rmdir": [0, 16, 21], "recurs": [0, 16, 21], "In": [0, 8, 16, 21], "order": [0, 3, 16, 18, 21], "stai": [0, 16], "close": [0, 16], "pathlib": [0, 16, 21], "won": [0, 16, 21], "empti": [0, 9, 16, 21], "itself": [0, 11, 16], "its": [0, 16, 21], "entir": [0, 11, 16], "subdir": [0, 16], "permissionerror": [0, 16], "suffix": [0, 4, 16, 21], "extens": [0, 4], "walk": [0, 16, 21], "top_down": 0, "tupl": [0, 16], "tree": [0, 13, 16], "top": [0, 16, 21], "down": [0, 16], "bottom": [0, 16], "up": [0, 16], "try": [0, 16, 21], "mimik": [0, 16], "doc": [0, 16, 20], "python": [0, 16, 18, 19, 20], "org": [0, 16, 20], "3": [0, 1, 5, 16, 19, 20, 23], "librari": [0, 11, 13, 16, 19, 20], "html": [0, 16, 20], "possibl": [0, 16, 21], "function": [0, 3, 16, 21, 22], "associ": [0, 16], "dirpath": [0, 16], "dirnam": [0, 16], "filenam": [0, 16, 20, 21], "write": [0, 16, 20, 21, 23], "exit": 0, "ye": 0, "after": [0, 16, 21], "successfulli": [0, 16, 18], "alreadi": [0, 16], "overwritten": [0, 16], "shall": [0, 16], "writen": [0, 16], "notafileerror": [0, 16], "storag": 0, "follow": [0, 16, 18, 20], "mount": 0, "mandatori": 0, "indic": [0, 16], "defin": [0, 16], "storagebackend": [0, 21], "enumer": 0, "current": [0, 5], "onprem": [0, 21], "valu": [0, 16], "enum": 0, "select": [0, 18], "within": [0, 16], "altern": [0, 2], "wai": [0, 16], "particular": 0, "the_desired_path": 0, "rest": 0, "argument": 0, "prem": [0, 21, 23], "differ": [0, 16, 21], "db": [0, 16, 21], "cannot": 0, "span": 0, "multipl": [0, 21], "cloud": 0, "com": [0, 18], "org_lveoj4pwxhpatnz5": 0, "valid": [0, 14], "msduzklmr8qcp_mslsvrwi": 0, "exa_pat_aj39asm3byr9bq4qk2wig8swhxbrugncthnep5yv73az6a": 0, "explicitli": 0, "transform": 0, "byte": [0, 20, 21], "concaten": 0, "singl": [0, 21], "continu": [0, 21], "encod": [0, 20, 21], "utf": [0, 20, 21], "8": [0, 1, 8, 19, 20, 21], "convert": [0, 16], "represent": [0, 15], "written": 0, "algorithm": 0, "sha1": 0, "calcul": 0, "hash": 0, "input": [0, 9, 21], "checksum": 0, "hex": 0, "digest": 0, "wrap": 0, "variou": [0, 16], "conveni": [0, 20], "featur": [0, 16, 20], "even": [0, 16, 20], "though": [0, 20], "veri": [0, 20], "mai": [0, 16, 20, 21], "obviou": [0, 20], "do": [0, 11, 16, 20, 21], "involv": [0, 18, 20], "interact": [0, 19, 20, 21], "background": [0, 20], "sync": [0, 20], "etc": [0, 16, 20], "keep": [0, 21], "mind": 0, "occur": 0, "while": [0, 16, 18], "f": [0, 16, 20, 21], "unreleas": 1, "13": [1, 2], "12": [1, 4], "11": [1, 20], "10": [1, 20, 21], "9": 1, "7": [1, 2], "6": [1, 2], "5": [1, 23], "4": [1, 3, 10, 14, 23], "2": [1, 5, 9, 18, 20, 21, 23], "initi": 2, "version": [2, 4, 5, 7, 8, 9, 13, 14, 18], "allow": [2, 16, 18, 21], "you": [2, 18, 20, 22], "insid": 2, "also": [2, 16, 21, 23], "bucket": [2, 3, 7, 8, 9, 10, 17, 19, 22, 23], "ad": [2, 3, 5, 7, 8, 9, 10, 12, 14, 16, 18], "fileobj": 2, "fileboj": 2, "29": 2, "add": [2, 5, 8, 10, 11, 12, 16], "sphinx": 2, "joblib": 2, "obj": 2, "languag": 2, "45": 2, "droid": 2, "github": [2, 14, 18, 23], "workflow": [2, 4, 14, 16, 18], "prepar": [2, 9], "49": 2, "complaint": 2, "regard": [2, 16, 21], "changelog": [2, 18], "47": 2, "15": 2, "dephel": 2, "depend": [2, 3, 5, 11, 12, 16, 21, 23], "becaus": [2, 7, 21], "maintain": [2, 16, 18], "anymor": 2, "42": 2, "move": 2, "exasol_data_science_utils_python": 2, "n": 2, "log": 3, "support": [3, 10, 12, 14, 16, 21], "overview": [3, 14, 23], "logger": [3, 20], "referenc": 3, "via": [3, 5, 16], "exasol": [3, 4, 5, 11, 12, 16, 18, 20, 21, 22, 23], "import": [3, 16, 20, 21, 22, 23], "get": [3, 20, 23], "getlogg": [3, 20], "For": [3, 16, 18, 21, 23], "most": [3, 21], "suffici": [3, 20], "configur": [3, 14, 23], "retriev": 3, "basicconfig": [3, 20, 21], "level": [3, 16, 20, 21], "info": [3, 20, 21], "pathlik": [3, 5], "describ": [3, 20], "design": 3, "document": [3, 23], "extract": 3, "bucketlik": 3, "path": [3, 4, 7, 8, 9, 17, 20, 21, 22], "factori": 3, "old": [3, 8, 11], "propag": 3, "flag": 3, "servic": [3, 10, 16, 19, 20, 23], "relock": 3, "abatilo": 3, "action": [3, 16, 18], "poetri": [3, 9, 13, 18], "v2": 3, "v3": 3, "setup": [3, 12, 23], "v5": 3, "build": [3, 7, 8], "section": [3, 12, 18, 23], "project": [3, 9, 11, 12], "pyproject": 3, "toml": 3, "restructur": 3, "packag": [3, 11, 18], "slc": 3, "python3": 3, "lockfil": [4, 14], "align": [4, 16], "toolbox": [4, 5, 12, 14], "139": 4, "archiv": 4, "bucketpath": [4, 6, 15, 16], "releas": [5, 22], "plugin": 5, "pytest_exasol_saa": 5, "replac": [5, 8, 18], "individu": 5, "fixtur": [5, 18], "those": [5, 20], "addition": 5, "fix": [5, 6, 12, 14, 18], "vulner": [5, 7, 11, 13], "cve": [5, 11, 13], "21503": 5, "transit": [5, 16], "black": 5, "24": 5, "35195": 5, "request": [5, 18, 21], "32": 5, "141": 5, "144": 5, "comment": [5, 16], "pytest": [5, 11], "147": 5, "156": 6, "introduc": [7, 16], "two": [7, 16, 18], "certain": [7, 21], "under": 7, "furthermor": [7, 8], "numpi": [7, 8], "against": [7, 18], "buffer": 7, "overflow": 7, "55": 7, "61": 7, "54": 7, "posixpath": 7, "convers": 7, "alter": 7, "session": 7, "58": [7, 13], "type": [7, 16, 21], "hint": 7, "51": 7, "bucketfsloc": [8, 9], "upgrad": 8, "generate_bucket_udf_path": 8, "bucketfsloct": 8, "addit": [8, 16, 18], "72": [8, 9], "63": 8, "correct": 8, "fileobject": 8, "mock": 8, "66": 8, "localf": 8, "74": 8, "53": 8, "again": [8, 21], "38": 8, "bash": 8, "script": [8, 20], "sphinx_github": 8, "page": 8, "migrat": 8, "nox": [8, 11, 18], "68": 8, "instal": 8, "instruct": 8, "readm": 8, "first": [9, 21], "pypi": [9, 18], "handl": [9, 16, 20, 21], "79": 9, "81": 9, "ci": 9, "prerequisit": 9, "adjust": [9, 16], "contributor": 9, "inform": [10, 16], "trigger": 10, "major": [11, 18, 21], "api": [11, 16, 19], "rework": 11, "still": [11, 18, 20, 21], "consid": [11, 16, 21], "deprec": 11, "futur": [11, 16, 21], "integr": [11, 16, 18], "more": [11, 21, 23], "easili": 11, "abil": 11, "standard": [11, 16], "built": 11, "mechan": 11, "achiev": [11, 18], "desir": 11, "outcom": 11, "without": [11, 20], "need": [11, 16, 18, 20, 21], "extend": [11, 16], "match": 11, "warn": 11, "issu": [11, 13, 16, 18], "evalu": 11, "42969": 11, "silenc": 11, "affect": 11, "our": [11, 13, 16], "nor": [11, 16], "pull": [11, 18], "check": [11, 13], "search": 11, "track": 11, "command": [12, 18], "develop": [12, 16], "guid": 12, "basic": [12, 23], "pre": 12, "commit": [12, 21], "hook": 12, "attent": [13, 16, 20, 21], "been": [13, 21], "address": [13, 16], "advis": 13, "own": 13, "scanner": 13, "trivi": 13, "intern": [13, 16, 21], "lock": [13, 16], "0286": 13, "23931": 13, "restrict": [13, 16, 21], "typeguard": [13, 14], "ssl": 14, "typo": 14, "60": 14, "pin": [14, 16], "158": 15, "oper": [15, 16], "__eq__": 15, "compar": 15, "diffrent": 16, "context": 16, "outsid": 16, "common": 16, "task": [16, 18], "pretti": 16, "tediou": 16, "due": [16, 21, 23], "fact": [16, 23], "know": 16, "concept": 16, "so": [16, 18, 21], "simplifi": 16, "streamlin": 16, "frequent": 16, "uniform": 16, "accross": 16, "actual": 16, "abstract": 16, "filesystem": 16, "part": 16, "share": 16, "howev": 16, "experi": [16, 21], "present": 16, "sever": [16, 21], "particularli": [16, 18], "term": 16, "versatil": 16, "eas": 16, "across": 16, "extern": 16, "dual": 16, "complex": [16, 23], "ineffici": 16, "especi": 16, "focus": 16, "manag": 16, "aim": 16, "ensur": [16, 20], "reflect": 16, "scope": 16, "These": [16, 21, 23], "relev": [16, 21, 23], "conceal": 16, "contextu": 16, "face": 16, "difficulti": 16, "switch": 16, "between": 16, "versu": 16, "dure": 16, "execut": [16, 18], "lack": 16, "seamless": 16, "hinder": 16, "product": [16, 21], "additon": 16, "inher": 16, "understood": 16, "tradit": 16, "absenc": 16, "complic": 16, "make": [16, 18], "cumbersom": 16, "time": [16, 21], "consum": 16, "forc": 16, "lower": 16, "counterintuit": 16, "notabl": 16, "underli": 16, "inconsist": 16, "pattern": [16, 20], "being": [16, 21], "To": [16, 18, 21], "identifi": 16, "layer": 16, "approach": 16, "modul": 16, "mirror": 16, "By": [16, 20], "adopt": 16, "proven": 16, "decis": 16, "leverag": 16, "intuit": 16, "model": 16, "fit": [16, 21], "requir": [16, 18, 21], "focu": 16, "essenti": [16, 20], "although": 16, "inspir": 16, "includ": [16, 20], "necessari": 16, "effect": 16, "diverg": 16, "area": 16, "tailor": 16, "enhanc": 16, "facilit": 16, "unifi": 16, "regardless": 16, "meet": 16, "uniqu": 16, "practic": 16, "improv": 16, "effici": [16, 21], "primari": 16, "additionali": 16, "wan": 16, "wide": 16, "implent": 16, "persist": 16, "process": [16, 18], "reduc": 16, "learn": 16, "curv": 16, "familiar": [16, 21], "sure": [16, 18], "behaviour": 16, "wherev": 16, "flexibl": [16, 21], "enough": 16, "accommod": 16, "divid": 16, "four": 16, "main": [16, 18], "central": 16, "opt": 16, "elimin": 16, "inherit": 16, "unnecessari": 16, "clear": 16, "least": 16, "purpos": 16, "capabl": 16, "plan": 16, "prevent": 16, "travers": [16, 21], "emul": 16, "custom": [16, 21], "behavior": 16, "natur": 16, "appropri": [16, 18], "Not": 16, "uniformli": 16, "applic": 16, "determin": 16, "openli": 16, "compil": 16, "straightforward": 16, "some": [16, 20, 21, 22], "aspect": 16, "fulli": 16, "feasibl": 16, "along": 16, "semant": 16, "signific": 16, "deviat": 16, "choos": 16, "distinct": [16, 21], "clariti": 16, "guidelin": 16, "embrac": 16, "convent": 16, "avoid": 16, "confus": 16, "terminologi": 16, "subsect": 16, "snippet": 16, "intend": 16, "primarili": 16, "refer": [16, 20], "therefor": [16, 21], "docstr": 16, "sudo": 16, "adapt": 16, "def": [16, 21], "self": 16, "pathslik": 16, "yiel": 16, "pathseg": 16, "overload": 16, "see": [16, 18], "__truediv__": 16, "other": [16, 20, 21], "member": 16, "clearli": 16, "implment": 16, "serv": 16, "bf": [16, 21], "bfss": 16, "accss": 16, "localpath": 16, "bfsl": 16, "encapsul": 16, "exactli": 16, "chang": [16, 18, 21], "potenti": 16, "rectrict": 16, "protect": [16, 18], "stop": 16, "proect": 16, "whith": 16, "proection": 16, "throw": 16, "pathbuild": 16, "credentails_stor": 16, "init": 16, "besid": 16, "credentail_stor": 16, "yet": [16, 18], "pleas": [16, 21, 23], "bellow": [16, 23], "tbd": 16, "alias": 16, "pass": 16, "__call__": 16, "assembl": 16, "apropri": 16, "_determine_typ": 16, "facori": 16, "_create_udf_path": 16, "_create_bucket_path": 16, "_create_chroot_path": 16, "tar": 16, "gz": 16, "http_bucket_path": 16, "8888": 16, "https_bucket_path": 16, "chroot_path": 16, "sub": 16, "subsub": 16, "readonly_path": 16, "ro": 16, "udfpath": 16, "git": 18, "bucketf": [18, 20, 22], "bfspy": 18, "declar": 18, "repositori": [18, 22], "pytest_saa": 18, "folder": 18, "test_saa": 18, "separ": [18, 21], "group": 18, "gate": 18, "g1": 18, "fast": 18, "cheap": 18, "push": 18, "your": [18, 20], "branch": 18, "g2": 18, "expens": 18, "manual": 18, "merg": 18, "enabl": 18, "cycl": 18, "failur": 18, "infrastructur": 18, "cost": 18, "temporarili": 18, "guard": 18, "dedic": 18, "enviro": 18, "befor": 18, "result": 18, "job": 18, "termin": 18, "succesfulli": 18, "scroll": 18, "pend": 18, "ask": 18, "click": 18, "link": 18, "detail": [18, 21, 23], "right": 18, "hand": 18, "side": 18, "review": [18, 21], "deplopy": 18, "checkbox": 18, "green": 18, "button": 18, "deploi": 18, "number": 18, "templat": 18, "autom": 18, "minor": 18, "patch": 18, "onc": [18, 21], "pr": 18, "next": 18, "tag": 18, "latest": [18, 19, 22], "master": 18, "further": 18, "cd": 18, "yml": 18, "x": 18, "y": 18, "z": 18, "origin": 18, "d": 18, "remot": 18, "begin": [18, 20], "finish": 18, "redo": 18, "scenario": 18, "publish": 18, "wa": [18, 21], "got": 18, "interrupt": 18, "solut": 18, "pip": 19, "found": [19, 21], "here": [19, 21], "come": [20, 21], "handi": 20, "localhost": [20, 21, 23], "6666": [20, 21, 23], "w": [20, 21, 23], "default_bucket": [20, 21, 23], "io": [20, 21], "65": [20, 21], "bin": [20, 21], "myfile1": 20, "rb": [20, 21], "destin": [20, 21], "file_lik": [20, 21], "bytesio": [20, 21], "conent": 20, "text": [20, 21], "abcd": [20, 21], "_": [20, 21], "rang": [20, 21, 23], "raw": [20, 21], "as_byt": [20, 21, 23], "as_fil": [20, 21], "myfil": [20, 21, 23], "my_utf8_str": [20, 21], "as_str": [20, 21], "utf8": [20, 21], "my_ascii_str": [20, 21], "ascii": [20, 21], "del": 20, "messag": 20, "correctli": 20, "proper": 20, "might": 20, "appear": 20, "expect": [20, 21], "explicityli": 20, "bucketfs_logg": 20, "notset": 20, "lot": 20, "approri": 20, "setlevel": 20, "debug": 20, "saasbucket": 21, "them": 21, "directli": 21, "demonstr": 21, "last": 21, "ident": 21, "myfile2": 21, "caller": 21, "recept": 21, "memori": 21, "prefer": 21, "tangibl": [21, 23], "as_hash": 21, "creation": 21, "o": 21, "let": 21, "assum": 21, "connect": 21, "environ": 21, "variabl": 21, "saas_url": 21, "saas_account_id": 21, "saas_database_id": 21, "saas_pat": 21, "feel": 21, "tutori": 21, "tempfil": 21, "build_path": 21, "take": 21, "docker": 21, "run": [21, 23], "machin": 21, "accord": 21, "better": 21, "secur": 21, "elif": 21, "els": 21, "runtimeerror": 21, "unknown": 21, "good": 21, "good_review": 21, "john_h_review": 21, "john": 21, "h": 21, "had": 21, "amaz": 21, "compani": 21, "notch": 21, "exceed": 21, "my": 21, "highli": 21, "recommend": 21, "anyon": 21, "qualiti": 21, "excel": 21, "sarah_l_review": 21, "sarah": 21, "l": 21, "am": 21, "repeat": 21, "busi": 21, "thei": 21, "never": 21, "disappoint": 21, "team": 21, "alwai": 21, "friendli": 21, "help": 21, "outstand": 21, "friend": 21, "famili": 21, "david_w_review": 21, "david": 21, "perfect": 21, "Their": 21, "satisfact": 21, "unparallel": 21, "now": 21, "bad": 21, "subdirectori": 21, "bad_review": 21, "previous": 21, "But": 21, "shown": 21, "temporaryfil": 21, "file_obj": 21, "began": 21, "unfortun": 21, "overwhelmingli": 21, "neg": 21, "bill": 21, "than": 21, "600": 21, "euro": 21, "vast": 21, "did": 21, "consent": 21, "were": 21, "carri": 21, "out": 21, "seek": 21, "mike_s_review": 21, "mike": 21, "posixpurepath": 21, "path_obj": 21, "tname": 21, "tsuffix": 21, "tparent": 21, "texist": 21, "tis_dir": 21, "tis_fil": 21, "find": 21, "whole": 21, "read_cont": 21, "bfs_path": 21, "item": 21, "said": 21, "all_review": 21, "node": [21, 23], "internod": 21, "synchronis": 21, "procedur": 21, "left": 21, "surpris": 21, "why": 21, "entiti": 21, "With": 22, "public": 22, "want": 22, "artefact": 22, "exasol_bucketfs_utils_python": 22, "github_release_file_bucketfs_upload": 22, "githubreleasefilebucketfsupload": 22, "release_upload": 22, "file_to_download_nam": 22, "github_us": 22, "repository_nam": 22, "release_nam": 22, "path_inside_bucket": 22, "port": 22, "straight": 23, "forward": 23, "fairli": 23, "worker": 23, "cluster": 23, "hold": 23, "tri": 23, "illustr": 23, "manner": 23, "advanc": 23, "artifact": 23}, "objects": {"exasol.bucketfs": [[0, 0, 1, "", "Bucket"], [0, 3, 1, "", "BucketFsError"], [0, 0, 1, "", "BucketLike"], [0, 0, 1, "", "MappedBucket"], [0, 0, 1, "", "MountedBucket"], [0, 0, 1, "", "SaaSBucket"], [0, 4, 1, "", "as_bytes"], [0, 4, 1, "", "as_file"], [0, 4, 1, "", "as_hash"], [0, 4, 1, "", "as_string"]], "exasol.bucketfs.Bucket": [[0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 2, 1, "", "udf_path"], [0, 1, 1, "", "upload"]], "exasol.bucketfs.BucketLike": [[0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 2, 1, "", "udf_path"], [0, 1, 1, "", "upload"]], "exasol.bucketfs.MappedBucket": [[0, 1, 1, "", "__init__"], [0, 2, 1, "", "chunk_size"]], "exasol.bucketfs.MountedBucket": [[0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 2, 1, "", "udf_path"], [0, 1, 1, "", "upload"]], "exasol.bucketfs.SaaSBucket": [[0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 2, 1, "", "udf_path"], [0, 1, 1, "", "upload"]], "exasol.bucketfs._path": [[0, 0, 1, "", "PathLike"], [0, 4, 1, "", "build_path"]], "exasol.bucketfs._path.PathLike": [[0, 1, 1, "", "as_udf_path"], [0, 1, 1, "", "as_uri"], [0, 1, 1, "", "exists"], [0, 1, 1, "", "is_dir"], [0, 1, 1, "", "is_file"], [0, 1, 1, "", "iterdir"], [0, 1, 1, "", "joinpath"], [0, 2, 1, "", "name"], [0, 2, 1, "", "parent"], [0, 1, 1, "", "read"], [0, 1, 1, "", "rm"], [0, 1, 1, "", "rmdir"], [0, 2, 1, "", "root"], [0, 2, 1, "", "suffix"], [0, 1, 1, "", "walk"], [0, 1, 1, "", "write"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:property", "3": "py:exception", "4": "py:function"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "property", "Python property"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"]}, "titleterms": {"api": 0, "refer": [0, 21], "exasol": [0, 19], "bucketf": [0, 2, 3, 7, 8, 9, 10, 11, 12, 13, 14, 16, 19, 21, 23], "servic": [0, 21], "bucketlik": 0, "bucket": [0, 16, 20, 21], "saasbucket": 0, "mountedbucket": 0, "path": [0, 16], "pathlik": [0, 16, 21], "build_path": 0, "as_byt": 0, "as_str": 0, "as_fil": 0, "as_hash": 0, "mappedbucket": [0, 20], "bucketfserror": 0, "chang": [1, 12], "util": [2, 7, 8, 16], "python": [2, 3, 7, 8, 9, 10, 11, 12, 13, 14], "0": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14], "1": 2, "releas": [2, 3, 7, 8, 9, 10, 11, 12, 13, 14, 18], "2022": [2, 7, 8, 9, 10, 11, 12], "01": 2, "18": 2, "summari": [2, 5, 7, 8, 9, 10, 11, 12, 13], "featur": [2, 3, 7, 8, 9, 10, 11, 14, 19], "enhanc": [2, 7, 8, 9, 10, 11], "bug": [2, 3, 4, 7, 8, 9], "fix": [2, 3, 4, 7, 8, 9], "document": [2, 5, 8, 9, 10, 11, 12, 14, 16, 17, 19], "refactor": [2, 5, 7, 8, 9, 11], "secur": [2, 5, 7, 11, 13], "10": [3, 10], "2024": [3, 4, 5, 6, 14], "05": [3, 4], "15": 3, "intern": [3, 4, 14], "11": [4, 5, 11], "23": 4, "12": [5, 10, 12], "07": [5, 6, 8], "13": 6, "08": 6, "bugfix": [6, 15], "2": 7, "04": 7, "29": 7, "3": 8, "20": 8, "4": 9, "09": 9, "28": 9, "5": 10, "6": 11, "7": 12, "22": 12, "8": 13, "2023": 13, "03": 13, "21": 13, "depend": [13, 14, 18], "9": 14, "02": 14, "16": 14, "unreleas": 15, "design": [16, 17], "": [16, 18, 21], "problem": 16, "descript": 16, "delimit": 16, "challeng": 16, "current": 16, "interact": 16, "propos": 16, "solut": 16, "desgin": 16, "goal": 16, "architectur": 16, "overview": 16, "interfac": [16, 21], "backend": 16, "extens": 16, "chroot": 16, "readonli": 16, "creation": 16, "detail": 16, "concret": 16, "modifi": 16, "factori": 16, "builder": 16, "exampl": 16, "develop": 18, "guid": [18, 23], "set": 18, "up": [18, 23], "workspac": 18, "checkout": 18, "project": 18, "instal": [18, 19], "setup": 18, "pre": 18, "commit": 18, "hook": 18, "test": 18, "pytest": 18, "plugin": 18, "run": 18, "ci": 18, "build": 18, "approv": 18, "slow": 18, "creat": [18, 21], "prepar": 18, "trigger": 18, "what": 18, "do": 18, "fail": 18, "The": [18, 20, 21], "dure": 18, "check": 18, "One": 18, "step": 18, "partial": 18, "prerequisit": 19, "advanc": 20, "list": [20, 21], "file": [20, 21], "upload": [20, 21], "download": [20, 21], "from": [20, 21], "delet": [20, 21], "configur": [20, 21], "log": [20, 21], "basic": 21, "get": 21, "class": 21, "avail": 21, "convert": 21, "object": 21, "saa": 21, "us": 21, "github": 22, "artifact": 22, "user": 23, "quickstart": 23, "follow": 23}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"\ud83e\uddf0 API Reference": [[0, "api-reference"]], "exasol.bucketfs.Service": [[0, "exasol-bucketfs-service"]], "exasol.bucketfs.BucketLike": [[0, "exasol-bucketfs-bucketlike"]], "exasol.bucketfs.Bucket": [[0, "exasol-bucketfs-bucket"]], "exasol.bucketfs.SaaSBucket": [[0, "exasol-bucketfs-saasbucket"]], "exasol.bucketfs.MountedBucket": [[0, "exasol-bucketfs-mountedbucket"]], "exasol.bucketfs.path.PathLike": [[0, "exasol-bucketfs-path-pathlike"]], "exasol.bucketfs.path.build_path": [[0, "exasol-bucketfs-path-build-path"]], "exasol.bucketfs.as_bytes": [[0, "exasol-bucketfs-as-bytes"]], "exasol.bucketfs.as_string": [[0, "exasol-bucketfs-as-string"]], "exasol.bucketfs.as_file": [[0, "exasol-bucketfs-as-file"]], "exasol.bucketfs.as_hash": [[0, "exasol-bucketfs-as-hash"]], "exasol.bucketfs.MappedBucket": [[0, "exasol-bucketfs-mappedbucket"]], "exasol.bucketfs.BucketFsError": [[0, "exasol-bucketfs-bucketfserror"]], "\ud83d\udcdd Changes": [[1, "changes"]], "BucketFs Utils Python 0.1.0, released 2022-01-18": [[2, "bucketfs-utils-python-0-1-0-released-2022-01-18"]], "Summary": [[2, "summary"], [5, "summary"], [7, "summary"], [8, "summary"], [9, "summary"], [10, "summary"], [11, "summary"], [12, "summary"], [13, "summary"]], "Features / Enhancements": [[2, "features-enhancements"], [7, "features-enhancements"], [8, "features-enhancements"], [9, "features-enhancements"], [10, "features-enhancements"], [11, "features-enhancements"]], "Bug Fixes": [[2, "bug-fixes"], [4, "bug-fixes"], [7, "bug-fixes"], [8, "bug-fixes"], [9, "bug-fixes"]], "Documentation": [[2, "documentation"], [5, "documentation"], [8, "documentation"], [9, "documentation"], [10, "documentation"], [11, "documentation"], [12, "documentation"], [14, "documentation"]], "Refactoring": [[2, "refactoring"], [7, "refactoring"], [8, "refactoring"], [9, "refactoring"], [11, "refactoring"]], "Security": [[2, "security"], [5, "security"], [7, "security"], [11, "security"], [13, "security"]], "BucketFs Python 0.10.0, released 2024-05-15": [[3, "bucketfs-python-0-10-0-released-2024-05-15"]], "Feature": [[3, "feature"], [14, "feature"]], "Bug Fixing": [[3, "bug-fixing"]], "Internal": [[3, "internal"], [4, "internal"], [14, "internal"]], "0.11.0 - 2024-05-23": [[4, "id1"]], "0.12.0 - 2024-07-11": [[5, "id1"]], "Refactorings": [[5, "refactorings"]], "0.13.0 - 2024-08-07": [[6, "id1"]], "Bugfixes": [[6, "bugfixes"], [15, "bugfixes"]], "BucketFs Utils Python 0.2.0, released 2022-04-29": [[7, "bucketfs-utils-python-0-2-0-released-2022-04-29"]], "BucketFs Utils Python 0.3.0, released 2022-07-20": [[8, "bucketfs-utils-python-0-3-0-released-2022-07-20"]], "BucketFs Python 0.4.0, released 2022-09-28": [[9, "bucketfs-python-0-4-0-released-2022-09-28"]], "BucketFs Python 0.5.0, released 2022-10-12": [[10, "bucketfs-python-0-5-0-released-2022-10-12"]], "BucketFs Python 0.6.0, released 2022-11-11": [[11, "bucketfs-python-0-6-0-released-2022-11-11"]], "BucketFs Python 0.7.0, released 2022-12-22": [[12, "bucketfs-python-0-7-0-released-2022-12-22"]], "Changes": [[12, "changes"]], "BucketFs Python 0.8.0, released 2023-03-21": [[13, "bucketfs-python-0-8-0-released-2023-03-21"]], "Dependencies": [[13, "dependencies"], [14, "dependencies"]], "BucketFs Python 0.9.0, released 2024-02-16": [[14, "bucketfs-python-0-9-0-released-2024-02-16"]], "Unreleased": [[15, "unreleased"]], "Design Document Bucket Path(s)": [[16, "design-document-bucket-path-s"]], "Problem Description": [[16, "problem-description"]], "Delimitation": [[16, "delimitation"]], "Challenges with Current BucketFS Interactions": [[16, "challenges-with-current-bucketfs-interactions"]], "Proposed Solution": [[16, "proposed-solution"]], "Desgin": [[16, "desgin"]], "Design Goals": [[16, "design-goals"]], "Architecture": [[16, "architecture"]], "Overview": [[16, "overview"]], "Interface": [[16, "interface"]], "Backends": [[16, "backends"]], "Extensions": [[16, "extensions"]], "Chroot": [[16, "chroot"]], "ReadOnly": [[16, "readonly"]], "Path Creation": [[16, "path-creation"]], "Detailed Design": [[16, "detailed-design"]], "Pathlike": [[16, "pathlike"]], "Concrete Paths (Backends)": [[16, "concrete-paths-backends"]], "Modifiers (Extensions)": [[16, "modifiers-extensions"]], "Factory & Builders": [[16, "factory-builders"]], "Examples": [[16, "examples"]], "Utilities": [[16, "utilities"]], "\ud83d\udcd1 Design Documents": [[17, "design-documents"]], "\ud83d\udee0 Developer Guide": [[18, "developer-guide"]], "Setting up the workspace": [[18, "setting-up-the-workspace"]], "Checkout the Project": [[18, "checkout-the-project"]], "Install project dependencies": [[18, "install-project-dependencies"]], "Setup pre-commit hook(s)": [[18, "setup-pre-commit-hook-s"]], "Tests": [[18, "tests"]], "Pytest Plugins": [[18, "pytest-plugins"]], "Running Tests in CI Builds": [[18, "running-tests-in-ci-builds"]], "Approving Slow Tests": [[18, "approving-slow-tests"]], "Creating a Release": [[18, "creating-a-release"]], "Prepare the Release": [[18, "prepare-the-release"]], "Triggering the Release": [[18, "triggering-the-release"]], "What to do if the release failed?": [[18, "what-to-do-if-the-release-failed"]], "The release failed during pre-release checks": [[18, "the-release-failed-during-pre-release-checks"]], "One of the release steps failed (Partial Release)": [[18, "one-of-the-release-steps-failed-partial-release"]], "Exasol Bucketfs": [[19, "exasol-bucketfs"]], "\ud83d\ude80 Features": [[19, "features"]], "\ud83d\udd0c\ufe0f Prerequisites": [[19, "prerequisites"]], "\ud83d\udcbe Installation": [[19, "installation"]], "\ud83d\udcda Documentation": [[19, "documentation"]], "Advanced": [[20, "advanced"]], "The MappedBucket": [[20, "the-mappedbucket"]], "List files in a Bucket": [[20, "list-files-in-a-bucket"], [21, "list-files-in-a-bucket"]], "Upload files to a Bucket": [[20, "upload-files-to-a-bucket"], [21, "upload-files-to-a-bucket"]], "Download files from a Bucket": [[20, "download-files-from-a-bucket"], [21, "download-files-from-a-bucket"]], "Delete files from Bucket": [[20, "delete-files-from-bucket"], [21, "delete-files-from-bucket"]], "Configure logging": [[20, "configure-logging"], [21, "configure-logging"]], "Basic\u2019s": [[21, "basic-s"]], "The Bucketfs Service": [[21, "the-bucketfs-service"]], "List buckets": [[21, "list-buckets"]], "Get a Bucket reference": [[21, "get-a-bucket-reference"]], "Bucket class": [[21, "bucket-class"]], "Available Converters": [[21, "available-converters"]], "Create bucket object in SaaS": [[21, "create-bucket-object-in-saas"]], "PathLike interface": [[21, "pathlike-interface"]], "Using the PathLike interface": [[21, "using-the-pathlike-interface"]], "Github Artifacts": [[22, "github-artifacts"]], "\ud83d\udc64 User Guide": [[23, "user-guide"]], "Bucketfs": [[23, "bucketfs"]], "Quickstart": [[23, "quickstart"]], "Follow Up": [[23, "follow-up"]]}, "indexentries": {"bucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.Bucket"]], "bucketfserror": [[0, "exasol.bucketfs.BucketFsError"]], "bucketlike (class in exasol.bucketfs)": [[0, "exasol.bucketfs.BucketLike"]], "mappedbucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.MappedBucket"]], "mountedbucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.MountedBucket"]], "pathlike (class in exasol.bucketfs._path)": [[0, "exasol.bucketfs._path.PathLike"]], "saasbucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.SaaSBucket"]], "__init__() (exasol.bucketfs.mappedbucket method)": [[0, "exasol.bucketfs.MappedBucket.__init__"]], "as_bytes() (in module exasol.bucketfs)": [[0, "exasol.bucketfs.as_bytes"]], "as_file() (in module exasol.bucketfs)": [[0, "exasol.bucketfs.as_file"]], "as_hash() (in module exasol.bucketfs)": [[0, "exasol.bucketfs.as_hash"]], "as_string() (in module exasol.bucketfs)": [[0, "exasol.bucketfs.as_string"]], "as_udf_path() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.as_udf_path"]], "as_uri() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.as_uri"]], "build_path() (in module exasol.bucketfs._path)": [[0, "exasol.bucketfs._path.build_path"]], "chunk_size (exasol.bucketfs.mappedbucket property)": [[0, "exasol.bucketfs.MappedBucket.chunk_size"]], "delete() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.delete"]], "delete() (exasol.bucketfs.bucketlike method)": [[0, "exasol.bucketfs.BucketLike.delete"]], "delete() (exasol.bucketfs.mountedbucket method)": [[0, "exasol.bucketfs.MountedBucket.delete"]], "delete() (exasol.bucketfs.saasbucket method)": [[0, "exasol.bucketfs.SaaSBucket.delete"]], "download() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.download"]], "download() (exasol.bucketfs.bucketlike method)": [[0, "exasol.bucketfs.BucketLike.download"]], "download() (exasol.bucketfs.mountedbucket method)": [[0, "exasol.bucketfs.MountedBucket.download"]], "download() (exasol.bucketfs.saasbucket method)": [[0, "exasol.bucketfs.SaaSBucket.download"]], "exists() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.exists"]], "files (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.files"]], "files (exasol.bucketfs.bucketlike property)": [[0, "exasol.bucketfs.BucketLike.files"]], "files (exasol.bucketfs.mountedbucket property)": [[0, "exasol.bucketfs.MountedBucket.files"]], "files (exasol.bucketfs.saasbucket property)": [[0, "exasol.bucketfs.SaaSBucket.files"]], "is_dir() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.is_dir"]], "is_file() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.is_file"]], "iterdir() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.iterdir"]], "joinpath() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.joinpath"]], "name (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.name"]], "name (exasol.bucketfs.bucketlike property)": [[0, "exasol.bucketfs.BucketLike.name"]], "name (exasol.bucketfs.mountedbucket property)": [[0, "exasol.bucketfs.MountedBucket.name"]], "name (exasol.bucketfs.saasbucket property)": [[0, "exasol.bucketfs.SaaSBucket.name"]], "name (exasol.bucketfs._path.pathlike property)": [[0, "exasol.bucketfs._path.PathLike.name"]], "parent (exasol.bucketfs._path.pathlike property)": [[0, "exasol.bucketfs._path.PathLike.parent"]], "read() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.read"]], "rm() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.rm"]], "rmdir() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.rmdir"]], "root (exasol.bucketfs._path.pathlike property)": [[0, "exasol.bucketfs._path.PathLike.root"]], "suffix (exasol.bucketfs._path.pathlike property)": [[0, "exasol.bucketfs._path.PathLike.suffix"]], "udf_path (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.udf_path"]], "udf_path (exasol.bucketfs.bucketlike property)": [[0, "exasol.bucketfs.BucketLike.udf_path"]], "udf_path (exasol.bucketfs.mountedbucket property)": [[0, "exasol.bucketfs.MountedBucket.udf_path"]], "udf_path (exasol.bucketfs.saasbucket property)": [[0, "exasol.bucketfs.SaaSBucket.udf_path"]], "upload() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.upload"]], "upload() (exasol.bucketfs.bucketlike method)": [[0, "exasol.bucketfs.BucketLike.upload"]], "upload() (exasol.bucketfs.mountedbucket method)": [[0, "exasol.bucketfs.MountedBucket.upload"]], "upload() (exasol.bucketfs.saasbucket method)": [[0, "exasol.bucketfs.SaaSBucket.upload"]], "walk() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.walk"]], "write() (exasol.bucketfs._path.pathlike method)": [[0, "exasol.bucketfs._path.PathLike.write"]]}})
\ No newline at end of file