docs - clarify wherever cache-size relates to number of entries

xtdb · Feb 1, 2022 · 411a349 · 411a349
1 parent da3dcd7
commit 411a349
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/docs/administration/modules/ROOT/pages/configuring.adoc b/docs/administration/modules/ROOT/pages/configuring.adoc
@@ -337,7 +337,7 @@ EDN::
 
 === Parameters
 
-* `entity-cache-size` (int, default 32768): query entity cache size.
+* `entity-cache-size` (int, default 32768): query entity cache size (number of entries, not bytes).
 * `query-timeout` (int, default 30000): query timeout in milliseconds.
 * `batch-size` (int, default 100): batch size of results.
 * `fn-allow-list` (xref:#fn-allowlist[`Predicate Allowlist`], default nil): list of allowed namespaces/functions in predicate functions.

diff --git a/docs/storage/modules/ROOT/pages/aws-s3.adoc b/docs/storage/modules/ROOT/pages/aws-s3.adoc
@@ -71,7 +71,7 @@ EDN::
 * `configurator` (xref:#configurator[`S3Configurator`])
 * `bucket` (string, required)
 * `prefix` (string): S3 key prefix
-* `cache-size` (int): size of in-memory document cache
+* `cache-size` (int): size of in-memory document cache (number of entries, not bytes)
 
 [#checkpoint-store]
 == Checkpoint store

diff --git a/docs/storage/modules/ROOT/pages/azure-blobs.adoc b/docs/storage/modules/ROOT/pages/azure-blobs.adoc
@@ -87,4 +87,4 @@ Then you need to create a SAS token for the Storage Account via the https://port
 * `sas-token` (string, required): 'shared access signature' for your chosen container.
 * `storage-account` (string, required)
 * `container` (string, required)
-* `cache-size` (int): size of in-memory document cache
+* `cache-size` (int): size of in-memory document cache (number of entries, not bytes)
diff --git a/docs/storage/modules/ROOT/pages/google-cloud-storage.adoc b/docs/storage/modules/ROOT/pages/google-cloud-storage.adoc
@@ -70,7 +70,7 @@ Follow the GCS https://github.com/googleapis/google-cloud-java#authentication[Au
 == Parameters
 
 * `root-path` (string/`Path`, required): path where documents will be stored, `gs://bucket/prefix`
-* `cache-size` (int): size of in-memory document cache
+* `cache-size` (int): size of in-memory document cache (number of entries, not bytes)
 * `pool-size` (int, default 4): size of thread-pool for GCS operations
 
 

diff --git a/docs/storage/modules/ROOT/pages/jdbc.adoc b/docs/storage/modules/ROOT/pages/jdbc.adoc
@@ -250,4 +250,4 @@ EDN::
 === Document store (`+xtdb.jdbc/->document-store+`)
 
 * `connection-pool`
-* `cache-size` (int): size of in-memory document cache
+* `cache-size` (int): size of in-memory document cache (number of entries, not bytes)