(accumulo) branch 2.1 updated: rename DataLevel tableId() to metaTableId(), doc updates (#3941)

[edcoleman]

This is an automated email from the ASF dual-hosted git repository.

edcoleman pushed a commit to branch 2.1
in repository https://gitbox.apache.org/repos/asf/accumulo.git


The following commit(s) were added to refs/heads/2.1 by this push:
     new b652f1ee9e rename DataLevel tableId() to metaTableId(), doc updates 
(#3941)
b652f1ee9e is described below

commit b652f1ee9e64f65eb4a784e7813c2abbf8065380
Author: EdColeman <d...@etcoleman.com>
AuthorDate: Wed Nov 15 14:59:54 2023 -0500

    rename DataLevel tableId() to metaTableId(), doc updates (#3941)
    
    rename DataLevel tableId() to metaTableId(), doc updates
---
 .../org/apache/accumulo/core/metadata/schema/Ample.java     |  2 +-
 .../accumulo/core/metadata/schema/TabletsMetadata.java      | 13 +++++++++++++
 .../apache/accumulo/test/functional/GarbageCollectorIT.java |  4 ++--
 3 files changed, 16 insertions(+), 3 deletions(-)

diff --git 
a/core/src/main/java/org/apache/accumulo/core/metadata/schema/Ample.java 
b/core/src/main/java/org/apache/accumulo/core/metadata/schema/Ample.java
index 24327210b1..f7232d7865 100644
--- a/core/src/main/java/org/apache/accumulo/core/metadata/schema/Ample.java
+++ b/core/src/main/java/org/apache/accumulo/core/metadata/schema/Ample.java
@@ -98,7 +98,7 @@ public interface Ample {
     /**
      * @return The Id of the Accumulo table in which this data level stores 
its metadata.
      */
-    public TableId tableId() {
+    public TableId metaTableId() {
       if (id == null) {
         throw new UnsupportedOperationException();
       }
diff --git 
a/core/src/main/java/org/apache/accumulo/core/metadata/schema/TabletsMetadata.java
 
b/core/src/main/java/org/apache/accumulo/core/metadata/schema/TabletsMetadata.java
index 600e889f5e..5f8ce56a94 100644
--- 
a/core/src/main/java/org/apache/accumulo/core/metadata/schema/TabletsMetadata.java
+++ 
b/core/src/main/java/org/apache/accumulo/core/metadata/schema/TabletsMetadata.java
@@ -319,6 +319,12 @@ public class TabletsMetadata implements 
Iterable<TabletMetadata>, AutoCloseable
       return this;
     }
 
+    /**
+     * For a given data level, read all of its tablets metadata. For {@link 
DataLevel#USER} this
+     * will read tablet metadata from the accumulo.metadata table for all user 
tables. For
+     * {@link DataLevel#METADATA} this will read tablet metadata from the 
accumulo.root table. For
+     * {@link DataLevel#ROOT} this will read tablet metadata from Zookeeper.
+     */
     @Override
     public Options forLevel(DataLevel level) {
       this.level = level;
@@ -326,6 +332,13 @@ public class TabletsMetadata implements 
Iterable<TabletMetadata>, AutoCloseable
       return this;
     }
 
+    /**
+     * For a given table read all of its tablet metadata. If the table id is 
for a user table, then
+     * its metadata will be read from its section in the accumulo.metadata 
table. If the table id is
+     * for the accumulo.metadata table, then its metadata will be read from 
the accumulo.root table.
+     * If the table id is for the accumulo.root table, then its metadata will 
be read from
+     * zookeeper.
+     */
     @Override
     public TableRangeOptions forTable(TableId tableId) {
       this.level = DataLevel.of(tableId);
diff --git 
a/test/src/main/java/org/apache/accumulo/test/functional/GarbageCollectorIT.java
 
b/test/src/main/java/org/apache/accumulo/test/functional/GarbageCollectorIT.java
index b1372ac3ad..d7899e1a3b 100644
--- 
a/test/src/main/java/org/apache/accumulo/test/functional/GarbageCollectorIT.java
+++ 
b/test/src/main/java/org/apache/accumulo/test/functional/GarbageCollectorIT.java
@@ -291,7 +291,7 @@ public class GarbageCollectorIT extends ConfigurableMacBase 
{
   @Test
   public void testMetadataUniqueMutationDelete() throws Exception {
     killMacGc();
-    TableId tableId = DataLevel.USER.tableId();
+    TableId tableId = DataLevel.USER.metaTableId();
     log.info("Metadata GcCandidate Deletion test");
     log.info("GcCandidates will be added/removed from table: {}", 
DataLevel.METADATA.metaTable());
     createAndDeleteUniqueMutation(tableId, Ample.GcCandidateType.INUSE);
@@ -306,7 +306,7 @@ public class GarbageCollectorIT extends ConfigurableMacBase 
{
   @Test
   public void testRootUniqueMutationDelete() throws Exception {
     killMacGc();
-    TableId tableId = DataLevel.METADATA.tableId();
+    TableId tableId = DataLevel.METADATA.metaTableId();
     log.info("Root GcCandidate Deletion test");
     log.info("GcCandidates will be added but not removed from Zookeeper");