Add tiledb_array_load_enumerations_all_schemas.

Author: shaunrd0

test/src/unit-cppapi-enumerations.cc

@@ -326,7 +326,7 @@ TEST_CASE_METHOD(
     CPPEnumerationFx,
     "C API: Array load_all_enumerations - Check nullptr",
     "[enumeration][array-load-all-enumerations][rest]") {
-  auto rc = tiledb_array_load_all_enumerations(ctx_.ptr().get(), nullptr, 0);
+  auto rc = tiledb_array_load_all_enumerations(ctx_.ptr().get(), nullptr);
   REQUIRE(rc != TILEDB_OK);
 }
 
@@ -364,7 +364,7 @@ TEST_CASE_METHOD(
   ase.add_attribute(attr4);
   ase.array_evolve(uri_);
   array.reopen();
-  ArrayExperimental::load_all_enumerations(ctx_, array, true);
+  ArrayExperimental::load_enumerations_all_schemas(ctx_, array);
   auto all_schemas = array.ptr()->array()->array_schemas_all();
   schema = array.load_schema(ctx_, uri_);
   std::string schema_name_2 = schema.ptr()->array_schema()->name();
@@ -390,7 +390,7 @@ TEST_CASE_METHOD(
   CHECK_NOTHROW(ase2.array_evolve(uri_));
   // Apply evolution to the array and reopen.
   CHECK_NOTHROW(array.reopen());
-  CHECK_NOTHROW(ArrayExperimental::load_all_enumerations(ctx_, array, true));
+  CHECK_NOTHROW(ArrayExperimental::load_enumerations_all_schemas(ctx_, array));
   all_schemas = array.ptr()->array()->array_schemas_all();
   schema = array.load_schema(ctx_, uri_);
   std::string schema_name_3 = schema.ptr()->array_schema()->name();
@@ -426,7 +426,7 @@ TEST_CASE_METHOD(
 
   // Apply evolution to the array and reopen.
   CHECK_NOTHROW(array.reopen());
-  CHECK_NOTHROW(ArrayExperimental::load_all_enumerations(ctx_, array, true));
+  CHECK_NOTHROW(ArrayExperimental::load_enumerations_all_schemas(ctx_, array));
   all_schemas = array.ptr()->array()->array_schemas_all();
   schema = array.load_schema(ctx_, uri_);
   std::string schema_name_4 = schema.ptr()->array_schema()->name();

tiledb/api/c_api/array/array_api.cc

@@ -657,10 +657,16 @@ capi_return_t tiledb_array_get_enumeration(
   return TILEDB_OK;
 }
 
-capi_return_t tiledb_array_load_all_enumerations(
-    const tiledb_array_t* array, uint8_t all_schemas) {
+capi_return_t tiledb_array_load_all_enumerations(const tiledb_array_t* array) {
   ensure_array_is_valid(array);
-  array->load_all_enumerations(all_schemas > 0);
+  array->load_all_enumerations();
+  return TILEDB_OK;
+}
+
+capi_return_t tiledb_array_load_enumerations_all_schemas(
+    const tiledb_array_t* array) {
+  ensure_array_is_valid(array);
+  array->load_all_enumerations(true);
   return TILEDB_OK;
 }
 
@@ -1051,8 +1057,15 @@ CAPI_INTERFACE(
 CAPI_INTERFACE(
     array_load_all_enumerations,
     tiledb_ctx_t* ctx,
-    const tiledb_array_t* array,
-    uint8_t all_schemas) {
+    const tiledb_array_t* array) {
   return api_entry_context<tiledb::api::tiledb_array_load_all_enumerations>(
-      ctx, array, all_schemas);
+      ctx, array);
+}
+
+CAPI_INTERFACE(
+    array_load_enumerations_all_schemas,
+    tiledb_ctx_t* ctx,
+    const tiledb_array_t* array) {
+  return api_entry_context<
+      tiledb::api::tiledb_array_load_enumerations_all_schemas>(ctx, array);
 }

tiledb/api/c_api/array/array_api_experimental.h

@@ -90,7 +90,7 @@ TILEDB_EXPORT capi_return_t tiledb_array_get_enumeration(
     tiledb_enumeration_t** enumeration) TILEDB_NOEXCEPT;
 
 /**
- * Load all enumerations for the array.
+ * Load all enumerations for the array's latest array schema.
  *
  * **Example:**
  *
@@ -100,14 +100,26 @@ TILEDB_EXPORT capi_return_t tiledb_array_get_enumeration(
  *
  * @param[in] ctx The TileDB context.
  * @param[in] array The TileDB array.
- * @param[in] latest_only If non-zero, only load enumerations for the latest
- * schema.
  * @return `TILEDB_OK` for success and `TILEDB_ERR` for error.
  */
 TILEDB_EXPORT capi_return_t tiledb_array_load_all_enumerations(
-    tiledb_ctx_t* ctx,
-    const tiledb_array_t* array,
-    uint8_t all_schemas) TILEDB_NOEXCEPT;
+    tiledb_ctx_t* ctx, const tiledb_array_t* array) TILEDB_NOEXCEPT;
+
+/**
+ * Load all enumerations for all schemas in the array.
+ *
+ * **Example:**
+ *
+ * @code{.c}
+ * tiledb_array_load_enumerations_all_schemas(ctx, array);
+ * @endcode
+ *
+ * @param[in] ctx The TileDB context.
+ * @param[in] array The TileDB array.
+ * @return `TILEDB_OK` for success and `TILEDB_ERR` for error.
+ */
+TILEDB_EXPORT capi_return_t tiledb_array_load_enumerations_all_schemas(
+    tiledb_ctx_t* ctx, const tiledb_array_t* array) TILEDB_NOEXCEPT;
 
 #ifdef __cplusplus
 }

tiledb/api/c_api/array/array_api_internal.h

@@ -150,8 +150,8 @@ struct tiledb_array_handle_t
   std::unordered_map<
       std::string,
       std::vector<shared_ptr<const tiledb::sm::Enumeration>>>
-  get_all_enumerations() {
-    return array_->get_all_enumerations();
+  get_enumerations_all_schemas() {
+    return array_->get_enumerations_all_schemas();
   }
 
   std::vector<shared_ptr<const tiledb::sm::Enumeration>> get_enumerations(

tiledb/sm/array/array.cc

@@ -822,7 +822,7 @@ shared_ptr<const Enumeration> Array::get_enumeration(
 }
 
 std::unordered_map<std::string, std::vector<shared_ptr<const Enumeration>>>
-Array::get_all_enumerations() {
+Array::get_enumerations_all_schemas() {
   if (!is_open_) {
     throw ArrayException("Unable to load enumerations; Array is not open.");
   }
@@ -977,7 +977,7 @@ void Array::load_all_enumerations(bool all_schemas) {
       throw_if_not_ok(config_.set("rest.use_refactored_array_open", "false"));
     }
 
-    get_all_enumerations();
+    get_enumerations_all_schemas();
   } else {
     get_enumerations(array_schema_latest().get_enumeration_names());
   }

tiledb/sm/array/array.h

@@ -569,7 +569,7 @@ class Array {
       EncryptionType* encryption_type);
 
   /**
-   * Get the enumeration for the given name.
+   * Get the enumeration for the given name from the latest array schema.
    *
    * This function retrieves the enumeration for the given name. If the
    * corresponding enumeration has not been loaded from storage it is
@@ -587,10 +587,10 @@ class Array {
    * @return Map of schema names and a list of all loaded enumerations.
    */
   std::unordered_map<std::string, std::vector<shared_ptr<const Enumeration>>>
-  get_all_enumerations();
+  get_enumerations_all_schemas();
 
   /**
-   * Get the enumerations with the given names.
+   * Get the enumerations with the given names from the latest array schema.
    *
    * This function retrieves the enumerations with the given names. If the
    * corresponding enumerations have not been loaded from storage they are

tiledb/sm/c_api/tiledb.cc

@@ -2202,7 +2202,7 @@ capi_return_t tiledb_handle_load_enumerations_request(
       std::vector<shared_ptr<const tiledb::sm::Enumeration>>>
       enumerations;
   if (enumeration_names.empty()) {
-    enumerations = array->get_all_enumerations();
+    enumerations = array->get_enumerations_all_schemas();
   } else {
     enumerations[array->array_schema_latest().name()] =
         array->get_enumerations(enumeration_names);

tiledb/sm/cpp_api/array_experimental.h

@@ -59,16 +59,26 @@ class ArrayExperimental {
   }
 
   /**
-   * Load all enumerations for the array.
+   * Load all enumerations for the array's latest array schema.
    *
    * @param ctx The context to use.
    * @param array The array to load enumerations for.
-   * @param all_schemas Whether or not to load enumerations on all schemas.
    */
-  static void load_all_enumerations(
-      const Context& ctx, const Array& array, bool all_schemas = false) {
-    ctx.handle_error(tiledb_array_load_all_enumerations(
-        ctx.ptr().get(), array.ptr().get(), all_schemas ? 1 : 0));
+  static void load_all_enumerations(const Context& ctx, const Array& array) {
+    ctx.handle_error(
+        tiledb_array_load_all_enumerations(ctx.ptr().get(), array.ptr().get()));
+  }
+
+  /**
+   * Load all enumerations for all schemas in the array.
+   *
+   * @param ctx The context to use.
+   * @param array The array to load enumerations for.
+   */
+  static void load_enumerations_all_schemas(
+      const Context& ctx, const Array& array) {
+    ctx.handle_error(tiledb_array_load_enumerations_all_schemas(
+        ctx.ptr().get(), array.ptr().get()));
   }
 };