diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 90a0844d..2a644962 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/_static/pygments.css b/_static/pygments.css index d9a83a7b..c2e07c71 100644 --- a/_static/pygments.css +++ b/_static/pygments.css @@ -22,6 +22,7 @@ .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ .highlight .gd { color: #a40000 } /* Generic.Deleted */ .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ .highlight .gr { color: #ef2929 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ @@ -107,6 +108,7 @@ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ @@ -192,6 +194,7 @@ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: ital body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ diff --git a/api.html b/api.html index 8cff4692..b2496a81 100644 --- a/api.html +++ b/api.html @@ -221,8 +221,8 @@

🧰 API Reference#

-class exasol.bucketfs.Service(url: str, credentials: Optional[Mapping[str, Mapping[str, str]]] = None)[source]
-

Bases: object

+class exasol.bucketfs.Service(url: str, credentials: Optional[Mapping[str, Mapping[str, str]]] = None)[source] +

Bases: object

Provides a simple to use api to access a bucketfs service.

@@ -232,7 +232,7 @@

exasol.bucketfs.Service
-property buckets: MutableMapping[str, Bucket]
+property buckets: MutableMapping[str, Bucket]

List all available buckets.

@@ -243,11 +243,11 @@

exasol.bucketfs.Serviceexasol.bucketfs.Bucket#

-class exasol.bucketfs.Bucket(name: str, service: str, username: str, password: str)[source]#
-

Bases: object

+class exasol.bucketfs.Bucket(name: str, service: str, username: str, password: str)[source]# +

Bases: object

-delete(path) → None[source]#
+delete(path) → None[source]#

Deletes a specific file in this bucket.

Parameters:
@@ -261,7 +261,7 @@

exasol.bucketfs.Bucket
-download(path: str, chunk_size: int = 8192) → Iterable[ByteString][source]#
+download(path: str, chunk_size: int = 8192) → Iterable[ByteString][source]#

Downloads a specific file of this bucket.

Parameters:
@@ -278,17 +278,17 @@

exasol.bucketfs.Bucket
-property files: Iterable[str]#
+property files: Iterable[str]#

-property name: str#
+property name: str#
-upload(path: str, data: Union[ByteString, BinaryIO, Iterable[ByteString]]) → None[source]#
+upload(path: str, data: Union[ByteString, BinaryIO, Iterable[ByteString]]) → None[source]#

Uploads a file onto this bucket

Parameters:
@@ -307,7 +307,7 @@

exasol.bucketfs.Bucketexasol.bucketfs.as_bytes#

-exasol.bucketfs.as_bytes(chunks: Iterable[ByteString]) → ByteString[source]#
+exasol.bucketfs.as_bytes(chunks: Iterable[ByteString]) → ByteString[source]#

Transforms a set of byte chunks into a bytes like object.

Parameters:
@@ -324,7 +324,7 @@

exasol.bucketfs.as_bytes#

-exasol.bucketfs.as_string(chunks: Iterable[ByteString], encoding: str = 'utf-8') → str[source]#
+exasol.bucketfs.as_string(chunks: Iterable[ByteString], encoding: str = 'utf-8') → str[source]#

Transforms a set of byte chunks into a string.

Parameters:
@@ -344,7 +344,7 @@

exasol.bucketfs.as_string#

-exasol.bucketfs.as_file(chunks: Iterable[ByteString], filename: Union[str, Path]) → Path[source]#
+exasol.bucketfs.as_file(chunks: Iterable[ByteString], filename: Union[str, Path]) → Path[source]#

Transforms a set of byte chunks into a string.

Parameters:
@@ -364,7 +364,7 @@

exasol.bucketfs.as_fileexasol.bucketfs.as_hash#

-exasol.bucketfs.as_hash(chunks: Iterable[ByteString], algorithm: str = 'sha1') → ByteString[source]#
+exasol.bucketfs.as_hash(chunks: Iterable[ByteString], algorithm: str = 'sha1') → ByteString[source]#

Calculate the hash for a set of byte chunks.

Parameters:
@@ -384,8 +384,8 @@

exasol.bucketfs.as_hashexasol.bucketfs.MappedBucket#

-class exasol.bucketfs.MappedBucket(bucket: Bucket, chunk_size: int = 8192)[source]#
-

Bases: object

+class exasol.bucketfs.MappedBucket(bucket: Bucket, chunk_size: int = 8192)[source]# +

Bases: object

Wraps a bucket and provides various convenience features to it (e.g. index based access).

Attention

@@ -397,7 +397,7 @@

exasol.bucketfs.MappedBucket
-property chunk_size: int#
+property chunk_size: int#

Chunk size which will be used for downloads.