Rename the API to the existing one

TileDB-Inc · May 30, 2024 · 2c08b88 · 2c08b88
1 parent 76dbda4
commit 2c08b88
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 14 deletions.
diff --git a/test/src/unit-capi-array_schema.cc b/test/src/unit-capi-array_schema.cc
@@ -927,7 +927,7 @@ void ArraySchemaFx::load_and_check_array_schema(const std::string& path) {
   fwrite(dump, sizeof(char), strlen(dump), gold_fout);
   fclose(gold_fout);
   FILE* fout = fopen("fout.txt", "w");
-  tiledb_array_schema_dump_file(ctx_, array_schema, fout);
+  tiledb_array_schema_dump(ctx_, array_schema, fout);
   fclose(fout);
 #ifdef _WIN32
   CHECK(!system("FC gold_fout.txt fout.txt > nul"));

diff --git a/test/src/unit-capi-fragment_info.cc b/test/src/unit-capi-fragment_info.cc
@@ -1495,14 +1495,11 @@ TEST_CASE("C API: Test fragment info, dump", "[capi][fragment_info][dump]") {
   FILE* frag2_schema_file = fopen("frag2_schema.txt", "w");
   FILE* frag3_schema_file = fopen("frag3_schema.txt", "w");
 
-  rc =
-      tiledb_array_schema_dump_file(ctx, frag1_array_schema, frag1_schema_file);
+  rc = tiledb_array_schema_dump(ctx, frag1_array_schema, frag1_schema_file);
   CHECK(rc == TILEDB_OK);
-  rc =
-      tiledb_array_schema_dump_file(ctx, frag2_array_schema, frag2_schema_file);
+  rc = tiledb_array_schema_dump(ctx, frag2_array_schema, frag2_schema_file);
   CHECK(rc == TILEDB_OK);
-  rc =
-      tiledb_array_schema_dump_file(ctx, frag3_array_schema, frag3_schema_file);
+  rc = tiledb_array_schema_dump(ctx, frag3_array_schema, frag3_schema_file);
   CHECK(rc == TILEDB_OK);
 
   fclose(frag1_schema_file);

diff --git a/tiledb/doxygen/source/c-api.rst b/tiledb/doxygen/source/c-api.rst
@@ -334,7 +334,7 @@ Array Schema
     :project: TileDB-C
 .. doxygenfunction:: tiledb_array_schema_has_attribute
     :project: TileDB-C
-.. doxygenfunction:: tiledb_array_schema_dump_file
+.. doxygenfunction:: tiledb_array_schema_dump
     :project: TileDB-C
 .. doxygenfunction:: tiledb_array_schema_dump_str
     :project: TileDB-C

diff --git a/tiledb/sm/c_api/tiledb.cc b/tiledb/sm/c_api/tiledb.cc
@@ -699,7 +699,7 @@ int32_t tiledb_array_schema_get_attribute_num(
   return TILEDB_OK;
 }
 
-int32_t tiledb_array_schema_dump_file(
+int32_t tiledb_array_schema_dump(
     tiledb_ctx_t* ctx, const tiledb_array_schema_t* array_schema, FILE* out) {
   if (sanity_check(ctx, array_schema) == TILEDB_ERR)
     return TILEDB_ERR;
@@ -5504,11 +5504,11 @@ CAPI_INTERFACE(
 }
 
 CAPI_INTERFACE(
-    array_schema_dump_file,
+    array_schema_dump,
     tiledb_ctx_t* ctx,
     const tiledb_array_schema_t* array_schema,
     FILE* out) {
-  return api_entry<tiledb::api::tiledb_array_schema_dump_file>(
+  return api_entry<tiledb::api::tiledb_array_schema_dump>(
       ctx, array_schema, out);
 }
 

diff --git a/tiledb/sm/c_api/tiledb.h b/tiledb/sm/c_api/tiledb.h
@@ -896,15 +896,15 @@ TILEDB_EXPORT int32_t tiledb_array_schema_has_attribute(
  * The following prints the array schema dump in standard output.
  *
  * @code{.c}
- * tiledb_array_schema_dump_file(ctx, array_schema, stdout);
+ * tiledb_array_schema_dump(ctx, array_schema, stdout);
  * @endcode
  *
  * @param ctx The TileDB context.
  * @param array_schema The array schema.
  * @param out The output file.
  * @return `TILEDB_OK` for success and `TILEDB_ERR` for error.
  */
-TILEDB_EXPORT int32_t tiledb_array_schema_dump_file(
+TILEDB_EXPORT int32_t tiledb_array_schema_dump(
     tiledb_ctx_t* ctx,
     const tiledb_array_schema_t* array_schema,
     FILE* out) TILEDB_NOEXCEPT;

diff --git a/tiledb/sm/cpp_api/array_schema.h b/tiledb/sm/cpp_api/array_schema.h
@@ -166,7 +166,7 @@ class ArraySchema : public Schema {
   void dump(FILE* out = nullptr) const override {
     auto& ctx = ctx_.get();
     ctx.handle_error(
-        tiledb_array_schema_dump_file(ctx.ptr().get(), schema_.get(), out));
+        tiledb_array_schema_dump(ctx.ptr().get(), schema_.get(), out));
   }
 
   void dump(std::string* out) const override {