http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4131cace/apache_hbase_reference_guide.pdfmarks ---------------------------------------------------------------------- diff --git a/apache_hbase_reference_guide.pdfmarks b/apache_hbase_reference_guide.pdfmarks index 97292fb..27b5c5a 100644 --- a/apache_hbase_reference_guide.pdfmarks +++ b/apache_hbase_reference_guide.pdfmarks @@ -2,8 +2,8 @@ /Author (Apache HBase Team) /Subject () /Keywords () - /ModDate (D:20160426145333) - /CreationDate (D:20160426145333) + /ModDate (D:20160427145329) + /CreationDate (D:20160427145329) /Creator (Asciidoctor PDF 1.5.0.alpha.6, based on Prawn 1.2.1) /Producer () /DOCINFO pdfmark
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4131cace/apidocs/index-all.html ---------------------------------------------------------------------- diff --git a/apidocs/index-all.html b/apidocs/index-all.html index 9cb4d80..9337528 100644 --- a/apidocs/index-all.html +++ b/apidocs/index-all.html @@ -5474,6 +5474,12 @@ </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/client/Admin.html#getOperationTimeout()">getOperationTimeout()</a></span> - Method in interface org.apache.hadoop.hbase.client.<a href="./org/apache/hadoop/hbase/client/Admin.html" title="interface in org.apache.hadoop.hbase.client">Admin</a></dt> <dd> </dd> +<dt><span class="strong"><a href="./org/apache/hadoop/hbase/client/Table.html#getOperationTimeout()">getOperationTimeout()</a></span> - Method in interface org.apache.hadoop.hbase.client.<a href="./org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></dt> +<dd> +<div class="block">Get timeout (millisecond) of each operation for in Table instance.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/hadoop/hbase/rest/client/RemoteHTable.html#getOperationTimeout()">getOperationTimeout()</a></span> - Method in class org.apache.hadoop.hbase.rest.client.<a href="./org/apache/hadoop/hbase/rest/client/RemoteHTable.html" title="class in org.apache.hadoop.hbase.rest.client">RemoteHTable</a></dt> +<dd> </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/filter/BitComparator.html#getOperator()">getOperator()</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="./org/apache/hadoop/hbase/filter/BitComparator.html" title="class in org.apache.hadoop.hbase.filter">BitComparator</a></dt> <dd> </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/filter/CompareFilter.html#getOperator()">getOperator()</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="./org/apache/hadoop/hbase/filter/CompareFilter.html" title="class in org.apache.hadoop.hbase.filter">CompareFilter</a></dt> @@ -5864,6 +5870,12 @@ </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html#getRowRanges()">getRowRanges()</a></span> - Method in class org.apache.hadoop.hbase.filter.<a href="./org/apache/hadoop/hbase/filter/MultiRowRangeFilter.html" title="class in org.apache.hadoop.hbase.filter">MultiRowRangeFilter</a></dt> <dd> </dd> +<dt><span class="strong"><a href="./org/apache/hadoop/hbase/client/Table.html#getRpcTimeout()">getRpcTimeout()</a></span> - Method in interface org.apache.hadoop.hbase.client.<a href="./org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></dt> +<dd> +<div class="block">Get timeout (millisecond) of each rpc request in this Table instance.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/hadoop/hbase/rest/client/RemoteHTable.html#getRpcTimeout()">getRpcTimeout()</a></span> - Method in class org.apache.hadoop.hbase.rest.client.<a href="./org/apache/hadoop/hbase/rest/client/RemoteHTable.html" title="class in org.apache.hadoop.hbase.rest.client">RemoteHTable</a></dt> +<dd> </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/ServerLoad.html#getRsCoprocessors()">getRsCoprocessors()</a></span> - Method in class org.apache.hadoop.hbase.<a href="./org/apache/hadoop/hbase/ServerLoad.html" title="class in org.apache.hadoop.hbase">ServerLoad</a></dt> <dd> <div class="block">Return the RegionServer-level and Region-level coprocessors</div> @@ -6714,11 +6726,11 @@ </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/HConstants.html#HBASE_CLIENT_META_OPERATION_TIMEOUT">HBASE_CLIENT_META_OPERATION_TIMEOUT</a></span> - Static variable in class org.apache.hadoop.hbase.<a href="./org/apache/hadoop/hbase/HConstants.html" title="class in org.apache.hadoop.hbase">HConstants</a></dt> <dd> -<div class="block">Parameter name for HBase client operation timeout, which overrides RPC timeout</div> +<div class="block">Parameter name for HBase client operation timeout.</div> </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/HConstants.html#HBASE_CLIENT_OPERATION_TIMEOUT">HBASE_CLIENT_OPERATION_TIMEOUT</a></span> - Static variable in class org.apache.hadoop.hbase.<a href="./org/apache/hadoop/hbase/HConstants.html" title="class in org.apache.hadoop.hbase">HConstants</a></dt> <dd> -<div class="block">Parameter name for HBase client operation timeout, which overrides RPC timeout</div> +<div class="block">Parameter name for HBase client operation timeout.</div> </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/HConstants.html#HBASE_CLIENT_PAUSE">HBASE_CLIENT_PAUSE</a></span> - Static variable in class org.apache.hadoop.hbase.<a href="./org/apache/hadoop/hbase/HConstants.html" title="class in org.apache.hadoop.hbase">HConstants</a></dt> <dd> @@ -12247,6 +12259,13 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> <dd> <div class="block">Update the beginning of this range.</div> </dd> +<dt><span class="strong"><a href="./org/apache/hadoop/hbase/client/Table.html#setOperationTimeout(int)">setOperationTimeout(int)</a></span> - Method in interface org.apache.hadoop.hbase.client.<a href="./org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></dt> +<dd> +<div class="block">Set timeout (millisecond) of each operation in this Table instance, will override the value + of hbase.client.operation.timeout in configuration.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/hadoop/hbase/rest/client/RemoteHTable.html#setOperationTimeout(int)">setOperationTimeout(int)</a></span> - Method in class org.apache.hadoop.hbase.rest.client.<a href="./org/apache/hadoop/hbase/rest/client/RemoteHTable.html" title="class in org.apache.hadoop.hbase.rest.client">RemoteHTable</a></dt> +<dd> </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/HTableDescriptor.html#setOwner(org.apache.hadoop.hbase.security.User)">setOwner(User)</a></span> - Method in class org.apache.hadoop.hbase.<a href="./org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a></dt> <dd> <div class="block"><span class="strong">Deprecated.</span></div> @@ -12359,6 +12378,13 @@ Input/OutputFormats, a table indexing MapReduce job, and utility methods.</div> <div class="block">Set a filter (using stopRow and startRow) so the result set only contains rows where the rowKey starts with the specified prefix.</div> </dd> +<dt><span class="strong"><a href="./org/apache/hadoop/hbase/client/Table.html#setRpcTimeout(int)">setRpcTimeout(int)</a></span> - Method in interface org.apache.hadoop.hbase.client.<a href="./org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></dt> +<dd> +<div class="block">Set timeout (millisecond) of each rpc request in operations of this Table instance, will + override the value of hbase.rpc.timeout in configuration.</div> +</dd> +<dt><span class="strong"><a href="./org/apache/hadoop/hbase/rest/client/RemoteHTable.html#setRpcTimeout(int)">setRpcTimeout(int)</a></span> - Method in class org.apache.hadoop.hbase.rest.client.<a href="./org/apache/hadoop/hbase/rest/client/RemoteHTable.html" title="class in org.apache.hadoop.hbase.rest.client">RemoteHTable</a></dt> +<dd> </dd> <dt><span class="strong"><a href="./org/apache/hadoop/hbase/mapreduce/TableInputFormatBase.html#setScan(org.apache.hadoop.hbase.client.Scan)">setScan(Scan)</a></span> - Method in class org.apache.hadoop.hbase.mapreduce.<a href="./org/apache/hadoop/hbase/mapreduce/TableInputFormatBase.html" title="class in org.apache.hadoop.hbase.mapreduce">TableInputFormatBase</a></dt> <dd> <div class="block">Sets the scan defining the actual details like columns etc.</div> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4131cace/apidocs/org/apache/hadoop/hbase/HConstants.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/HConstants.html b/apidocs/org/apache/hadoop/hbase/HConstants.html index ab87d96..a14c44e 100644 --- a/apidocs/org/apache/hadoop/hbase/HConstants.html +++ b/apidocs/org/apache/hadoop/hbase/HConstants.html @@ -805,13 +805,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <tr class="altColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/HConstants.html#HBASE_CLIENT_META_OPERATION_TIMEOUT">HBASE_CLIENT_META_OPERATION_TIMEOUT</a></strong></code> -<div class="block">Parameter name for HBase client operation timeout, which overrides RPC timeout</div> +<div class="block">Parameter name for HBase client operation timeout.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/HConstants.html#HBASE_CLIENT_OPERATION_TIMEOUT">HBASE_CLIENT_OPERATION_TIMEOUT</a></strong></code> -<div class="block">Parameter name for HBase client operation timeout, which overrides RPC timeout</div> +<div class="block">Parameter name for HBase client operation timeout.</div> </td> </tr> <tr class="altColor"> @@ -2553,7 +2553,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <h4>HBASE_CLIENT_OPERATION_TIMEOUT</h4> <pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/hadoop/hbase/HConstants.html#line.290">HBASE_CLIENT_OPERATION_TIMEOUT</a></pre> -<div class="block">Parameter name for HBase client operation timeout, which overrides RPC timeout</div> +<div class="block">Parameter name for HBase client operation timeout.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HConstants.HBASE_CLIENT_OPERATION_TIMEOUT">Constant Field Values</a></dd></dl> </li> </ul> @@ -2564,7 +2564,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <h4>HBASE_CLIENT_META_OPERATION_TIMEOUT</h4> <pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/hadoop/hbase/HConstants.html#line.293">HBASE_CLIENT_META_OPERATION_TIMEOUT</a></pre> -<div class="block">Parameter name for HBase client operation timeout, which overrides RPC timeout</div> +<div class="block">Parameter name for HBase client operation timeout.</div> <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.HConstants.HBASE_CLIENT_META_OPERATION_TIMEOUT">Constant Field Values</a></dd></dl> </li> </ul> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4131cace/apidocs/org/apache/hadoop/hbase/client/Table.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/client/Table.html b/apidocs/org/apache/hadoop/hbase/client/Table.html index f878937..d34912c 100644 --- a/apidocs/org/apache/hadoop/hbase/client/Table.html +++ b/apidocs/org/apache/hadoop/hbase/client/Table.html @@ -317,6 +317,18 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html </td> </tr> <tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/client/Table.html#getOperationTimeout()">getOperationTimeout</a></strong>()</code> +<div class="block">Get timeout (millisecond) of each operation for in Table instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/client/Table.html#getRpcTimeout()">getRpcTimeout</a></strong>()</code> +<div class="block">Get timeout (millisecond) of each rpc request in this Table instance.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/client/Table.html#getScanner(byte[])">getScanner</a></strong>(byte[] family)</code> <div class="block">Gets a scanner on the current table for the given family.</div> @@ -395,6 +407,20 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/client/Table.html#setOperationTimeout(int)">setOperationTimeout</a></strong>(int operationTimeout)</code> +<div class="block">Set timeout (millisecond) of each operation in this Table instance, will override the value + of hbase.client.operation.timeout in configuration.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/client/Table.html#setRpcTimeout(int)">setRpcTimeout</a></strong>(int rpcTimeout)</code> +<div class="block">Set timeout (millisecond) of each rpc request in operations of this Table instance, will + override the value of hbase.rpc.timeout in configuration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/client/Table.html#setWriteBufferSize(long)">setWriteBufferSize</a></strong>(long writeBufferSize)</code> <div class="block"><strong>Deprecated.</strong> <div class="block"><i>as of 1.0.1 (should not have been in 1.0.0). Replaced by <a href="../../../../../org/apache/hadoop/hbase/client/BufferedMutator.html" title="interface in org.apache.hadoop.hbase.client"><code>BufferedMutator</code></a> and @@ -1097,7 +1123,7 @@ void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table. <a name="checkAndMutate(byte[], byte[], byte[], org.apache.hadoop.hbase.filter.CompareFilter.CompareOp, byte[], org.apache.hadoop.hbase.client.RowMutations)"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>checkAndMutate</h4> <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line.567">checkAndMutate</a>(byte[] row, @@ -1116,6 +1142,57 @@ void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - e</dd></dl> </li> </ul> +<a name="setOperationTimeout(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOperationTimeout</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line.580">setOperationTimeout</a>(int operationTimeout)</pre> +<div class="block">Set timeout (millisecond) of each operation in this Table instance, will override the value + of hbase.client.operation.timeout in configuration. + Operation timeout is a top-level restriction that makes sure a blocking method will not be + blocked more than this. In each operation, if rpc request fails because of timeout or + other reason, it will retry until success or throw a RetriesExhaustedException. But if the + total time being blocking reach the operation timeout before retries exhausted, it will break + early and throw SocketTimeoutException.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>operationTimeout</code> - the total timeout of each operation in millisecond.</dd></dl> +</li> +</ul> +<a name="getOperationTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOperationTimeout</h4> +<pre>int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line.585">getOperationTimeout</a>()</pre> +<div class="block">Get timeout (millisecond) of each operation for in Table instance.</div> +</li> +</ul> +<a name="setRpcTimeout(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRpcTimeout</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line.594">setRpcTimeout</a>(int rpcTimeout)</pre> +<div class="block">Set timeout (millisecond) of each rpc request in operations of this Table instance, will + override the value of hbase.rpc.timeout in configuration. + If a rpc request waiting too long, it will stop waiting and send a new request to retry until + retries exhausted or operation timeout reached.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rpcTimeout</code> - the timeout of each rpc request in millisecond.</dd></dl> +</li> +</ul> +<a name="getRpcTimeout()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getRpcTimeout</h4> +<pre>int <a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line.599">getRpcTimeout</a>()</pre> +<div class="block">Get timeout (millisecond) of each rpc request in this Table instance.</div> +</li> +</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4131cace/apidocs/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html b/apidocs/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html index 4a1d5c7..452f963 100644 --- a/apidocs/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html +++ b/apidocs/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html @@ -308,7 +308,7 @@ extends org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<<a href="../. <ul class="blockList"> <li class="blockList"> <h4>configureIncrementalLoad</h4> -<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html#line.428">configureIncrementalLoad</a>(org.apache.hadoop.mapreduce.Job job, +<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html#line.433">configureIncrementalLoad</a>(org.apache.hadoop.mapreduce.Job job, <a href="../../../../../org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a> table, <a href="../../../../../org/apache/hadoop/hbase/client/RegionLocator.html" title="interface in org.apache.hadoop.hbase.client">RegionLocator</a> regionLocator) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> @@ -334,7 +334,7 @@ extends org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<<a href="../. <ul class="blockList"> <li class="blockList"> <h4>configureIncrementalLoad</h4> -<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html#line.447">configureIncrementalLoad</a>(org.apache.hadoop.mapreduce.Job job, +<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html#line.452">configureIncrementalLoad</a>(org.apache.hadoop.mapreduce.Job job, <a href="../../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a> tableDescriptor, <a href="../../../../../org/apache/hadoop/hbase/client/RegionLocator.html" title="interface in org.apache.hadoop.hbase.client">RegionLocator</a> regionLocator) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> @@ -360,7 +360,7 @@ extends org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<<a href="../. <ul class="blockListLast"> <li class="blockList"> <h4>configureIncrementalLoadMap</h4> -<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html#line.502">configureIncrementalLoadMap</a>(org.apache.hadoop.mapreduce.Job job, +<pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/mapreduce/HFileOutputFormat2.html#line.507">configureIncrementalLoadMap</a>(org.apache.hadoop.mapreduce.Job job, <a href="../../../../../org/apache/hadoop/hbase/HTableDescriptor.html" title="class in org.apache.hadoop.hbase">HTableDescriptor</a> tableDescriptor) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> <dl><dt><span class="strong">Throws:</span></dt> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4131cace/apidocs/org/apache/hadoop/hbase/rest/client/RemoteHTable.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/rest/client/RemoteHTable.html b/apidocs/org/apache/hadoop/hbase/rest/client/RemoteHTable.html index 141f9ee..4470a98 100644 --- a/apidocs/org/apache/hadoop/hbase/rest/client/RemoteHTable.html +++ b/apidocs/org/apache/hadoop/hbase/rest/client/RemoteHTable.html @@ -378,6 +378,18 @@ implements <a href="../../../../../../org/apache/hadoop/hbase/client/Table.html" </td> </tr> <tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/rest/client/RemoteHTable.html#getOperationTimeout()">getOperationTimeout</a></strong>()</code> +<div class="block">Get timeout (millisecond) of each operation for in Table instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/rest/client/RemoteHTable.html#getRpcTimeout()">getRpcTimeout</a></strong>()</code> +<div class="block">Get timeout (millisecond) of each rpc request in this Table instance.</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><code><a href="../../../../../../org/apache/hadoop/hbase/client/ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/rest/client/RemoteHTable.html#getScanner(byte[])">getScanner</a></strong>(byte[] family)</code> <div class="block">Gets a scanner on the current table for the given family.</div> @@ -462,6 +474,20 @@ implements <a href="../../../../../../org/apache/hadoop/hbase/client/Table.html" </tr> <tr class="rowColor"> <td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/rest/client/RemoteHTable.html#setOperationTimeout(int)">setOperationTimeout</a></strong>(int operationTimeout)</code> +<div class="block">Set timeout (millisecond) of each operation in this Table instance, will override the value + of hbase.client.operation.timeout in configuration.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/rest/client/RemoteHTable.html#setRpcTimeout(int)">setRpcTimeout</a></strong>(int rpcTimeout)</code> +<div class="block">Set timeout (millisecond) of each rpc request in operations of this Table instance, will + override the value of hbase.rpc.timeout in configuration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/rest/client/RemoteHTable.html#setWriteBufferSize(long)">setWriteBufferSize</a></strong>(long writeBufferSize)</code> <div class="block">Sets the size of the buffer in bytes.</div> </td> @@ -1405,7 +1431,7 @@ public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean. <a name="checkAndMutate(byte[], byte[], byte[], org.apache.hadoop.hbase.filter.CompareFilter.CompareOp, byte[], org.apache.hadoop.hbase.client.RowMutations)"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>checkAndMutate</h4> <pre>public boolean <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/client/RemoteHTable.html#line.847">checkAndMutate</a>(byte[] row, @@ -1428,6 +1454,75 @@ public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - e</dd></dl> </li> </ul> +<a name="setOperationTimeout(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOperationTimeout</h4> +<pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/client/RemoteHTable.html#line.853">setOperationTimeout</a>(int operationTimeout)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#setOperationTimeout(int)">Table</a></code></strong></div> +<div class="block">Set timeout (millisecond) of each operation in this Table instance, will override the value + of hbase.client.operation.timeout in configuration. + Operation timeout is a top-level restriction that makes sure a blocking method will not be + blocked more than this. In each operation, if rpc request fails because of timeout or + other reason, it will retry until success or throw a RetriesExhaustedException. But if the + total time being blocking reach the operation timeout before retries exhausted, it will break + early and throw SocketTimeoutException.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#setOperationTimeout(int)">setOperationTimeout</a></code> in interface <code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>operationTimeout</code> - the total timeout of each operation in millisecond.</dd></dl> +</li> +</ul> +<a name="getOperationTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOperationTimeout</h4> +<pre>public int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/client/RemoteHTable.html#line.858">getOperationTimeout</a>()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#getOperationTimeout()">Table</a></code></strong></div> +<div class="block">Get timeout (millisecond) of each operation for in Table instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#getOperationTimeout()">getOperationTimeout</a></code> in interface <code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></code></dd> +</dl> +</li> +</ul> +<a name="setRpcTimeout(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRpcTimeout</h4> +<pre>public void <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/client/RemoteHTable.html#line.863">setRpcTimeout</a>(int rpcTimeout)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#setRpcTimeout(int)">Table</a></code></strong></div> +<div class="block">Set timeout (millisecond) of each rpc request in operations of this Table instance, will + override the value of hbase.rpc.timeout in configuration. + If a rpc request waiting too long, it will stop waiting and send a new request to retry until + retries exhausted or operation timeout reached.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#setRpcTimeout(int)">setRpcTimeout</a></code> in interface <code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>rpcTimeout</code> - the timeout of each rpc request in millisecond.</dd></dl> +</li> +</ul> +<a name="getRpcTimeout()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getRpcTimeout</h4> +<pre>public int <a href="../../../../../../src-html/org/apache/hadoop/hbase/rest/client/RemoteHTable.html#line.868">getRpcTimeout</a>()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#getRpcTimeout()">Table</a></code></strong></div> +<div class="block">Get timeout (millisecond) of each rpc request in this Table instance.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html#getRpcTimeout()">getRpcTimeout</a></code> in interface <code><a href="../../../../../../org/apache/hadoop/hbase/client/Table.html" title="interface in org.apache.hadoop.hbase.client">Table</a></code></dd> +</dl> +</li> +</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4131cace/apidocs/src-html/org/apache/hadoop/hbase/HConstants.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/HConstants.html b/apidocs/src-html/org/apache/hadoop/hbase/HConstants.html index ea9c5c4..33659cb 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/HConstants.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/HConstants.html @@ -294,10 +294,10 @@ <span class="sourceLineNo">286</span> /** Parameter name for HBase client IPC pool size */<a name="line.286"></a> <span class="sourceLineNo">287</span> public static final String HBASE_CLIENT_IPC_POOL_SIZE = "hbase.client.ipc.pool.size";<a name="line.287"></a> <span class="sourceLineNo">288</span><a name="line.288"></a> -<span class="sourceLineNo">289</span> /** Parameter name for HBase client operation timeout, which overrides RPC timeout */<a name="line.289"></a> +<span class="sourceLineNo">289</span> /** Parameter name for HBase client operation timeout. */<a name="line.289"></a> <span class="sourceLineNo">290</span> public static final String HBASE_CLIENT_OPERATION_TIMEOUT = "hbase.client.operation.timeout";<a name="line.290"></a> <span class="sourceLineNo">291</span><a name="line.291"></a> -<span class="sourceLineNo">292</span> /** Parameter name for HBase client operation timeout, which overrides RPC timeout */<a name="line.292"></a> +<span class="sourceLineNo">292</span> /** Parameter name for HBase client operation timeout. */<a name="line.292"></a> <span class="sourceLineNo">293</span> public static final String HBASE_CLIENT_META_OPERATION_TIMEOUT =<a name="line.293"></a> <span class="sourceLineNo">294</span> "hbase.client.meta.operation.timeout";<a name="line.294"></a> <span class="sourceLineNo">295</span><a name="line.295"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4131cace/apidocs/src-html/org/apache/hadoop/hbase/client/RetriesExhaustedWithDetailsException.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/RetriesExhaustedWithDetailsException.html b/apidocs/src-html/org/apache/hadoop/hbase/client/RetriesExhaustedWithDetailsException.html index e002817..f71660f 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/RetriesExhaustedWithDetailsException.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/RetriesExhaustedWithDetailsException.html @@ -124,7 +124,7 @@ <span class="sourceLineNo">116</span> for(String addr : uniqAddr) {<a name="line.116"></a> <span class="sourceLineNo">117</span> addrs.append(addr).append(", ");<a name="line.117"></a> <span class="sourceLineNo">118</span> }<a name="line.118"></a> -<span class="sourceLineNo">119</span> return s;<a name="line.119"></a> +<span class="sourceLineNo">119</span> return addrs.toString();<a name="line.119"></a> <span class="sourceLineNo">120</span> }<a name="line.120"></a> <span class="sourceLineNo">121</span><a name="line.121"></a> <span class="sourceLineNo">122</span> public String getExhaustiveDescription() {<a name="line.122"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/4131cace/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html index d019695..29852a1 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Table.html @@ -574,7 +574,39 @@ <span class="sourceLineNo">566</span> */<a name="line.566"></a> <span class="sourceLineNo">567</span> boolean checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.567"></a> <span class="sourceLineNo">568</span> CompareFilter.CompareOp compareOp, byte[] value, RowMutations mutation) throws IOException;<a name="line.568"></a> -<span class="sourceLineNo">569</span>}<a name="line.569"></a> +<span class="sourceLineNo">569</span><a name="line.569"></a> +<span class="sourceLineNo">570</span> /**<a name="line.570"></a> +<span class="sourceLineNo">571</span> * Set timeout (millisecond) of each operation in this Table instance, will override the value<a name="line.571"></a> +<span class="sourceLineNo">572</span> * of hbase.client.operation.timeout in configuration.<a name="line.572"></a> +<span class="sourceLineNo">573</span> * Operation timeout is a top-level restriction that makes sure a blocking method will not be<a name="line.573"></a> +<span class="sourceLineNo">574</span> * blocked more than this. In each operation, if rpc request fails because of timeout or<a name="line.574"></a> +<span class="sourceLineNo">575</span> * other reason, it will retry until success or throw a RetriesExhaustedException. But if the<a name="line.575"></a> +<span class="sourceLineNo">576</span> * total time being blocking reach the operation timeout before retries exhausted, it will break<a name="line.576"></a> +<span class="sourceLineNo">577</span> * early and throw SocketTimeoutException.<a name="line.577"></a> +<span class="sourceLineNo">578</span> * @param operationTimeout the total timeout of each operation in millisecond.<a name="line.578"></a> +<span class="sourceLineNo">579</span> */<a name="line.579"></a> +<span class="sourceLineNo">580</span> public void setOperationTimeout(int operationTimeout);<a name="line.580"></a> +<span class="sourceLineNo">581</span><a name="line.581"></a> +<span class="sourceLineNo">582</span> /**<a name="line.582"></a> +<span class="sourceLineNo">583</span> * Get timeout (millisecond) of each operation for in Table instance.<a name="line.583"></a> +<span class="sourceLineNo">584</span> */<a name="line.584"></a> +<span class="sourceLineNo">585</span> public int getOperationTimeout();<a name="line.585"></a> +<span class="sourceLineNo">586</span><a name="line.586"></a> +<span class="sourceLineNo">587</span> /**<a name="line.587"></a> +<span class="sourceLineNo">588</span> * Set timeout (millisecond) of each rpc request in operations of this Table instance, will<a name="line.588"></a> +<span class="sourceLineNo">589</span> * override the value of hbase.rpc.timeout in configuration.<a name="line.589"></a> +<span class="sourceLineNo">590</span> * If a rpc request waiting too long, it will stop waiting and send a new request to retry until<a name="line.590"></a> +<span class="sourceLineNo">591</span> * retries exhausted or operation timeout reached.<a name="line.591"></a> +<span class="sourceLineNo">592</span> * @param rpcTimeout the timeout of each rpc request in millisecond.<a name="line.592"></a> +<span class="sourceLineNo">593</span> */<a name="line.593"></a> +<span class="sourceLineNo">594</span> public void setRpcTimeout(int rpcTimeout);<a name="line.594"></a> +<span class="sourceLineNo">595</span><a name="line.595"></a> +<span class="sourceLineNo">596</span> /**<a name="line.596"></a> +<span class="sourceLineNo">597</span> * Get timeout (millisecond) of each rpc request in this Table instance.<a name="line.597"></a> +<span class="sourceLineNo">598</span> */<a name="line.598"></a> +<span class="sourceLineNo">599</span> public int getRpcTimeout();<a name="line.599"></a> +<span class="sourceLineNo">600</span><a name="line.600"></a> +<span class="sourceLineNo">601</span>}<a name="line.601"></a>
