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 2019/10/31 20:36:11 UTC
[accumulo] branch 2.0 updated: Add example of client to javadoc
(#1404)
This is an automated email from the ASF dual-hosted git repository.
mmiller pushed a commit to branch 2.0
in repository https://gitbox.apache.org/repos/asf/accumulo.git
The following commit(s) were added to refs/heads/2.0 by this push:
new 963ce3f Add example of client to javadoc (#1404)
963ce3f is described below
commit 963ce3fb3d64794f0987796d8d7b88a6138f0042
Author: Mike Miller <mm...@apache.org>
AuthorDate: Thu Oct 31 16:36:02 2019 -0400
Add example of client to javadoc (#1404)
* Also add link to client properties
---
.../java/org/apache/accumulo/core/client/Accumulo.java | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/core/src/main/java/org/apache/accumulo/core/client/Accumulo.java b/core/src/main/java/org/apache/accumulo/core/client/Accumulo.java
index 8bca022..e580636 100644
--- a/core/src/main/java/org/apache/accumulo/core/client/Accumulo.java
+++ b/core/src/main/java/org/apache/accumulo/core/client/Accumulo.java
@@ -51,15 +51,26 @@ public final class Accumulo {
*
* <pre>
* <code>
+ * // Create client directly from connection information
* try (AccumuloClient client = Accumulo.newClient()
* .to(instanceName, zookeepers)
* .as(user, password).build())
* {
- * // use the client
+ * // use the client
+ * }
+ *
+ * // Create client using the instance name, zookeeper, and credentials from java properties or properties file
+ * try (AccumuloClient client = Accumulo.newClient()
+ * .from(properties).build())
+ * {
+ * // use the client
* }
* </code>
* </pre>
*
+ * For a list of all client properties see the documentation on the Accumulo website:
+ * https://accumulo.apache.org/docs/2.x/configuration/client-properties
+ *
* @return a builder object for Accumulo clients
*/
public static AccumuloClient.PropertyOptions<AccumuloClient> newClient() {
@@ -77,6 +88,9 @@ public final class Accumulo {
* </code>
* </pre>
*
+ * For a list of all client properties see the documentation on the Accumulo website:
+ * https://accumulo.apache.org/docs/2.x/configuration/client-properties
+ *
* @return a builder object for client Properties
*/
public static AccumuloClient.PropertyOptions<Properties> newClientProperties() {