From 390d0a32b32cf9fc9ca26bad0af1f3c7759cf743 Mon Sep 17 00:00:00 2001 From: Theodore Tsirpanis Date: Thu, 16 May 2024 12:00:03 +0300 Subject: [PATCH] Update documentation of `vfs.gcs.project_id` to mention that it is only needed when creating buckets. (#4977) [SC-47367](https://app.shortcut.com/tiledb-inc/story/47367/update-documentation-of-vfs-gcs-project-id-to-mention-that-it-is-only-needed-when-creating-buckets) [This](https://github.com/TileDB-Inc/TileDB/blob/acfb4e8816ed9cdd858a5cb673a536ee40811aa1/tiledb/sm/filesystem/gcs.cc#L276-L277) is the only place this config option is used. [Bucket names are globally unique across projects.](https://cloud.google.com/storage/docs/buckets#considerations) --- TYPE: NO_HISTORY --- tiledb/api/c_api/config/config_api_external.h | 3 ++- tiledb/sm/cpp_api/config.h | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/tiledb/api/c_api/config/config_api_external.h b/tiledb/api/c_api/config/config_api_external.h index b4aaafca98f..e0d7035a519 100644 --- a/tiledb/api/c_api/config/config_api_external.h +++ b/tiledb/api/c_api/config/config_api_external.h @@ -389,7 +389,8 @@ TILEDB_EXPORT void tiledb_config_free(tiledb_config_t** config) TILEDB_NOEXCEPT; * attempts, in milliseconds. * **Default**: 60000 * - `vfs.gcs.project_id`
- * Set the GCS project id.
+ * Set the GCS project ID to create new buckets to. Not required unless you + * are going to use the VFS to create buckets.
* **Default**: "" * - `vfs.gcs.service_account_key`
* **Experimental**
diff --git a/tiledb/sm/cpp_api/config.h b/tiledb/sm/cpp_api/config.h index 2cb91cf1bda..5f4d9f1b3db 100644 --- a/tiledb/sm/cpp_api/config.h +++ b/tiledb/sm/cpp_api/config.h @@ -567,7 +567,8 @@ class Config { * attempts, in milliseconds. * **Default**: 60000 * - `vfs.gcs.project_id`
- * Set the GCS project id.
+ * Set the GCS project ID to create new buckets to. Not required unless you + * are going to use the VFS to create buckets.
* **Default**: "" * - `vfs.gcs.service_account_key`
* **Experimental**