Add Javadoc for DistributedStorageAdmin
@@ -5,7 +5,41 @@ import java.util.Collections;
import java.util.Map;
import java.util.Set;
-/** An administrative interface for distributed storage implementations. */
+/**
+ * An administrative interface for distributed storage implementations. The user can execute
+ * administrative operations with it like createNamespace/createTable/getTableMetadata.
+ *
+ * <h3>Usage Examples</h3>
+ *
+ * Here is a simple example to demonstrate how to use it. (Exception handling is omitted for
+ * readability.)
+ *
+ * <pre>{@code
+ * StorageFactory factory = new StorageFactory(databaseConfig);
+ * DistributedStorageAdmin admin = factory.getAdmin();
+ *
+ * // Create a namespace
+ * admin.createNamespace(NAMESPACE);
+ *
+ * // Create a table
+ * TableMetadata tableMetadata = TableMetadata.newBuilder()
+ * ...
+ * .build();
+ * admin.createTable(NAMESPACE, TABLE, tableMetadata);
+ *
+ * // Get a table metadata
+ * tableMetadata = admin.getTableMetadata(NAMESPACE, TABLE);
+ *
+ * // Truncate a table
+ * admin.truncateTable(NAMESPACE, TABLE);
+ *
+ * // Drop a table
+ * admin.dropTable(NAMESPACE, TABLE);
+ *
+ * // Drop a namespace
+ * admin.dropNamespace(NAMESPACE);
+ * }</pre>
+ */
public interface DistributedStorageAdmin {
String INDEX_NAME_PREFIX = "index";
