Backport to branch(3.10) : Add API doc for admin.repairTable method…

… for v3.X (#1354) Co-authored-by: Vincent Guilpain <[email protected]>
scalar-labs · Dec 7, 2023 · 0a6e325 · 0a6e325
1 parent 901ba47
commit 0a6e325
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/api-guide.md b/docs/api-guide.md
@@ -241,6 +241,19 @@ You can get table metadata as follows:
 // Get the table metadata for "ns.tbl".
 TableMetadata tableMetadata = admin.getTableMetadata("ns", "tbl");
 ```
+### Repair a table
+
+You can repair the table metadata of an existing table as follows:
+
+```java
+// Repair the table "ns.tbl" with options.
+TableMetadata tableMetadata =
+    TableMetadata.newBuilder()
+        ...
+        .build();
+Map<String, String> options = ...;
+admin.repairTable("ns", "tbl", tableMetadata, options);
+```
 
 ### Specify operations for the Coordinator table
 

diff --git a/docs/storage-abstraction.md b/docs/storage-abstraction.md
@@ -388,6 +388,20 @@ You can get table metadata as follows:
 TableMetadata tableMetadata = admin.getTableMetadata("ns", "tbl");
 ```
 
+### Repair a table
+
+You can repair the table metadata of an existing table as follows:
+
+```java
+// Repair the table "ns.tbl" with options.
+TableMetadata tableMetadata =
+    TableMetadata.newBuilder()
+        ...
+        .build();
+Map<String, String> options = ...;
+admin.repairTable("ns", "tbl", tableMetadata, options);
+```
+
 ### Implement CRUD operations
 
 The following sections describe CRUD operations.