You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by mm...@apache.org on 2018/10/03 21:14:13 UTC
[accumulo] branch master updated: Clarify RFile withTableProps
javadoc. Fixes #611 (#674)
This is an automated email from the ASF dual-hosted git repository.
mmiller pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/accumulo.git
The following commit(s) were added to refs/heads/master by this push:
new 5d3cbd4 Clarify RFile withTableProps javadoc. Fixes #611 (#674)
5d3cbd4 is described below
commit 5d3cbd493a6f9bed917e30fd63afe7d59b01dddd
Author: Mike Miller <mm...@apache.org>
AuthorDate: Wed Oct 3 17:13:59 2018 -0400
Clarify RFile withTableProps javadoc. Fixes #611 (#674)
---
.../main/java/org/apache/accumulo/core/client/rfile/RFile.java | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/core/src/main/java/org/apache/accumulo/core/client/rfile/RFile.java b/core/src/main/java/org/apache/accumulo/core/client/rfile/RFile.java
index cc5f23e..3538cbc 100644
--- a/core/src/main/java/org/apache/accumulo/core/client/rfile/RFile.java
+++ b/core/src/main/java/org/apache/accumulo/core/client/rfile/RFile.java
@@ -31,6 +31,7 @@ import org.apache.accumulo.core.client.summary.Summarizer;
import org.apache.accumulo.core.client.summary.SummarizerConfiguration;
import org.apache.accumulo.core.client.summary.Summary;
import org.apache.accumulo.core.client.summary.Summary.FileStatistics;
+import org.apache.accumulo.core.conf.Property;
import org.apache.accumulo.core.data.Key;
import org.apache.accumulo.core.data.Range;
import org.apache.accumulo.core.security.Authorizations;
@@ -171,7 +172,10 @@ public class RFile {
/**
* Construct the {@link Scanner} with iterators specified in a tables properties. Properties for
- * a table can be obtained by calling {@link TableOperations#getProperties(String)}
+ * a table can be obtained by calling {@link TableOperations#getProperties(String)}. Any
+ * property that impacts file behavior regardless of whether it has the
+ * {@link Property#TABLE_PREFIX} may be accepted and used. For example, cache and crypto
+ * properties could be passed here.
*
* @param props
* iterable over Accumulo table key value properties.
@@ -180,7 +184,9 @@ public class RFile {
ScannerOptions withTableProperties(Iterable<Entry<String,String>> props);
/**
- * @see #withTableProperties(Iterable)
+ * @see #withTableProperties(Iterable) Any property that impacts file behavior regardless of
+ * whether it has the {@link Property#TABLE_PREFIX} may be accepted and used. For example,
+ * cache and crypto properties could be passed here.
* @param props
* a map instead of an Iterable
* @return this