This is an automated email from the ASF dual-hosted git repository.
domgarguilo 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 59b1c170a3 Update javadoc to indicate composite view returned or not
for Instance, Namespace and Table Operations (#4077)
59b1c170a3 is described below
commit 59b1c170a3d33123b56708bf47e3a61ae69fa40b
Author: Kevin Rathbun <43969518+kevinrr...@users.noreply.github.com>
AuthorDate: Fri Jan 5 11:13:20 2024 -0500
Update javadoc to indicate composite view returned or not for Instance,
Namespace and Table Operations (#4077)
---
.../core/client/admin/NamespaceOperations.java | 18 +++++++-------
.../core/client/admin/TableOperations.java | 28 ++++++++++++----------
2 files changed, 25 insertions(+), 21 deletions(-)
diff --git
a/core/src/main/java/org/apache/accumulo/core/client/admin/NamespaceOperations.java
b/core/src/main/java/org/apache/accumulo/core/client/admin/NamespaceOperations.java
index b82846bce6..8638eff354 100644
---
a/core/src/main/java/org/apache/accumulo/core/client/admin/NamespaceOperations.java
+++
b/core/src/main/java/org/apache/accumulo/core/client/admin/NamespaceOperations.java
@@ -184,9 +184,10 @@ public interface NamespaceOperations {
throws AccumuloException, AccumuloSecurityException,
NamespaceNotFoundException;
/**
- * Gets properties of a namespace, which are inherited by tables in this
namespace. Note that
- * recently changed properties may not be available immediately. Method calls
- * {@link #getConfiguration(String)} and then calls .entrySet() on the map.
+ * Gets a merged view of the properties of a namespace with its parent
configuration. These
+ * properties are inherited by tables in this namespace. Note that recently
changed properties may
+ * not be available immediately. Method calls {@link
#getConfiguration(String)} and then calls
+ * .entrySet() on the map.
*
* @param namespace the name of the namespace
* @return all properties visible by this namespace (system and per-table
properties). Note that
@@ -202,9 +203,9 @@ public interface NamespaceOperations {
}
/**
- * Gets properties of a namespace, which are inherited by tables in this
namespace. Note that
- * recently changed properties may not be available immediately. This new
method returns a Map
- * instead of an Iterable.
+ * Gets a merged view of the properties of a namespace with its parent
configuration. These
+ * properties are inherited by tables in this namespace. Note that recently
changed properties may
+ * not be available immediately. This method returns a Map instead of an
Iterable.
*
* @param namespace the name of the namespace
* @return all properties visible by this namespace (system and per-table
properties). Note that
@@ -218,8 +219,9 @@ public interface NamespaceOperations {
throws AccumuloException, AccumuloSecurityException,
NamespaceNotFoundException;
/**
- * Gets properties specific to this namespace. Note that recently changed
properties may not be
- * available immediately. This new method returns a Map instead of an
Iterable.
+ * Gets properties specific to this namespace. Note that this does not
return a merged view of the
+ * properties with its parent configuration. Also note that recently changed
properties may not be
+ * available immediately. This method returns a Map instead of an Iterable.
*
* @param namespace the name of the namespace
* @return per-table properties specific to this namespace. Note that
recently changed properties
diff --git
a/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java
b/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java
index 768d2b5dfd..eabafaaa37 100644
---
a/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java
+++
b/core/src/main/java/org/apache/accumulo/core/client/admin/TableOperations.java
@@ -553,11 +553,11 @@ public interface TableOperations {
throws AccumuloException, AccumuloSecurityException;
/**
- * Gets properties of a table. This operation is asynchronous and eventually
consistent. It is not
- * guaranteed that all tablets in a table will return the same values.
Within a few seconds
- * without another change, all tablets in a table should be consistent. The
clone table feature
- * can be used if consistency is required. Method calls {@link
#getConfiguration(String)} and then
- * calls .entrySet() on the map.
+ * Gets a merged view of the properties of a table with its parent
configuration. This operation
+ * is asynchronous and eventually consistent. It is not guaranteed that all
tablets in a table
+ * will return the same values. Within a few seconds without another change,
all tablets in a
+ * table should be consistent. The clone table feature can be used if
consistency is required.
+ * Method calls {@link #getConfiguration(String)} and then calls .entrySet()
on the map.
*
* @param tableName the name of the table
* @return all properties visible by this table (system and per-table
properties). Note that
@@ -571,10 +571,11 @@ public interface TableOperations {
}
/**
- * Gets properties of a table. This operation is asynchronous and eventually
consistent. It is not
- * guaranteed that all tablets in a table will return the same values.
Within a few seconds
- * without another change, all tablets in a table should be consistent. The
clone table feature
- * can be used if consistency is required. This new method returns a Map
instead of an Iterable.
+ * Gets a merged view of the properties of a table with its parent
configuration. This operation
+ * is asynchronous and eventually consistent. It is not guaranteed that all
tablets in a table
+ * will return the same values. Within a few seconds without another change,
all tablets in a
+ * table should be consistent. The clone table feature can be used if
consistency is required.
+ * This method returns a Map instead of an Iterable.
*
* @param tableName the name of the table
* @return all properties visible by this table (system and per-table
properties). Note that
@@ -586,10 +587,11 @@ public interface TableOperations {
throws AccumuloException, TableNotFoundException;
/**
- * Gets per-table properties of a table. This operation is asynchronous and
eventually consistent.
- * It is not guaranteed that all tablets in a table will return the same
values. Within a few
- * seconds without another change, all tablets in a table should be
consistent. The clone table
- * feature can be used if consistency is required.
+ * Gets per-table properties of a table. Note that this does not return a
merged view of the
+ * properties with its parent configuration. This operation is asynchronous
and eventually
+ * consistent. It is not guaranteed that all tablets in a table will return
the same values.
+ * Within a few seconds without another change, all tablets in a table
should be consistent. The
+ * clone table feature can be used if consistency is required.
*
* @param tableName the name of the table
* @return per-table properties visible by this table. Note that recently
changed properties may
