diff --git a/.doctrees/changes/unreleased.doctree b/.doctrees/changes/unreleased.doctree
index 5cf23a81..095a388e 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 62a8a2f7..3055a667 100644
Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ
diff --git a/_sources/changes/unreleased.md.txt b/_sources/changes/unreleased.md.txt
index 176e7a47..c23a1406 100644
--- a/_sources/changes/unreleased.md.txt
+++ b/_sources/changes/unreleased.md.txt
@@ -20,6 +20,10 @@
 
     logging.basicConfig(level=logging.INFO)
     ```
+  
+- Support for viewing BucketFS as a directory
+
+   Added the Pathlike protocol as described in the [design document](../design/bucketpath.rst).
 
 
 ## Internal
diff --git a/changes/unreleased.html b/changes/unreleased.html
index b04f7330..1f41e70d 100644
--- a/changes/unreleased.html
+++ b/changes/unreleased.html
@@ -241,6 +241,9 @@ <h2>Added<a class="headerlink" href="#added" title="Permalink to this heading">#
 </pre></div>
 </div>
 </li>
+<li><p>Support for viewing BucketFS as a directory</p>
+<p>Added the Pathlike protocol as described in the <a class="reference internal" href="../design/bucketpath.html"><span class="doc std std-doc">design document</span></a>.</p>
+</li>
 </ul>
 </section>
 <section id="internal">
diff --git a/searchindex.js b/searchindex.js
index 6619dc2c..d6b83189 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["api", "changes/changelog", "changes/changes_0.1.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.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 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, 12], "url": [0, 5, 16, 17, 19], "str": [0, 12], "credenti": [0, 12, 16, 17, 19], "map": 0, "none": [0, 5, 12], "verifi": 0, "bool": [0, 12], "true": [0, 12], "sourc": [0, 3, 4, 18], "base": [0, 12], "object": [0, 2, 12, 16, 17], "provid": [0, 2, 7, 12, 16, 17], "simpl": [0, 12], "us": [0, 3, 7, 9, 11, 12, 17, 18], "access": [0, 6, 12], "list": [0, 3, 4, 6, 12, 15, 19], "all": [0, 6, 12, 15, 16, 19], "avail": [0, 6, 7, 19], "__init__": [0, 12], "creat": [0, 12], "new": [0, 3, 5, 7, 12, 14], "instanc": 0, "paramet": [0, 12], "e": [0, 9, 12], "g": [0, 9, 12], "http": [0, 12, 16, 17, 18, 19], "": [0, 5, 7, 13, 15, 18, 19], "127": [0, 12], "0": [0, 1, 11, 12, 14, 16, 17, 19], "1": [0, 1, 5, 11, 12, 16], "2580": 0, "A": [0, 12, 17], "contain": [0, 2, 17], "usernam": [0, 16, 17, 19], "password": [0, 16, 17, 18, 19], "bucket1": 0, "foo": 0, "bar": 0, "either": [0, 12], "boolean": 0, "which": [0, 7, 12, 14, 16, 17], "case": [0, 11, 12, 16, 17], "control": 0, "whether": 0, "we": [0, 3, 9, 12], "server": 0, "tl": [0, 10], "certif": 0, "string": [0, 2, 3, 5, 12, 16, 17], "must": [0, 12, 14], "path": [0, 3, 4, 5, 13, 16, 17, 18], "ca": 0, "bundl": 0, "default": [0, 12, 16, 17, 19], "properti": [0, 12], "mutablemap": 0, "name": [0, 2, 3, 4, 5, 12], "where": [0, 12, 16], "thi": [0, 2, 3, 4, 7, 12, 16, 17, 18, 19], "i": [0, 2, 4, 7, 12, 15, 16, 19], "host": [0, 17, 18], "authent": 0, "delet": [0, 3, 12, 14, 15, 19], "specif": [0, 3, 12], "file": [0, 2, 3, 12, 15, 18, 19], "point": [0, 12], "shall": [0, 12], "rais": [0, 12], "oper": [0, 12], "couldn": 0, "t": [0, 12], "execut": [0, 12], "successfulli": [0, 12, 14], "download": [0, 2, 15, 19], "chunk_siz": [0, 12], "int": [0, 12], "8192": [0, 12], "iter": [0, 12, 17], "bytestr": [0, 12], "return": [0, 12], "an": [0, 5, 12, 17, 18], "binari": 0, "chunk": [0, 12, 17], "repres": [0, 12], "upload": [0, 2, 4, 14, 15, 18, 19], "data": [0, 12, 16, 17, 19], "binaryio": [0, 12], "onto": 0, "associ": [0, 12], "raw": [0, 16, 17], "content": [0, 12, 16, 17, 19], "transform": 0, "set": [0, 12, 16, 17], "byte": [0, 16, 17], "like": [0, 9, 12, 16, 17], "concaten": 0, "singl": [0, 17], "continu": 0, "encod": [0, 16, 17], "utf": [0, 16, 17], "8": [0, 1, 4, 15, 16, 17], "convert": [0, 12], "represent": 0, "filenam": [0, 12, 16, 17], "written": 0, "algorithm": 0, "sha1": 0, "calcul": 0, "hash": 0, "input": [0, 5], "checksum": 0, "hex": 0, "digest": 0, "wrap": 0, "variou": [0, 12], "conveni": [0, 16], "featur": [0, 12, 16], "index": 0, "even": [0, 12, 16], "though": [0, 16], "veri": [0, 16], "interfac": 0, "function": [0, 12, 18], "should": [0, 11, 12, 16, 17], "care": 0, "mai": [0, 12, 16, 17], "obviou": [0, 16], "do": [0, 7, 12, 16], "involv": [0, 16], "interact": [0, 15, 16, 17], "background": [0, 16], "sync": [0, 16], "etc": [0, 12, 16], "keep": [0, 17], "mind": 0, "when": [0, 12, 17], "size": 0, "except": [0, 12], "arg": [0, 12], "kwarg": [0, 12], "error": [0, 12], "occur": 0, "while": [0, 12], "f": [0, 12, 16, 17], "unreleas": 1, "9": 1, "7": [1, 2], "6": [1, 2, 19], "5": [1, 19], "4": [1, 6, 10, 11, 14, 19], "3": [1, 12, 15, 16, 19], "2": [1, 5, 16, 19], "code": [2, 3, 4, 7, 8, 12], "initi": 2, "implement": [2, 12], "version": [2, 3, 4, 5, 9, 10, 14], "It": [2, 12, 16], "allow": [2, 12], "you": [2, 16, 18], "from": [2, 3, 4, 11, 12, 14, 15, 18, 19], "insid": 2, "udf": [2, 4, 5, 12], "altern": 2, "can": [2, 11, 12, 15, 17, 18, 19], "read": [2, 12], "also": [2, 12, 19], "local": [2, 12, 14], "bucket": [2, 3, 4, 5, 6, 13, 15, 18, 19], "system": [2, 10, 11, 12], "ad": [2, 3, 4, 5, 6, 8, 10, 12], "fileobj": 2, "fileboj": 2, "29": 2, "add": [2, 4, 6, 7, 8, 12], "sphinx": 2, "13": 2, "joblib": 2, "obj": 2, "languag": 2, "45": 2, "droid": 2, "github": [2, 10, 14, 19], "workflow": [2, 10, 12, 14], "prepar": [2, 5], "49": 2, "complaint": 2, "regard": [2, 12, 17], "changelog": [2, 14], "47": 2, "15": 2, "remov": [2, 3, 4, 7, 12], "dephel": 2, "depend": [2, 7, 8, 11, 12, 17, 19], "becaus": [2, 3], "maintain": [2, 12], "anymor": 2, "42": 2, "move": 2, "locat": [2, 12], "over": [2, 12], "exasol_data_science_utils_python": 2, "n": 2, "method": [3, 4, 5, 12], "introduc": [3, 12], "two": [3, 12], "certain": 3, "under": 3, "furthermor": [3, 4], "numpi": [3, 4], "build": [3, 4, 11], "against": 3, "buffer": 3, "overflow": 3, "vulner": [3, 7, 9], "55": 3, "61": 3, "54": 3, "posixpath": 3, "convers": 3, "alter": 3, "session": 3, "58": [3, 9], "type": [3, 12], "hint": 3, "51": 3, "bucketfsloc": [4, 5], "gener": [4, 5, 12, 16, 17], "upgrad": 4, "generate_bucket_udf_path": 4, "bucketfsloct": 4, "In": [4, 12, 14, 17], "addit": [4, 12], "ar": [4, 12, 16], "72": [4, 5], "63": 4, "correct": 4, "fileobject": 4, "mock": 4, "66": 4, "localf": 4, "74": 4, "53": 4, "again": 4, "38": 4, "replac": 4, "old": [4, 7], "bash": 4, "script": [4, 16], "sphinx_github": 4, "page": 4, "migrat": 4, "nox": [4, 7], "68": 4, "instal": 4, "instruct": 4, "readm": 4, "first": 5, "pypi": [5, 14], "test": 5, "handl": [5, 12, 16], "base_path": 5, "empti": [5, 12], "79": 5, "joinpath": [5, 12], "81": 5, "updat": [5, 8, 9, 10, 11], "poetri": [5, 9, 11, 14], "ci": [5, 14], "project": [5, 7, 8, 11], "prerequisit": 5, "adjust": [5, 12], "contributor": 5, "support": [6, 8, 10, 11, 12], "servic": [6, 12, 15, 16, 19], "inform": [6, 12], "how": 6, "trigger": 6, "doe": [7, 12], "major": 7, "api": [7, 12, 15], "rework": 7, "still": [7, 16, 17], "consid": [7, 12], "deprec": 7, "futur": [7, 12], "integr": [7, 12], "more": [7, 17, 19], "easili": 7, "abil": 7, "standard": [7, 12], "built": 7, "mechan": 7, "achiev": 7, "desir": 7, "outcom": 7, "without": [7, 16], "need": [7, 12, 14, 16], "extend": [7, 12], "exist": [7, 12], "entir": [7, 12], "match": [7, 14], "structur": [7, 12], "packag": [7, 11, 14], "exasol": [7, 8, 11, 12, 14, 16, 17, 18, 19], "warn": 7, "issu": [7, 9, 12, 14], "evalu": 7, "cve": [7, 9], "42969": 7, "silenc": 7, "The": [7, 11, 12, 15, 19], "affect": 7, "our": [7, 9, 12], "itself": [7, 12], "nor": [7, 12], "pull": 7, "librari": [7, 9, 12, 15, 16], "check": [7, 9], "search": 7, "pytest": 7, "track": 7, "toolbox": [8, 10], "fix": [8, 10, 14], "invalid": 8, "command": 8, "develop": [8, 12], "guid": 8, "exampl": [8, 10, 14, 18], "basic": [8, 19], "user": [8, 9, 12, 17, 18], "setup": [8, 11, 19], "section": [8, 11, 19], "pre": 8, "commit": 8, "hook": 8, "attent": [9, 12, 16], "have": [9, 12, 19], "been": 9, "address": [9, 12], "henc": 9, "advis": 9, "own": 9, "tree": [9, 12], "scanner": 9, "trivi": 9, "intern": [9, 12], "lock": [9, 12], "0286": 9, "23931": 9, "restrict": [9, 12, 17], "typeguard": [9, 10], "configur": [10, 11, 19], "ssl": 10, "valid": 10, "overview": [10, 11, 19], "typo": 10, "60": 10, "lockfil": 10, "pin": [10, 12], "log": [11, 14], "bucketf": [11, 14, 16, 18], "logger": [11, 16], "referenc": 11, "via": [11, 12], "import": [11, 12, 16, 17, 18, 19], "get": [11, 16, 19], "getlogg": [11, 16], "For": [11, 12, 14, 19], "most": [11, 17], "suffici": [11, 16], "just": [11, 12], "root": [11, 12, 16], "order": [11, 12, 14, 17], "retriev": 11, "basicconfig": [11, 16, 17], "level": [11, 12, 16, 17], "info": [11, 16, 17], "relock": 11, "abatilo": 11, "action": [11, 12, 14], "v2": 11, "v3": 11, "python": [11, 12, 14, 15, 16], "v5": 11, "pyproject": 11, "toml": 11, "restructur": 11, "diffrent": 12, "context": 12, "outsid": 12, "db": 12, "within": 12, "common": 12, "task": 12, "directori": 12, "pretti": 12, "tediou": 12, "due": [12, 19], "fact": [12, 19], "know": 12, "concept": 12, "so": 12, "simplifi": 12, "streamlin": 12, "frequent": 12, "uniform": 12, "accross": 12, "actual": 12, "behind": 12, "abstract": 12, "filesystem": 12, "part": 12, "share": 12, "its": 12, "howev": 12, "experi": 12, "present": 12, "sever": 12, "particularli": 12, "term": 12, "versatil": 12, "eas": 12, "across": 12, "differ": 12, "both": 12, "extern": 12, "databas": [12, 19], "defin": 12, "dual": 12, "mode": 12, "complex": [12, 19], "ineffici": 12, "especi": 12, "focus": 12, "manag": 12, "aim": 12, "ensur": [12, 16], "reflect": 12, "scope": 12, "These": 12, "relev": 12, "logic": 12, "conceal": 12, "end": 12, "contextu": 12, "face": 12, "difficulti": 12, "switch": 12, "between": 12, "versu": 12, "dure": 12, "lack": 12, "seamless": 12, "transit": 12, "hinder": 12, "product": 12, "additon": 12, "inher": 12, "understood": 12, "tradit": 12, "absenc": 12, "complic": 12, "make": 12, "what": 12, "cumbersom": 12, "time": 12, "consum": 12, "forc": 12, "lower": 12, "onli": 12, "counterintuit": 12, "There": 12, "notabl": 12, "underli": 12, "inconsist": 12, "pattern": [12, 16], "being": 12, "To": 12, "identifi": 12, "layer": 12, "approach": 12, "pathlib": 12, "modul": 12, "mirror": 12, "By": [12, 16], "adopt": 12, "similar": 12, "proven": 12, "decis": 12, "leverag": 12, "intuit": 12, "model": 12, "fit": 12, "requir": 12, "focu": 12, "essenti": [12, 16], "although": 12, "inspir": 12, "includ": [12, 16], "necessari": 12, "effect": 12, "diverg": 12, "area": 12, "tailor": 12, "enhanc": 12, "facilit": 12, "unifi": 12, "wai": 12, "regardless": 12, "meet": 12, "uniqu": 12, "practic": 12, "improv": 12, "effici": [12, 17], "primari": 12, "work": 12, "usag": [12, 17], "additionali": 12, "wan": 12, "compat": 12, "wide": 12, "possibl": 12, "implent": 12, "persist": 12, "process": [12, 14], "reduc": 12, "learn": 12, "curv": 12, "familiar": 12, "sure": 12, "behaviour": 12, "follow": [12, 16], "wherev": 12, "flexibl": [12, 17], "enough": 12, "accommod": 12, "divid": 12, "four": 12, "main": 12, "compon": 12, "central": 12, "protocol": 12, "opt": 12, "elimin": 12, "inherit": 12, "unnecessari": 12, "clear": 12, "specifi": 12, "least": 12, "one": [12, 17, 18, 19], "anoth": 12, "purpos": 12, "capabl": 12, "plan": 12, "prevent": 12, "travers": 12, "abov": 12, "emul": 12, "custom": 12, "behavior": 12, "natur": 12, "appropri": [12, 14], "Not": 12, "uniformli": 12, "applic": 12, "determin": 12, "uri": 12, "openli": 12, "compil": 12, "straightforward": 12, "align": 12, "some": [12, 16, 17, 18], "aspect": 12, "fulli": 12, "note": [12, 16], "feasibl": 12, "along": 12, "semant": 12, "signific": 12, "deviat": 12, "definit": 12, "choos": 12, "distinct": 12, "clariti": 12, "guidelin": 12, "embrac": 12, "convent": 12, "avoid": 12, "confus": 12, "terminologi": 12, "subsequ": 12, "subsect": 12, "snippet": 12, "intend": 12, "primarili": 12, "refer": [12, 16], "therefor": 12, "comment": 12, "docstr": 12, "sudo": 12, "adapt": 12, "def": 12, "final": 12, "exclud": 12, "drive": 12, "ani": 12, "suffix": 12, "parent": 12, "as_uri": 12, "reconstruct": 12, "is_dir": 12, "fals": 12, "kind": 12, "is_fil": 12, "regular": 12, "pathslik": 12, "yiel": 12, "notafileerror": 12, "filenotfounderror": 12, "If": 12, "write": [12, 16, 17, 19], "after": 12, "yield": 12, "alreadi": 12, "overwritten": 12, "writen": 12, "rm": 12, "otherwis": 12, "thrown": 12, "rmdir": 12, "recurs": 12, "stai": 12, "close": 12, "won": 12, "non": 12, "subdir": 12, "permissionerror": 12, "pathseg": 12, "call": 12, "equival": 12, "combin": 12, "each": [12, 19], "given": 12, "turn": 12, "walk": 12, "tupl": 12, "top": 12, "down": 12, "bottom": 12, "up": 12, "try": 12, "mimik": 12, "doc": [12, 16], "org": [12, 16], "html": [12, 16], "dirpath": 12, "dirnam": 12, "iterdir": 12, "noth": 12, "direct": 12, "children": 12, "overload": 12, "join": 12, "see": [12, 14], "__truediv__": 12, "member": 12, "indic": 12, "clearli": 12, "implment": 12, "bucketpath": 12, "serv": 12, "bf": 12, "bfss": 12, "accss": 12, "localpath": 12, "bfsl": 12, "encapsul": 12, "exactli": 12, "chang": [12, 14], "option": 12, "valu": 12, "other": [12, 16, 17], "potenti": 12, "self": 12, "rectrict": 12, "protect": 12, "stop": 12, "proect": 12, "whith": 12, "proection": 12, "throw": 12, "pathbuild": 12, "credentails_stor": 12, "init": 12, "besid": 12, "credentail_stor": 12, "yet": 12, "pleas": [12, 19], "bellow": [12, 19], "tbd": 12, "alias": 12, "pass": 12, "__call__": 12, "assembl": 12, "apropri": 12, "_determine_typ": 12, "facori": 12, "_create_udf_path": 12, "_create_bucket_path": 12, "_create_chroot_path": 12, "udf_path": 12, "tar": 12, "gz": 12, "http_bucket_path": 12, "8888": 12, "https_bucket_path": 12, "chroot_path": 12, "sub": 12, "subsub": 12, "readonly_path": 12, "ro": 12, "as_udf_path": 12, "udfpath": 12, "git": 14, "com": 14, "run": [14, 19], "date": 14, "latest": [14, 15, 18], "tag": 14, "changes_0": 14, "md": 14, "push": 14, "further": 14, "detail": [14, 19], "cd": 14, "yml": 14, "number": 14, "x": 14, "y": 14, "z": 14, "origin": 14, "d": 14, "remot": 14, "lead": 14, "start": 14, "begin": [14, 16], "finish": 14, "redo": 14, "manual": 14, "scenario": 14, "publish": 14, "wa": 14, "got": 14, "interrupt": 14, "solut": 14, "pip": 15, "found": 15, "here": 15, "describ": 16, "come": 16, "handi": 16, "localhost": [16, 17, 19], "6666": [16, 17, 19], "w": [16, 17, 19], "default_bucket": [16, 17, 19], "io": [16, 17], "65": [16, 17], "file1": [16, 17], "bin": [16, 17], "open": [16, 17, 18], "myfile1": 16, "txt": [16, 17, 19], "rb": [16, 17], "destin": [16, 17], "file_lik": [16, 17], "bytesio": [16, 17], "b": [16, 17, 19], "file2": [16, 17], "conent": 16, "text": [16, 17], "abcd": [16, 17], "_": [16, 17], "rang": [16, 17, 19], "10": [16, 17], "as_byt": [16, 17, 19], "as_fil": [16, 17], "myfil": [16, 17, 19], "my_utf8_str": [16, 17], "as_str": [16, 17], "utf8": [16, 17], "my_ascii_str": [16, 17], "ascii": [16, 17], "del": 16, "your": 16, "messag": 16, "those": 16, "correctli": 16, "proper": 16, "might": 16, "appear": 16, "expect": 16, "explicityli": 16, "bucketfs_logg": 16, "notset": 16, "11": 16, "lot": 16, "approri": 16, "setlevel": 16, "debug": 16, "multipl": 17, "request": 17, "myfile2": 17, "back": 17, "caller": 17, "recept": 17, "memori": 17, "prefer": 17, "tangibl": [17, 19], "as_hash": 17, "With": 18, "public": 18, "releas": 18, "want": 18, "artefact": 18, "repositori": 18, "exasol_bucketfs_utils_python": 18, "github_release_file_bucketfs_upload": 18, "githubreleasefilebucketfsupload": 18, "release_upload": 18, "file_to_download_nam": 18, "github_us": 18, "repository_nam": 18, "release_nam": 18, "path_inside_bucket": 18, "port": 18, "straight": 19, "forward": 19, "fairli": 19, "worker": 19, "cluster": 19, "node": 19, "hold": 19, "tri": 19, "illustr": 19, "manner": 19, "look": 19, "document": 19, "advanc": 19, "artifact": 19}, "objects": {"exasol.bucketfs": [[0, 0, 1, "", "Bucket"], [0, 3, 1, "", "BucketFsError"], [0, 0, 1, "", "MappedBucket"], [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, "", "__init__"], [0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 1, 1, "", "upload"]], "exasol.bucketfs.MappedBucket": [[0, 1, 1, "", "__init__"], [0, 2, 1, "", "chunk_size"]]}, "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, 17], "exasol": [0, 15], "bucketf": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 17, 19], "servic": [0, 17], "bucket": [0, 12, 16, 17], "as_byt": 0, "as_str": 0, "as_fil": 0, "as_hash": 0, "mappedbucket": [0, 16], "bucketfserror": 0, "chang": [1, 8], "util": [2, 3, 4, 12], "python": [2, 3, 4, 5, 6, 7, 8, 9, 10], "0": [2, 3, 4, 5, 6, 7, 8, 9, 10], "1": 2, "releas": [2, 3, 4, 5, 6, 7, 8, 9, 10, 14], "2022": [2, 3, 4, 5, 6, 7, 8], "01": 2, "18": 2, "summari": [2, 3, 4, 5, 6, 7, 8, 9], "featur": [2, 3, 4, 5, 6, 7, 10, 15], "enhanc": [2, 3, 4, 5, 6, 7], "bug": [2, 3, 4, 5], "fix": [2, 3, 4, 5], "document": [2, 4, 5, 6, 7, 8, 10, 12, 13, 15], "refactor": [2, 3, 4, 5, 7], "secur": [2, 3, 7, 9], "2": 3, "04": 3, "29": 3, "3": 4, "07": 4, "20": 4, "4": 5, "09": 5, "28": 5, "5": 6, "10": 6, "12": [6, 8], "6": 7, "11": 7, "7": 8, "22": 8, "8": 9, "2023": 9, "03": 9, "21": 9, "depend": [9, 10, 14], "9": 10, "2024": 10, "02": 10, "16": 10, "intern": [10, 11], "unreleas": 11, "ad": 11, "design": [12, 13], "path": 12, "": [12, 14, 17], "problem": 12, "descript": 12, "delimit": 12, "challeng": 12, "current": 12, "interact": 12, "propos": 12, "solut": 12, "desgin": 12, "goal": 12, "architectur": 12, "overview": 12, "interfac": 12, "backend": 12, "extens": 12, "chroot": 12, "readonli": 12, "creation": 12, "detail": 12, "pathlik": 12, "concret": 12, "modifi": 12, "factori": 12, "builder": 12, "exampl": 12, "develop": 14, "guid": [14, 19], "set": 14, "up": [14, 19], "workspac": 14, "checkout": 14, "project": 14, "instal": [14, 15], "setup": 14, "pre": 14, "commit": 14, "hook": 14, "creat": 14, "prerequisit": [14, 15], "trigger": 14, "what": 14, "do": 14, "fail": 14, "The": [14, 16, 17], "dure": 14, "check": 14, "One": 14, "step": 14, "partial": 14, "advanc": 16, "list": [16, 17], "file": [16, 17], "upload": [16, 17], "download": [16, 17], "from": [16, 17], "delet": [16, 17], "configur": [16, 17], "log": [16, 17], "basic": 17, "get": 17, "class": 17, "avail": 17, "convert": 17, "github": 18, "artifact": 18, "user": 19, "quickstart": 19, "follow": 19}, "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.Bucket": [[0, "exasol-bucketfs-bucket"]], "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"], [3, "summary"], [4, "summary"], [5, "summary"], [6, "summary"], [7, "summary"], [8, "summary"], [9, "summary"]], "Features / Enhancements": [[2, "features-enhancements"], [3, "features-enhancements"], [4, "features-enhancements"], [5, "features-enhancements"], [6, "features-enhancements"], [7, "features-enhancements"]], "Bug Fixes": [[2, "bug-fixes"], [3, "bug-fixes"], [4, "bug-fixes"], [5, "bug-fixes"]], "Documentation": [[2, "documentation"], [4, "documentation"], [5, "documentation"], [6, "documentation"], [7, "documentation"], [8, "documentation"], [10, "documentation"]], "Refactoring": [[2, "refactoring"], [3, "refactoring"], [4, "refactoring"], [5, "refactoring"], [7, "refactoring"]], "Security": [[2, "security"], [3, "security"], [7, "security"], [9, "security"]], "BucketFs Utils Python 0.2.0, released 2022-04-29": [[3, "bucketfs-utils-python-0-2-0-released-2022-04-29"]], "BucketFs Utils Python 0.3.0, released 2022-07-20": [[4, "bucketfs-utils-python-0-3-0-released-2022-07-20"]], "BucketFs Python 0.4.0, released 2022-09-28": [[5, "bucketfs-python-0-4-0-released-2022-09-28"]], "BucketFs Python 0.5.0, released 2022-10-12": [[6, "bucketfs-python-0-5-0-released-2022-10-12"]], "BucketFs Python 0.6.0, released 2022-11-11": [[7, "bucketfs-python-0-6-0-released-2022-11-11"]], "BucketFs Python 0.7.0, released 2022-12-22": [[8, "bucketfs-python-0-7-0-released-2022-12-22"]], "Changes": [[8, "changes"]], "BucketFs Python 0.8.0, released 2023-03-21": [[9, "bucketfs-python-0-8-0-released-2023-03-21"]], "Dependencies": [[9, "dependencies"], [10, "dependencies"]], "BucketFs Python 0.9.0, released 2024-02-16": [[10, "bucketfs-python-0-9-0-released-2024-02-16"]], "Feature": [[10, "feature"]], "Internal": [[10, "internal"], [11, "internal"]], "Unreleased": [[11, "unreleased"]], "Added": [[11, "added"]], "Design Document Bucket Path(s)": [[12, "design-document-bucket-path-s"]], "Problem Description": [[12, "problem-description"]], "Delimitation": [[12, "delimitation"]], "Challenges with Current BucketFS Interactions": [[12, "challenges-with-current-bucketfs-interactions"]], "Proposed Solution": [[12, "proposed-solution"]], "Desgin": [[12, "desgin"]], "Design Goals": [[12, "design-goals"]], "Architecture": [[12, "architecture"]], "Overview": [[12, "overview"]], "Interface": [[12, "interface"]], "Backends": [[12, "backends"]], "Extensions": [[12, "extensions"]], "Chroot": [[12, "chroot"]], "ReadOnly": [[12, "readonly"]], "Path Creation": [[12, "path-creation"]], "Detailed Design": [[12, "detailed-design"]], "Pathlike": [[12, "pathlike"]], "Concrete Paths (Backends)": [[12, "concrete-paths-backends"]], "Modifiers (Extensions)": [[12, "modifiers-extensions"]], "Factory & Builders": [[12, "factory-builders"]], "Examples": [[12, "examples"]], "Utilities": [[12, "utilities"]], "\ud83d\udcd1 Design Documents": [[13, "design-documents"]], "\ud83d\udee0 Developer Guide": [[14, "developer-guide"]], "Setting up the workspace": [[14, "setting-up-the-workspace"]], "Checkout the Project": [[14, "checkout-the-project"]], "Install project dependencies": [[14, "install-project-dependencies"]], "Setup pre-commit hook(s)": [[14, "setup-pre-commit-hook-s"]], "Creating a Release": [[14, "creating-a-release"]], "Prerequisites": [[14, "prerequisites"]], "Triggering the Release": [[14, "triggering-the-release"]], "What to do if the release failed?": [[14, "what-to-do-if-the-release-failed"]], "The release failed during pre-release checks": [[14, "the-release-failed-during-pre-release-checks"]], "One of the release steps failed (Partial Release)": [[14, "one-of-the-release-steps-failed-partial-release"]], "Exasol Bucketfs": [[15, "exasol-bucketfs"]], "\ud83d\ude80 Features": [[15, "features"]], "\ud83d\udd0c\ufe0f Prerequisites": [[15, "prerequisites"]], "\ud83d\udcbe Installation": [[15, "installation"]], "\ud83d\udcda Documentation": [[15, "documentation"]], "Advanced": [[16, "advanced"]], "The MappedBucket": [[16, "the-mappedbucket"]], "List files in a Bucket": [[16, "list-files-in-a-bucket"], [17, "list-files-in-a-bucket"]], "Upload files to a Bucket": [[16, "upload-files-to-a-bucket"], [17, "upload-files-to-a-bucket"]], "Download files from a Bucket": [[16, "download-files-from-a-bucket"], [17, "download-files-from-a-bucket"]], "Delete files from Bucket": [[16, "delete-files-from-bucket"], [17, "delete-files-from-bucket"]], "Configure logging": [[16, "configure-logging"], [17, "configure-logging"]], "Basic\u2019s": [[17, "basic-s"]], "The Bucketfs Service": [[17, "the-bucketfs-service"]], "List buckets": [[17, "list-buckets"]], "Get a Bucket reference": [[17, "get-a-bucket-reference"]], "Bucket class": [[17, "bucket-class"]], "Available Converters": [[17, "available-converters"]], "Github Artifacts": [[18, "github-artifacts"]], "\ud83d\udc64 User Guide": [[19, "user-guide"]], "Bucketfs": [[19, "bucketfs"]], "Quickstart": [[19, "quickstart"]], "Follow Up": [[19, "follow-up"]]}, "indexentries": {"bucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.Bucket"]], "bucketfserror": [[0, "exasol.bucketfs.BucketFsError"]], "mappedbucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.MappedBucket"]], "__init__() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.__init__"]], "__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"]], "chunk_size (exasol.bucketfs.mappedbucket property)": [[0, "exasol.bucketfs.MappedBucket.chunk_size"]], "delete() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.delete"]], "download() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.download"]], "files (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.files"]], "name (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.name"]], "upload() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.upload"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["api", "changes/changelog", "changes/changes_0.1.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.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 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, 12], "url": [0, 5, 16, 17, 19], "str": [0, 12], "credenti": [0, 12, 16, 17, 19], "map": 0, "none": [0, 5, 12], "verifi": 0, "bool": [0, 12], "true": [0, 12], "sourc": [0, 3, 4, 18], "base": [0, 12], "object": [0, 2, 12, 16, 17], "provid": [0, 2, 7, 12, 16, 17], "simpl": [0, 12], "us": [0, 3, 7, 9, 11, 12, 17, 18], "access": [0, 6, 12], "list": [0, 3, 4, 6, 12, 15, 19], "all": [0, 6, 12, 15, 16, 19], "avail": [0, 6, 7, 19], "__init__": [0, 12], "creat": [0, 12], "new": [0, 3, 5, 7, 12, 14], "instanc": 0, "paramet": [0, 12], "e": [0, 9, 12], "g": [0, 9, 12], "http": [0, 12, 16, 17, 18, 19], "": [0, 5, 7, 13, 15, 18, 19], "127": [0, 12], "0": [0, 1, 11, 12, 14, 16, 17, 19], "1": [0, 1, 5, 11, 12, 16], "2580": 0, "A": [0, 12, 17], "contain": [0, 2, 17], "usernam": [0, 16, 17, 19], "password": [0, 16, 17, 18, 19], "bucket1": 0, "foo": 0, "bar": 0, "either": [0, 12], "boolean": 0, "which": [0, 7, 12, 14, 16, 17], "case": [0, 11, 12, 16, 17], "control": 0, "whether": 0, "we": [0, 3, 9, 12], "server": 0, "tl": [0, 10], "certif": 0, "string": [0, 2, 3, 5, 12, 16, 17], "must": [0, 12, 14], "path": [0, 3, 4, 5, 13, 16, 17, 18], "ca": 0, "bundl": 0, "default": [0, 12, 16, 17, 19], "properti": [0, 12], "mutablemap": 0, "name": [0, 2, 3, 4, 5, 12], "where": [0, 12, 16], "thi": [0, 2, 3, 4, 7, 12, 16, 17, 18, 19], "i": [0, 2, 4, 7, 12, 15, 16, 19], "host": [0, 17, 18], "authent": 0, "delet": [0, 3, 12, 14, 15, 19], "specif": [0, 3, 12], "file": [0, 2, 3, 12, 15, 18, 19], "point": [0, 12], "shall": [0, 12], "rais": [0, 12], "oper": [0, 12], "couldn": 0, "t": [0, 12], "execut": [0, 12], "successfulli": [0, 12, 14], "download": [0, 2, 15, 19], "chunk_siz": [0, 12], "int": [0, 12], "8192": [0, 12], "iter": [0, 12, 17], "bytestr": [0, 12], "return": [0, 12], "an": [0, 5, 12, 17, 18], "binari": 0, "chunk": [0, 12, 17], "repres": [0, 12], "upload": [0, 2, 4, 14, 15, 18, 19], "data": [0, 12, 16, 17, 19], "binaryio": [0, 12], "onto": 0, "associ": [0, 12], "raw": [0, 16, 17], "content": [0, 12, 16, 17, 19], "transform": 0, "set": [0, 12, 16, 17], "byte": [0, 16, 17], "like": [0, 9, 12, 16, 17], "concaten": 0, "singl": [0, 17], "continu": 0, "encod": [0, 16, 17], "utf": [0, 16, 17], "8": [0, 1, 4, 15, 16, 17], "convert": [0, 12], "represent": 0, "filenam": [0, 12, 16, 17], "written": 0, "algorithm": 0, "sha1": 0, "calcul": 0, "hash": 0, "input": [0, 5], "checksum": 0, "hex": 0, "digest": 0, "wrap": 0, "variou": [0, 12], "conveni": [0, 16], "featur": [0, 12, 16], "index": 0, "even": [0, 12, 16], "though": [0, 16], "veri": [0, 16], "interfac": 0, "function": [0, 12, 18], "should": [0, 11, 12, 16, 17], "care": 0, "mai": [0, 12, 16, 17], "obviou": [0, 16], "do": [0, 7, 12, 16], "involv": [0, 16], "interact": [0, 15, 16, 17], "background": [0, 16], "sync": [0, 16], "etc": [0, 12, 16], "keep": [0, 17], "mind": 0, "when": [0, 12, 17], "size": 0, "except": [0, 12], "arg": [0, 12], "kwarg": [0, 12], "error": [0, 12], "occur": 0, "while": [0, 12], "f": [0, 12, 16, 17], "unreleas": 1, "9": 1, "7": [1, 2], "6": [1, 2, 19], "5": [1, 19], "4": [1, 6, 10, 11, 14, 19], "3": [1, 12, 15, 16, 19], "2": [1, 5, 16, 19], "code": [2, 3, 4, 7, 8, 12], "initi": 2, "implement": [2, 12], "version": [2, 3, 4, 5, 9, 10, 14], "It": [2, 12, 16], "allow": [2, 12], "you": [2, 16, 18], "from": [2, 3, 4, 11, 12, 14, 15, 18, 19], "insid": 2, "udf": [2, 4, 5, 12], "altern": 2, "can": [2, 11, 12, 15, 17, 18, 19], "read": [2, 12], "also": [2, 12, 19], "local": [2, 12, 14], "bucket": [2, 3, 4, 5, 6, 13, 15, 18, 19], "system": [2, 10, 11, 12], "ad": [2, 3, 4, 5, 6, 8, 10, 12], "fileobj": 2, "fileboj": 2, "29": 2, "add": [2, 4, 6, 7, 8, 12], "sphinx": 2, "13": 2, "joblib": 2, "obj": 2, "languag": 2, "45": 2, "droid": 2, "github": [2, 10, 14, 19], "workflow": [2, 10, 12, 14], "prepar": [2, 5], "49": 2, "complaint": 2, "regard": [2, 12, 17], "changelog": [2, 14], "47": 2, "15": 2, "remov": [2, 3, 4, 7, 12], "dephel": 2, "depend": [2, 7, 8, 11, 12, 17, 19], "becaus": [2, 3], "maintain": [2, 12], "anymor": 2, "42": 2, "move": 2, "locat": [2, 12], "over": [2, 12], "exasol_data_science_utils_python": 2, "n": 2, "method": [3, 4, 5, 12], "introduc": [3, 12], "two": [3, 12], "certain": 3, "under": 3, "furthermor": [3, 4], "numpi": [3, 4], "build": [3, 4, 11], "against": 3, "buffer": 3, "overflow": 3, "vulner": [3, 7, 9], "55": 3, "61": 3, "54": 3, "posixpath": 3, "convers": 3, "alter": 3, "session": 3, "58": [3, 9], "type": [3, 12], "hint": 3, "51": 3, "bucketfsloc": [4, 5], "gener": [4, 5, 12, 16, 17], "upgrad": 4, "generate_bucket_udf_path": 4, "bucketfsloct": 4, "In": [4, 12, 14, 17], "addit": [4, 12], "ar": [4, 12, 16], "72": [4, 5], "63": 4, "correct": 4, "fileobject": 4, "mock": 4, "66": 4, "localf": 4, "74": 4, "53": 4, "again": 4, "38": 4, "replac": 4, "old": [4, 7], "bash": 4, "script": [4, 16], "sphinx_github": 4, "page": 4, "migrat": 4, "nox": [4, 7], "68": 4, "instal": 4, "instruct": 4, "readm": 4, "first": 5, "pypi": [5, 14], "test": 5, "handl": [5, 12, 16], "base_path": 5, "empti": [5, 12], "79": 5, "joinpath": [5, 12], "81": 5, "updat": [5, 8, 9, 10, 11], "poetri": [5, 9, 11, 14], "ci": [5, 14], "project": [5, 7, 8, 11], "prerequisit": 5, "adjust": [5, 12], "contributor": 5, "support": [6, 8, 10, 11, 12], "servic": [6, 12, 15, 16, 19], "inform": [6, 12], "how": 6, "trigger": 6, "doe": [7, 12], "major": 7, "api": [7, 12, 15], "rework": 7, "still": [7, 16, 17], "consid": [7, 12], "deprec": 7, "futur": [7, 12], "integr": [7, 12], "more": [7, 17, 19], "easili": 7, "abil": 7, "standard": [7, 12], "built": 7, "mechan": 7, "achiev": 7, "desir": 7, "outcom": 7, "without": [7, 16], "need": [7, 12, 14, 16], "extend": [7, 12], "exist": [7, 12], "entir": [7, 12], "match": [7, 14], "structur": [7, 12], "packag": [7, 11, 14], "exasol": [7, 8, 11, 12, 14, 16, 17, 18, 19], "warn": 7, "issu": [7, 9, 12, 14], "evalu": 7, "cve": [7, 9], "42969": 7, "silenc": 7, "The": [7, 11, 12, 15, 19], "affect": 7, "our": [7, 9, 12], "itself": [7, 12], "nor": [7, 12], "pull": 7, "librari": [7, 9, 12, 15, 16], "check": [7, 9], "search": 7, "pytest": 7, "track": 7, "toolbox": [8, 10], "fix": [8, 10, 14], "invalid": 8, "command": 8, "develop": [8, 12], "guid": 8, "exampl": [8, 10, 14, 18], "basic": [8, 19], "user": [8, 9, 12, 17, 18], "setup": [8, 11, 19], "section": [8, 11, 19], "pre": 8, "commit": 8, "hook": 8, "attent": [9, 12, 16], "have": [9, 12, 19], "been": 9, "address": [9, 12], "henc": 9, "advis": 9, "own": 9, "tree": [9, 12], "scanner": 9, "trivi": 9, "intern": [9, 12], "lock": [9, 12], "0286": 9, "23931": 9, "restrict": [9, 12, 17], "typeguard": [9, 10], "configur": [10, 11, 19], "ssl": 10, "valid": 10, "overview": [10, 11, 19], "typo": 10, "60": 10, "lockfil": 10, "pin": [10, 12], "log": [11, 14], "bucketf": [11, 14, 16, 18], "logger": [11, 16], "referenc": 11, "via": [11, 12], "import": [11, 12, 16, 17, 18, 19], "get": [11, 16, 19], "getlogg": [11, 16], "For": [11, 12, 14, 19], "most": [11, 17], "suffici": [11, 16], "just": [11, 12], "root": [11, 12, 16], "order": [11, 12, 14, 17], "retriev": 11, "basicconfig": [11, 16, 17], "level": [11, 12, 16, 17], "info": [11, 16, 17], "view": 11, "directori": [11, 12], "pathlik": 11, "protocol": [11, 12], "describ": [11, 16], "design": 11, "document": [11, 19], "relock": 11, "abatilo": 11, "action": [11, 12, 14], "v2": 11, "v3": 11, "python": [11, 12, 14, 15, 16], "v5": 11, "pyproject": 11, "toml": 11, "restructur": 11, "diffrent": 12, "context": 12, "outsid": 12, "db": 12, "within": 12, "common": 12, "task": 12, "pretti": 12, "tediou": 12, "due": [12, 19], "fact": [12, 19], "know": 12, "concept": 12, "so": 12, "simplifi": 12, "streamlin": 12, "frequent": 12, "uniform": 12, "accross": 12, "actual": 12, "behind": 12, "abstract": 12, "filesystem": 12, "part": 12, "share": 12, "its": 12, "howev": 12, "experi": 12, "present": 12, "sever": 12, "particularli": 12, "term": 12, "versatil": 12, "eas": 12, "across": 12, "differ": 12, "both": 12, "extern": 12, "databas": [12, 19], "defin": 12, "dual": 12, "mode": 12, "complex": [12, 19], "ineffici": 12, "especi": 12, "focus": 12, "manag": 12, "aim": 12, "ensur": [12, 16], "reflect": 12, "scope": 12, "These": 12, "relev": 12, "logic": 12, "conceal": 12, "end": 12, "contextu": 12, "face": 12, "difficulti": 12, "switch": 12, "between": 12, "versu": 12, "dure": 12, "lack": 12, "seamless": 12, "transit": 12, "hinder": 12, "product": 12, "additon": 12, "inher": 12, "understood": 12, "tradit": 12, "absenc": 12, "complic": 12, "make": 12, "what": 12, "cumbersom": 12, "time": 12, "consum": 12, "forc": 12, "lower": 12, "onli": 12, "counterintuit": 12, "There": 12, "notabl": 12, "underli": 12, "inconsist": 12, "pattern": [12, 16], "being": 12, "To": 12, "identifi": 12, "layer": 12, "approach": 12, "pathlib": 12, "modul": 12, "mirror": 12, "By": [12, 16], "adopt": 12, "similar": 12, "proven": 12, "decis": 12, "leverag": 12, "intuit": 12, "model": 12, "fit": 12, "requir": 12, "focu": 12, "essenti": [12, 16], "although": 12, "inspir": 12, "includ": [12, 16], "necessari": 12, "effect": 12, "diverg": 12, "area": 12, "tailor": 12, "enhanc": 12, "facilit": 12, "unifi": 12, "wai": 12, "regardless": 12, "meet": 12, "uniqu": 12, "practic": 12, "improv": 12, "effici": [12, 17], "primari": 12, "work": 12, "usag": [12, 17], "additionali": 12, "wan": 12, "compat": 12, "wide": 12, "possibl": 12, "implent": 12, "persist": 12, "process": [12, 14], "reduc": 12, "learn": 12, "curv": 12, "familiar": 12, "sure": 12, "behaviour": 12, "follow": [12, 16], "wherev": 12, "flexibl": [12, 17], "enough": 12, "accommod": 12, "divid": 12, "four": 12, "main": 12, "compon": 12, "central": 12, "opt": 12, "elimin": 12, "inherit": 12, "unnecessari": 12, "clear": 12, "specifi": 12, "least": 12, "one": [12, 17, 18, 19], "anoth": 12, "purpos": 12, "capabl": 12, "plan": 12, "prevent": 12, "travers": 12, "abov": 12, "emul": 12, "custom": 12, "behavior": 12, "natur": 12, "appropri": [12, 14], "Not": 12, "uniformli": 12, "applic": 12, "determin": 12, "uri": 12, "openli": 12, "compil": 12, "straightforward": 12, "align": 12, "some": [12, 16, 17, 18], "aspect": 12, "fulli": 12, "note": [12, 16], "feasibl": 12, "along": 12, "semant": 12, "signific": 12, "deviat": 12, "definit": 12, "choos": 12, "distinct": 12, "clariti": 12, "guidelin": 12, "embrac": 12, "convent": 12, "avoid": 12, "confus": 12, "terminologi": 12, "subsequ": 12, "subsect": 12, "snippet": 12, "intend": 12, "primarili": 12, "refer": [12, 16], "therefor": 12, "comment": 12, "docstr": 12, "sudo": 12, "adapt": 12, "def": 12, "final": 12, "exclud": 12, "drive": 12, "ani": 12, "suffix": 12, "parent": 12, "as_uri": 12, "reconstruct": 12, "is_dir": 12, "fals": 12, "kind": 12, "is_fil": 12, "regular": 12, "pathslik": 12, "yiel": 12, "notafileerror": 12, "filenotfounderror": 12, "If": 12, "write": [12, 16, 17, 19], "after": 12, "yield": 12, "alreadi": 12, "overwritten": 12, "writen": 12, "rm": 12, "otherwis": 12, "thrown": 12, "rmdir": 12, "recurs": 12, "stai": 12, "close": 12, "won": 12, "non": 12, "subdir": 12, "permissionerror": 12, "pathseg": 12, "call": 12, "equival": 12, "combin": 12, "each": [12, 19], "given": 12, "turn": 12, "walk": 12, "tupl": 12, "top": 12, "down": 12, "bottom": 12, "up": 12, "try": 12, "mimik": 12, "doc": [12, 16], "org": [12, 16], "html": [12, 16], "dirpath": 12, "dirnam": 12, "iterdir": 12, "noth": 12, "direct": 12, "children": 12, "overload": 12, "join": 12, "see": [12, 14], "__truediv__": 12, "member": 12, "indic": 12, "clearli": 12, "implment": 12, "bucketpath": 12, "serv": 12, "bf": 12, "bfss": 12, "accss": 12, "localpath": 12, "bfsl": 12, "encapsul": 12, "exactli": 12, "chang": [12, 14], "option": 12, "valu": 12, "other": [12, 16, 17], "potenti": 12, "self": 12, "rectrict": 12, "protect": 12, "stop": 12, "proect": 12, "whith": 12, "proection": 12, "throw": 12, "pathbuild": 12, "credentails_stor": 12, "init": 12, "besid": 12, "credentail_stor": 12, "yet": 12, "pleas": [12, 19], "bellow": [12, 19], "tbd": 12, "alias": 12, "pass": 12, "__call__": 12, "assembl": 12, "apropri": 12, "_determine_typ": 12, "facori": 12, "_create_udf_path": 12, "_create_bucket_path": 12, "_create_chroot_path": 12, "udf_path": 12, "tar": 12, "gz": 12, "http_bucket_path": 12, "8888": 12, "https_bucket_path": 12, "chroot_path": 12, "sub": 12, "subsub": 12, "readonly_path": 12, "ro": 12, "as_udf_path": 12, "udfpath": 12, "git": 14, "com": 14, "run": [14, 19], "date": 14, "latest": [14, 15, 18], "tag": 14, "changes_0": 14, "md": 14, "push": 14, "further": 14, "detail": [14, 19], "cd": 14, "yml": 14, "number": 14, "x": 14, "y": 14, "z": 14, "origin": 14, "d": 14, "remot": 14, "lead": 14, "start": 14, "begin": [14, 16], "finish": 14, "redo": 14, "manual": 14, "scenario": 14, "publish": 14, "wa": 14, "got": 14, "interrupt": 14, "solut": 14, "pip": 15, "found": 15, "here": 15, "come": 16, "handi": 16, "localhost": [16, 17, 19], "6666": [16, 17, 19], "w": [16, 17, 19], "default_bucket": [16, 17, 19], "io": [16, 17], "65": [16, 17], "file1": [16, 17], "bin": [16, 17], "open": [16, 17, 18], "myfile1": 16, "txt": [16, 17, 19], "rb": [16, 17], "destin": [16, 17], "file_lik": [16, 17], "bytesio": [16, 17], "b": [16, 17, 19], "file2": [16, 17], "conent": 16, "text": [16, 17], "abcd": [16, 17], "_": [16, 17], "rang": [16, 17, 19], "10": [16, 17], "as_byt": [16, 17, 19], "as_fil": [16, 17], "myfil": [16, 17, 19], "my_utf8_str": [16, 17], "as_str": [16, 17], "utf8": [16, 17], "my_ascii_str": [16, 17], "ascii": [16, 17], "del": 16, "your": 16, "messag": 16, "those": 16, "correctli": 16, "proper": 16, "might": 16, "appear": 16, "expect": 16, "explicityli": 16, "bucketfs_logg": 16, "notset": 16, "11": 16, "lot": 16, "approri": 16, "setlevel": 16, "debug": 16, "multipl": 17, "request": 17, "myfile2": 17, "back": 17, "caller": 17, "recept": 17, "memori": 17, "prefer": 17, "tangibl": [17, 19], "as_hash": 17, "With": 18, "public": 18, "releas": 18, "want": 18, "artefact": 18, "repositori": 18, "exasol_bucketfs_utils_python": 18, "github_release_file_bucketfs_upload": 18, "githubreleasefilebucketfsupload": 18, "release_upload": 18, "file_to_download_nam": 18, "github_us": 18, "repository_nam": 18, "release_nam": 18, "path_inside_bucket": 18, "port": 18, "straight": 19, "forward": 19, "fairli": 19, "worker": 19, "cluster": 19, "node": 19, "hold": 19, "tri": 19, "illustr": 19, "manner": 19, "look": 19, "advanc": 19, "artifact": 19}, "objects": {"exasol.bucketfs": [[0, 0, 1, "", "Bucket"], [0, 3, 1, "", "BucketFsError"], [0, 0, 1, "", "MappedBucket"], [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, "", "__init__"], [0, 1, 1, "", "delete"], [0, 1, 1, "", "download"], [0, 2, 1, "", "files"], [0, 2, 1, "", "name"], [0, 1, 1, "", "upload"]], "exasol.bucketfs.MappedBucket": [[0, 1, 1, "", "__init__"], [0, 2, 1, "", "chunk_size"]]}, "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, 17], "exasol": [0, 15], "bucketf": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 15, 17, 19], "servic": [0, 17], "bucket": [0, 12, 16, 17], "as_byt": 0, "as_str": 0, "as_fil": 0, "as_hash": 0, "mappedbucket": [0, 16], "bucketfserror": 0, "chang": [1, 8], "util": [2, 3, 4, 12], "python": [2, 3, 4, 5, 6, 7, 8, 9, 10], "0": [2, 3, 4, 5, 6, 7, 8, 9, 10], "1": 2, "releas": [2, 3, 4, 5, 6, 7, 8, 9, 10, 14], "2022": [2, 3, 4, 5, 6, 7, 8], "01": 2, "18": 2, "summari": [2, 3, 4, 5, 6, 7, 8, 9], "featur": [2, 3, 4, 5, 6, 7, 10, 15], "enhanc": [2, 3, 4, 5, 6, 7], "bug": [2, 3, 4, 5], "fix": [2, 3, 4, 5], "document": [2, 4, 5, 6, 7, 8, 10, 12, 13, 15], "refactor": [2, 3, 4, 5, 7], "secur": [2, 3, 7, 9], "2": 3, "04": 3, "29": 3, "3": 4, "07": 4, "20": 4, "4": 5, "09": 5, "28": 5, "5": 6, "10": 6, "12": [6, 8], "6": 7, "11": 7, "7": 8, "22": 8, "8": 9, "2023": 9, "03": 9, "21": 9, "depend": [9, 10, 14], "9": 10, "2024": 10, "02": 10, "16": 10, "intern": [10, 11], "unreleas": 11, "ad": 11, "design": [12, 13], "path": 12, "": [12, 14, 17], "problem": 12, "descript": 12, "delimit": 12, "challeng": 12, "current": 12, "interact": 12, "propos": 12, "solut": 12, "desgin": 12, "goal": 12, "architectur": 12, "overview": 12, "interfac": 12, "backend": 12, "extens": 12, "chroot": 12, "readonli": 12, "creation": 12, "detail": 12, "pathlik": 12, "concret": 12, "modifi": 12, "factori": 12, "builder": 12, "exampl": 12, "develop": 14, "guid": [14, 19], "set": 14, "up": [14, 19], "workspac": 14, "checkout": 14, "project": 14, "instal": [14, 15], "setup": 14, "pre": 14, "commit": 14, "hook": 14, "creat": 14, "prerequisit": [14, 15], "trigger": 14, "what": 14, "do": 14, "fail": 14, "The": [14, 16, 17], "dure": 14, "check": 14, "One": 14, "step": 14, "partial": 14, "advanc": 16, "list": [16, 17], "file": [16, 17], "upload": [16, 17], "download": [16, 17], "from": [16, 17], "delet": [16, 17], "configur": [16, 17], "log": [16, 17], "basic": 17, "get": 17, "class": 17, "avail": 17, "convert": 17, "github": 18, "artifact": 18, "user": 19, "quickstart": 19, "follow": 19}, "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.Bucket": [[0, "exasol-bucketfs-bucket"]], "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"], [3, "summary"], [4, "summary"], [5, "summary"], [6, "summary"], [7, "summary"], [8, "summary"], [9, "summary"]], "Features / Enhancements": [[2, "features-enhancements"], [3, "features-enhancements"], [4, "features-enhancements"], [5, "features-enhancements"], [6, "features-enhancements"], [7, "features-enhancements"]], "Bug Fixes": [[2, "bug-fixes"], [3, "bug-fixes"], [4, "bug-fixes"], [5, "bug-fixes"]], "Documentation": [[2, "documentation"], [4, "documentation"], [5, "documentation"], [6, "documentation"], [7, "documentation"], [8, "documentation"], [10, "documentation"]], "Refactoring": [[2, "refactoring"], [3, "refactoring"], [4, "refactoring"], [5, "refactoring"], [7, "refactoring"]], "Security": [[2, "security"], [3, "security"], [7, "security"], [9, "security"]], "BucketFs Utils Python 0.2.0, released 2022-04-29": [[3, "bucketfs-utils-python-0-2-0-released-2022-04-29"]], "BucketFs Utils Python 0.3.0, released 2022-07-20": [[4, "bucketfs-utils-python-0-3-0-released-2022-07-20"]], "BucketFs Python 0.4.0, released 2022-09-28": [[5, "bucketfs-python-0-4-0-released-2022-09-28"]], "BucketFs Python 0.5.0, released 2022-10-12": [[6, "bucketfs-python-0-5-0-released-2022-10-12"]], "BucketFs Python 0.6.0, released 2022-11-11": [[7, "bucketfs-python-0-6-0-released-2022-11-11"]], "BucketFs Python 0.7.0, released 2022-12-22": [[8, "bucketfs-python-0-7-0-released-2022-12-22"]], "Changes": [[8, "changes"]], "BucketFs Python 0.8.0, released 2023-03-21": [[9, "bucketfs-python-0-8-0-released-2023-03-21"]], "Dependencies": [[9, "dependencies"], [10, "dependencies"]], "BucketFs Python 0.9.0, released 2024-02-16": [[10, "bucketfs-python-0-9-0-released-2024-02-16"]], "Feature": [[10, "feature"]], "Internal": [[10, "internal"], [11, "internal"]], "Unreleased": [[11, "unreleased"]], "Added": [[11, "added"]], "Design Document Bucket Path(s)": [[12, "design-document-bucket-path-s"]], "Problem Description": [[12, "problem-description"]], "Delimitation": [[12, "delimitation"]], "Challenges with Current BucketFS Interactions": [[12, "challenges-with-current-bucketfs-interactions"]], "Proposed Solution": [[12, "proposed-solution"]], "Desgin": [[12, "desgin"]], "Design Goals": [[12, "design-goals"]], "Architecture": [[12, "architecture"]], "Overview": [[12, "overview"]], "Interface": [[12, "interface"]], "Backends": [[12, "backends"]], "Extensions": [[12, "extensions"]], "Chroot": [[12, "chroot"]], "ReadOnly": [[12, "readonly"]], "Path Creation": [[12, "path-creation"]], "Detailed Design": [[12, "detailed-design"]], "Pathlike": [[12, "pathlike"]], "Concrete Paths (Backends)": [[12, "concrete-paths-backends"]], "Modifiers (Extensions)": [[12, "modifiers-extensions"]], "Factory & Builders": [[12, "factory-builders"]], "Examples": [[12, "examples"]], "Utilities": [[12, "utilities"]], "\ud83d\udcd1 Design Documents": [[13, "design-documents"]], "\ud83d\udee0 Developer Guide": [[14, "developer-guide"]], "Setting up the workspace": [[14, "setting-up-the-workspace"]], "Checkout the Project": [[14, "checkout-the-project"]], "Install project dependencies": [[14, "install-project-dependencies"]], "Setup pre-commit hook(s)": [[14, "setup-pre-commit-hook-s"]], "Creating a Release": [[14, "creating-a-release"]], "Prerequisites": [[14, "prerequisites"]], "Triggering the Release": [[14, "triggering-the-release"]], "What to do if the release failed?": [[14, "what-to-do-if-the-release-failed"]], "The release failed during pre-release checks": [[14, "the-release-failed-during-pre-release-checks"]], "One of the release steps failed (Partial Release)": [[14, "one-of-the-release-steps-failed-partial-release"]], "Exasol Bucketfs": [[15, "exasol-bucketfs"]], "\ud83d\ude80 Features": [[15, "features"]], "\ud83d\udd0c\ufe0f Prerequisites": [[15, "prerequisites"]], "\ud83d\udcbe Installation": [[15, "installation"]], "\ud83d\udcda Documentation": [[15, "documentation"]], "Advanced": [[16, "advanced"]], "The MappedBucket": [[16, "the-mappedbucket"]], "List files in a Bucket": [[16, "list-files-in-a-bucket"], [17, "list-files-in-a-bucket"]], "Upload files to a Bucket": [[16, "upload-files-to-a-bucket"], [17, "upload-files-to-a-bucket"]], "Download files from a Bucket": [[16, "download-files-from-a-bucket"], [17, "download-files-from-a-bucket"]], "Delete files from Bucket": [[16, "delete-files-from-bucket"], [17, "delete-files-from-bucket"]], "Configure logging": [[16, "configure-logging"], [17, "configure-logging"]], "Basic\u2019s": [[17, "basic-s"]], "The Bucketfs Service": [[17, "the-bucketfs-service"]], "List buckets": [[17, "list-buckets"]], "Get a Bucket reference": [[17, "get-a-bucket-reference"]], "Bucket class": [[17, "bucket-class"]], "Available Converters": [[17, "available-converters"]], "Github Artifacts": [[18, "github-artifacts"]], "\ud83d\udc64 User Guide": [[19, "user-guide"]], "Bucketfs": [[19, "bucketfs"]], "Quickstart": [[19, "quickstart"]], "Follow Up": [[19, "follow-up"]]}, "indexentries": {"bucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.Bucket"]], "bucketfserror": [[0, "exasol.bucketfs.BucketFsError"]], "mappedbucket (class in exasol.bucketfs)": [[0, "exasol.bucketfs.MappedBucket"]], "__init__() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.__init__"]], "__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"]], "chunk_size (exasol.bucketfs.mappedbucket property)": [[0, "exasol.bucketfs.MappedBucket.chunk_size"]], "delete() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.delete"]], "download() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.download"]], "files (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.files"]], "name (exasol.bucketfs.bucket property)": [[0, "exasol.bucketfs.Bucket.name"]], "upload() (exasol.bucketfs.bucket method)": [[0, "exasol.bucketfs.Bucket.upload"]]}})
\ No newline at end of file