| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Table (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.client, interface: Table"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Table.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.client</a></div> |
| <h1 title="Interface Table" class="title">Interface Table</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="TableOverAsyncTable.html" title="class in org.apache.hadoop.hbase.client">TableOverAsyncTable</a></code>, <code><a href="../thrift2/client/ThriftTable.html" title="class in org.apache.hadoop.hbase.thrift2.client">ThriftTable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Public |
| </span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-55">Table</a></span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></span></div> |
| <div class="block">Used to communicate with a single HBase table. Obtain an instance from a <a href="Connection.html" title="interface in org.apache.hadoop.hbase.client"><code>Connection</code></a> and |
| call <a href="#close()"><code>close()</code></a> afterwards. |
| <p> |
| <code>Table</code> can be used to get, put, delete or scan data from a table.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.99.0</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="ConnectionFactory.html" title="class in org.apache.hadoop.hbase.client"><code>ConnectionFactory</code></a></li> |
| <li><a href="Connection.html" title="interface in org.apache.hadoop.hbase.client"><code>Connection</code></a></li> |
| <li><a href="Admin.html" title="interface in org.apache.hadoop.hbase.client"><code>Admin</code></a></li> |
| <li><a href="RegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionLocator</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="Table.CheckAndMutateBuilder.html" class="type-name-link" title="interface in org.apache.hadoop.hbase.client">Table.CheckAndMutateBuilder</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 3.0.0, will be removed in 4.0.0.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color"><code>static interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="Table.CheckAndMutateWithFilterBuilder.html" class="type-name-link" title="interface in org.apache.hadoop.hbase.client">Table.CheckAndMutateWithFilterBuilder</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 3.0.0, will be removed in 4.0.0.</div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#append(org.apache.hadoop.hbase.client.Append)" class="member-name-link">append</a><wbr>(<a href="Append.html" title="class in org.apache.hadoop.hbase.client">Append</a> append)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Appends values to one or more columns within a single row.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#batch(java.util.List,java.lang.Object%5B%5D)" class="member-name-link">batch</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends <a href="Row.html" title="interface in org.apache.hadoop.hbase.client">Row</a>> actions, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[] results)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Method that does a batch call on Deletes, Gets, Puts, Increments, Appends, RowMutations.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code>default <R> void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code><a href="#batchCallback(java.util.List,java.lang.Object%5B%5D,org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)" class="member-name-link">batchCallback</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends <a href="Row.html" title="interface in org.apache.hadoop.hbase.client">Row</a>> actions, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[] results, |
| <a href="coprocessor/Batch.Callback.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Callback</a><R> callback)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code>default <R extends org.apache.hbase.thirdparty.com.google.protobuf.Message><br><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><byte[],<wbr>R></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code><a href="#batchCoprocessorService(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor,org.apache.hbase.thirdparty.com.google.protobuf.Message,byte%5B%5D,byte%5B%5D,R)" class="member-name-link">batchCoprocessorService</a><wbr>(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor, |
| org.apache.hbase.thirdparty.com.google.protobuf.Message request, |
| byte[] startKey, |
| byte[] endKey, |
| R responsePrototype)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code>default <R extends org.apache.hbase.thirdparty.com.google.protobuf.Message><br>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code><a href="#batchCoprocessorService(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor,org.apache.hbase.thirdparty.com.google.protobuf.Message,byte%5B%5D,byte%5B%5D,R,org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)" class="member-name-link">batchCoprocessorService</a><wbr>(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor, |
| org.apache.hbase.thirdparty.com.google.protobuf.Message request, |
| byte[] startKey, |
| byte[] endKey, |
| R responsePrototype, |
| <a href="coprocessor/Batch.Callback.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Callback</a><R> callback)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code>default <a href="Table.CheckAndMutateBuilder.html" title="interface in org.apache.hadoop.hbase.client">Table.CheckAndMutateBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code><a href="#checkAndMutate(byte%5B%5D,byte%5B%5D)" class="member-name-link">checkAndMutate</a><wbr>(byte[] row, |
| byte[] family)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 3.0.0, will be removed in 4.0.0.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code>default <a href="Table.CheckAndMutateWithFilterBuilder.html" title="interface in org.apache.hadoop.hbase.client">Table.CheckAndMutateWithFilterBuilder</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code><a href="#checkAndMutate(byte%5B%5D,org.apache.hadoop.hbase.filter.Filter)" class="member-name-link">checkAndMutate</a><wbr>(byte[] row, |
| <a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 3.0.0, will be removed in 4.0.0.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="CheckAndMutateResult.html" title="class in org.apache.hadoop.hbase.client">CheckAndMutateResult</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#checkAndMutate(java.util.List)" class="member-name-link">checkAndMutate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="CheckAndMutate.html" title="class in org.apache.hadoop.hbase.client">CheckAndMutate</a>> checkAndMutates)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Batch version of checkAndMutate.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="CheckAndMutateResult.html" title="class in org.apache.hadoop.hbase.client">CheckAndMutateResult</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#checkAndMutate(org.apache.hadoop.hbase.client.CheckAndMutate)" class="member-name-link">checkAndMutate</a><wbr>(<a href="CheckAndMutate.html" title="class in org.apache.hadoop.hbase.client">CheckAndMutate</a> checkAndMutate)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">checkAndMutate that atomically checks if a row matches the specified condition.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Releases any resources held or pending changes in internal buffers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code>default <a href="../ipc/CoprocessorRpcChannel.html" title="interface in org.apache.hadoop.hbase.ipc">CoprocessorRpcChannel</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code><a href="#coprocessorService(byte%5B%5D)" class="member-name-link">coprocessorService</a><wbr>(byte[] row)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code>default <T extends org.apache.hbase.thirdparty.com.google.protobuf.Service,<wbr> |
| R><br><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><byte[],<wbr>R></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code><a href="#coprocessorService(java.lang.Class,byte%5B%5D,byte%5B%5D,org.apache.hadoop.hbase.client.coprocessor.Batch.Call)" class="member-name-link">coprocessorService</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> service, |
| byte[] startKey, |
| byte[] endKey, |
| <a href="coprocessor/Batch.Call.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Call</a><T,<wbr>R> callable)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code>default <T extends org.apache.hbase.thirdparty.com.google.protobuf.Service,<wbr> |
| R><br>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"><code><a href="#coprocessorService(java.lang.Class,byte%5B%5D,byte%5B%5D,org.apache.hadoop.hbase.client.coprocessor.Batch.Call,org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)" class="member-name-link">coprocessorService</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> service, |
| byte[] startKey, |
| byte[] endKey, |
| <a href="coprocessor/Batch.Call.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Call</a><T,<wbr>R> callable, |
| <a href="coprocessor/Batch.Callback.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Callback</a><R> callback)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#delete(java.util.List)" class="member-name-link">delete</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a>> deletes)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Batch Deletes the specified cells/rows from the table.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#delete(org.apache.hadoop.hbase.client.Delete)" class="member-name-link">delete</a><wbr>(<a href="Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a> delete)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Deletes the specified cells/row.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#exists(java.util.List)" class="member-name-link">exists</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Test for the existence of columns in the table, as specified by the Gets.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#exists(org.apache.hadoop.hbase.client.Get)" class="member-name-link">exists</a><wbr>(<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Test for the existence of columns in the table, as specified by the Get.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#get(java.util.List)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Extracts specified cells from the given rows, as a batch.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#get(org.apache.hadoop.hbase.client.Get)" class="member-name-link">get</a><wbr>(<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Extracts certain cells from a given row.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.hadoop.conf.Configuration</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getConfiguration()" class="member-name-link">getConfiguration</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the <code>Configuration</code> object used by this instance.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDescriptor()" class="member-name-link">getDescriptor</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the <a href="TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><code>table descriptor</code></a> for this |
| table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the fully qualified table name instance of this table.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getOperationTimeout(java.util.concurrent.TimeUnit)" class="member-name-link">getOperationTimeout</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Get timeout of each operation in Table instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getReadRpcTimeout(java.util.concurrent.TimeUnit)" class="member-name-link">getReadRpcTimeout</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Get timeout of each rpc read request in this Table instance.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="RegionLocator.html" title="interface in org.apache.hadoop.hbase.client">RegionLocator</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRegionLocator()" class="member-name-link">getRegionLocator</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the <a href="RegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionLocator</code></a> for this table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>byte[]></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRequestAttributes()" class="member-name-link">getRequestAttributes</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Get the attributes to be submitted with requests</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRpcTimeout(java.util.concurrent.TimeUnit)" class="member-name-link">getRpcTimeout</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Get timeout of each rpc request in this Table instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getScanner(byte%5B%5D)" class="member-name-link">getScanner</a><wbr>(byte[] family)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Gets a scanner on the current table for the given family.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getScanner(byte%5B%5D,byte%5B%5D)" class="member-name-link">getScanner</a><wbr>(byte[] family, |
| byte[] qualifier)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Gets a scanner on the current table for the given family and qualifier.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getScanner(org.apache.hadoop.hbase.client.Scan)" class="member-name-link">getScanner</a><wbr>(<a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns a scanner on the current table as specified by the <a href="Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> object.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getWriteRpcTimeout(java.util.concurrent.TimeUnit)" class="member-name-link">getWriteRpcTimeout</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Get timeout of each rpc write request in this Table instance.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#increment(org.apache.hadoop.hbase.client.Increment)" class="member-name-link">increment</a><wbr>(<a href="Increment.html" title="class in org.apache.hadoop.hbase.client">Increment</a> increment)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Increments one or more columns within a single row.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#incrementColumnValue(byte%5B%5D,byte%5B%5D,byte%5B%5D,long)" class="member-name-link">incrementColumnValue</a><wbr>(byte[] row, |
| byte[] family, |
| byte[] qualifier, |
| long amount)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">See <a href="#incrementColumnValue(byte%5B%5D,byte%5B%5D,byte%5B%5D,long,org.apache.hadoop.hbase.client.Durability)"><code>incrementColumnValue(byte[], byte[], byte[], long, Durability)</code></a></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#incrementColumnValue(byte%5B%5D,byte%5B%5D,byte%5B%5D,long,org.apache.hadoop.hbase.client.Durability)" class="member-name-link">incrementColumnValue</a><wbr>(byte[] row, |
| byte[] family, |
| byte[] qualifier, |
| long amount, |
| <a href="Durability.html" title="enum class in org.apache.hadoop.hbase.client">Durability</a> durability)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Atomically increments a column value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#mutateRow(org.apache.hadoop.hbase.client.RowMutations)" class="member-name-link">mutateRow</a><wbr>(<a href="RowMutations.html" title="class in org.apache.hadoop.hbase.client">RowMutations</a> rm)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Performs multiple mutations atomically on a single row.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#put(java.util.List)" class="member-name-link">put</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Put.html" title="class in org.apache.hadoop.hbase.client">Put</a>> puts)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Batch puts the specified data into the table.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#put(org.apache.hadoop.hbase.client.Put)" class="member-name-link">put</a><wbr>(<a href="Put.html" title="class in org.apache.hadoop.hbase.client">Put</a> put)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Puts some data in the table.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getName()"> |
| <h3>getName</h3> |
| <div class="member-signature"><span class="return-type"><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-60">getName</a></span>()</div> |
| <div class="block">Gets the fully qualified table name instance of this table.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConfiguration()"> |
| <h3>getConfiguration</h3> |
| <div class="member-signature"><span class="return-type">org.apache.hadoop.conf.Configuration</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-67">getConfiguration</a></span>()</div> |
| <div class="block">Returns the <code>Configuration</code> object used by this instance. |
| <p> |
| The reference returned is not a copy, so any change made to it will affect this instance.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDescriptor()"> |
| <h3>getDescriptor</h3> |
| <div class="member-signature"><span class="return-type"><a href="TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client">TableDescriptor</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-74">getDescriptor</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Gets the <a href="TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><code>table descriptor</code></a> for this |
| table.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionLocator()"> |
| <h3>getRegionLocator</h3> |
| <div class="member-signature"><span class="return-type"><a href="RegionLocator.html" title="interface in org.apache.hadoop.hbase.client">RegionLocator</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-79">getRegionLocator</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Gets the <a href="RegionLocator.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionLocator</code></a> for this table.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="exists(org.apache.hadoop.hbase.client.Get)"> |
| <h3>exists</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-91">exists</a></span><wbr><span class="parameters">(<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Test for the existence of columns in the table, as specified by the Get. |
| <p> |
| This will return true if the Get matches one or more keys, false if not. |
| <p> |
| This is a server-side call so it prevents any data from being transfered to the client.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>get</code> - the Get</dd> |
| <dt>Returns:</dt> |
| <dd>true if the specified Get matches one or more keys, false if not</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - e</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="exists(java.util.List)"> |
| <h3>exists</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-106">exists</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Test for the existence of columns in the table, as specified by the Gets. |
| <p> |
| This will return an array of booleans. Each value will be true if the related Get matches one |
| or more keys, false if not. |
| <p> |
| This is a server-side call so it prevents any data from being transferred to the client.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>gets</code> - the Gets</dd> |
| <dt>Returns:</dt> |
| <dd>Array of boolean. True if the specified Get matches one or more keys, false if not.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - e</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="batch(java.util.List,java.lang.Object[])"> |
| <h3>batch</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-122">batch</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends <a href="Row.html" title="interface in org.apache.hadoop.hbase.client">Row</a>> actions, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[] results)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="block">Method that does a batch call on Deletes, Gets, Puts, Increments, Appends, RowMutations. The |
| ordering of execution of the actions is not defined. Meaning if you do a Put and a Get in the |
| same <a href="#batch(java.util.List,java.lang.Object%5B%5D)"><code>batch(java.util.List<? extends org.apache.hadoop.hbase.client.Row>, java.lang.Object[])</code></a> call, you will not necessarily be guaranteed that the Get returns what the |
| Put had put.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>actions</code> - list of Get, Put, Delete, Increment, Append, RowMutations.</dd> |
| <dd><code>results</code> - Empty Object[], same size as actions. Provides access to partial results, in |
| case an exception is thrown. A null in the result array means that the call for |
| that action failed, even after retries. The order of the objects in the results |
| array corresponds to the order of actions in the request list.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| <dt>Since:</dt> |
| <dd>0.90.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="batchCallback(java.util.List,java.lang.Object[],org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)"> |
| <h3>batchCallback</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">default</span> <span class="type-parameters"><R></span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-136">batchCallback</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><? extends <a href="Row.html" title="interface in org.apache.hadoop.hbase.client">Row</a>> actions, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>[] results, |
| <a href="coprocessor/Batch.Callback.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Callback</a><R> callback)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0. Please use the batch related methods in |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a> directly if you want to use callback. We reuse the callback for |
| coprocessor here, and the problem is that for batch operation, the |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a> does not tell us the region, so in this method we need an extra |
| locating after we get the result, which is not good.</div> |
| </div> |
| <div class="block">Same as <a href="#batch(java.util.List,java.lang.Object%5B%5D)"><code>batch(List, Object[])</code></a>, but with a callback.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| <dt>Since:</dt> |
| <dd>0.96.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(org.apache.hadoop.hbase.client.Get)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-151">get</a></span><wbr><span class="parameters">(<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a> get)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Extracts certain cells from a given row.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>get</code> - The object that specifies what data to fetch and from which row.</dd> |
| <dt>Returns:</dt> |
| <dd>The data coming from the specified row, if it exists. If the row specified doesn't |
| exist, the <a href="Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a> instance returned won't contain any |
| <a href="../KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a>, as indicated by <a href="Result.html#isEmpty()"><code>Result.isEmpty()</code></a>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| <dt>Since:</dt> |
| <dd>0.20.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(java.util.List)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a>[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-171">get</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Get.html" title="class in org.apache.hadoop.hbase.client">Get</a>> gets)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Extracts specified cells from the given rows, as a batch.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>gets</code> - The objects that specify what data to fetch and from which rows.</dd> |
| <dt>Returns:</dt> |
| <dd>The data coming from the specified rows, if it exists. If the row specified doesn't |
| exist, the <a href="Result.html" title="class in org.apache.hadoop.hbase.client"><code>Result</code></a> instance returned won't contain any |
| <a href="../Cell.html" title="interface in org.apache.hadoop.hbase"><code>Cell</code></a>s, as indicated by <a href="Result.html#isEmpty()"><code>Result.isEmpty()</code></a>. If |
| there are any failures even after retries, there will be a <code>null</code> in the |
| results' array for those Gets, AND an exception will be thrown. The ordering of the |
| Result array corresponds to the order of the list of passed in Gets.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| <dt>Since:</dt> |
| <dd>0.90.0</dd> |
| <dt>API Note:</dt> |
| <dd><a href="#put(java.util.List)"><code>put(List)</code></a> runs pre-flight validations on the input list on client. Currently |
| <a href="#get(java.util.List)"><code>get(List)</code></a> doesn't run any validations on the client-side, currently there is |
| no need, but this may change in the future. An <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> will |
| be thrown in this case.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScanner(org.apache.hadoop.hbase.client.Scan)"> |
| <h3>getScanner</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-183">getScanner</a></span><wbr><span class="parameters">(<a href="Scan.html" title="class in org.apache.hadoop.hbase.client">Scan</a> scan)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Returns a scanner on the current table as specified by the <a href="Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> object. Note that the |
| passed <a href="Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a>'s start row and caching properties maybe changed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>scan</code> - A configured <a href="Scan.html" title="class in org.apache.hadoop.hbase.client"><code>Scan</code></a> object.</dd> |
| <dt>Returns:</dt> |
| <dd>A scanner.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| <dt>Since:</dt> |
| <dd>0.20.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScanner(byte[])"> |
| <h3>getScanner</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-194">getScanner</a></span><wbr><span class="parameters">(byte[] family)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Gets a scanner on the current table for the given family.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>family</code> - The column family to scan.</dd> |
| <dt>Returns:</dt> |
| <dd>A scanner.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| <dt>Since:</dt> |
| <dd>0.20.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScanner(byte[],byte[])"> |
| <h3>getScanner</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="ResultScanner.html" title="interface in org.apache.hadoop.hbase.client">ResultScanner</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-206">getScanner</a></span><wbr><span class="parameters">(byte[] family, |
| byte[] qualifier)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Gets a scanner on the current table for the given family and qualifier.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>family</code> - The column family to scan.</dd> |
| <dd><code>qualifier</code> - The column qualifier to scan.</dd> |
| <dt>Returns:</dt> |
| <dd>A scanner.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| <dt>Since:</dt> |
| <dd>0.20.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(org.apache.hadoop.hbase.client.Put)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-216">put</a></span><wbr><span class="parameters">(<a href="Put.html" title="class in org.apache.hadoop.hbase.client">Put</a> put)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Puts some data in the table.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>put</code> - The data to put.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| <dt>Since:</dt> |
| <dd>0.20.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="put(java.util.List)"> |
| <h3>put</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-235">put</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Put.html" title="class in org.apache.hadoop.hbase.client">Put</a>> puts)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Batch puts the specified data into the table. |
| <p> |
| This can be used for group commit, or for submitting user defined batches. Before sending a |
| batch of mutations to the server, the client runs a few validations on the input list. If an |
| error is found, for example, a mutation was supplied but was missing it's column an |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> will be thrown and no mutations will be applied. If there are |
| any failures even after retries, a <a href="RetriesExhaustedWithDetailsException.html" title="class in org.apache.hadoop.hbase.client"><code>RetriesExhaustedWithDetailsException</code></a> will be thrown. |
| RetriesExhaustedWithDetailsException contains lists of failed mutations and corresponding |
| remote exceptions. The ordering of mutations and exceptions in the encapsulating exception |
| corresponds to the order of the input list of Put requests.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>puts</code> - The list of mutations to apply.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| <dt>Since:</dt> |
| <dd>0.20.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delete(org.apache.hadoop.hbase.client.Delete)"> |
| <h3>delete</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-245">delete</a></span><wbr><span class="parameters">(<a href="Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a> delete)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Deletes the specified cells/row.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>delete</code> - The object that specifies what to delete.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| <dt>Since:</dt> |
| <dd>0.20.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="delete(java.util.List)"> |
| <h3>delete</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-271">delete</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Delete.html" title="class in org.apache.hadoop.hbase.client">Delete</a>> deletes)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Batch Deletes the specified cells/rows from the table. |
| <p> |
| If a specified row does not exist, <a href="Delete.html" title="class in org.apache.hadoop.hbase.client"><code>Delete</code></a> will report as though sucessful delete; no |
| exception will be thrown. If there are any failures even after retries, a |
| <a href="RetriesExhaustedWithDetailsException.html" title="class in org.apache.hadoop.hbase.client"><code>RetriesExhaustedWithDetailsException</code></a> will be thrown. |
| RetriesExhaustedWithDetailsException contains lists of failed <a href="Delete.html" title="class in org.apache.hadoop.hbase.client"><code>Delete</code></a>s and corresponding |
| remote exceptions.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>deletes</code> - List of things to delete. The input list gets modified by this method. All |
| successfully applied <a href="Delete.html" title="class in org.apache.hadoop.hbase.client"><code>Delete</code></a>s in the list are removed (in particular it |
| gets re-ordered, so the order in which the elements are inserted in the list |
| gives no guarantee as to the order in which the <a href="Delete.html" title="class in org.apache.hadoop.hbase.client"><code>Delete</code></a>s are executed).</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs. In that case the <code>deletes</code> |
| argument will contain the <a href="Delete.html" title="class in org.apache.hadoop.hbase.client"><code>Delete</code></a> instances that have not be |
| successfully applied.</dd> |
| <dt>Since:</dt> |
| <dd>0.20.1</dd> |
| <dt>API Note:</dt> |
| <dd>In 3.0.0 version, the input list <code>deletes</code> will no longer be modified. Also, |
| <a href="#put(java.util.List)"><code>put(List)</code></a> runs pre-flight validations on the input list on client. Currently |
| <a href="#delete(java.util.List)"><code>delete(List)</code></a> doesn't run validations on the client, there is no need |
| currently, but this may change in the future. An <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a> will |
| be thrown in this case.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkAndMutate(byte[],byte[])"> |
| <h3>checkAndMutate</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">default</span> <span class="return-type"><a href="Table.CheckAndMutateBuilder.html" title="interface in org.apache.hadoop.hbase.client">Table.CheckAndMutateBuilder</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-291">checkAndMutate</a></span><wbr><span class="parameters">(byte[] row, |
| byte[] family)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 3.0.0, will be removed in 4.0.0. For internal test use only, do not use it |
| any more.</div> |
| </div> |
| <div class="block">Atomically checks if a row/family/qualifier value matches the expected value. If it does, it |
| adds the Put/Delete/RowMutations. |
| <p> |
| Use the returned <a href="Table.CheckAndMutateBuilder.html" title="interface in org.apache.hadoop.hbase.client"><code>Table.CheckAndMutateBuilder</code></a> to construct your request and then execute it. |
| This is a fluent style API, the code is like: |
| |
| <pre> |
| <code> |
| table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put); |
| </code> |
| </pre></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkAndMutate(byte[],org.apache.hadoop.hbase.filter.Filter)"> |
| <h3>checkAndMutate</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">default</span> <span class="return-type"><a href="Table.CheckAndMutateWithFilterBuilder.html" title="interface in org.apache.hadoop.hbase.client">Table.CheckAndMutateWithFilterBuilder</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-374">checkAndMutate</a></span><wbr><span class="parameters">(byte[] row, |
| <a href="../filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 3.0.0, will be removed in 4.0.0. For internal test use only, do not use it |
| any more.</div> |
| </div> |
| <div class="block">Atomically checks if a row matches the specified filter. If it does, it adds the |
| Put/Delete/RowMutations. |
| <p> |
| Use the returned <a href="Table.CheckAndMutateWithFilterBuilder.html" title="interface in org.apache.hadoop.hbase.client"><code>Table.CheckAndMutateWithFilterBuilder</code></a> to construct your request and then |
| execute it. This is a fluent style API, the code is like: |
| |
| <pre> |
| <code> |
| table.checkAndMutate(row, filter).thenPut(put); |
| </code> |
| </pre></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkAndMutate(org.apache.hadoop.hbase.client.CheckAndMutate)"> |
| <h3>checkAndMutate</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="CheckAndMutateResult.html" title="class in org.apache.hadoop.hbase.client">CheckAndMutateResult</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-422">checkAndMutate</a></span><wbr><span class="parameters">(<a href="CheckAndMutate.html" title="class in org.apache.hadoop.hbase.client">CheckAndMutate</a> checkAndMutate)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">checkAndMutate that atomically checks if a row matches the specified condition. If it does, it |
| performs the specified action.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>checkAndMutate</code> - The CheckAndMutate object.</dd> |
| <dt>Returns:</dt> |
| <dd>A CheckAndMutateResult object that represents the result for the CheckAndMutate.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkAndMutate(java.util.List)"> |
| <h3>checkAndMutate</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="CheckAndMutateResult.html" title="class in org.apache.hadoop.hbase.client">CheckAndMutateResult</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-435">checkAndMutate</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="CheckAndMutate.html" title="class in org.apache.hadoop.hbase.client">CheckAndMutate</a>> checkAndMutates)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Batch version of checkAndMutate. The specified CheckAndMutates are batched only in the sense |
| that they are sent to a RS in one RPC, but each CheckAndMutate operation is still executed |
| atomically (and thus, each may fail independently of others).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>checkAndMutates</code> - The list of CheckAndMutate.</dd> |
| <dt>Returns:</dt> |
| <dd>A list of CheckAndMutateResult objects that represents the result for each |
| CheckAndMutate.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="mutateRow(org.apache.hadoop.hbase.client.RowMutations)"> |
| <h3>mutateRow</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-447">mutateRow</a></span><wbr><span class="parameters">(<a href="RowMutations.html" title="class in org.apache.hadoop.hbase.client">RowMutations</a> rm)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Performs multiple mutations atomically on a single row. Currently <a href="Put.html" title="class in org.apache.hadoop.hbase.client"><code>Put</code></a> and |
| <a href="Delete.html" title="class in org.apache.hadoop.hbase.client"><code>Delete</code></a> are supported.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rm</code> - object that specifies the set of mutations to perform atomically</dd> |
| <dt>Returns:</dt> |
| <dd>results of Increment/Append operations</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="append(org.apache.hadoop.hbase.client.Append)"> |
| <h3>append</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-461">append</a></span><wbr><span class="parameters">(<a href="Append.html" title="class in org.apache.hadoop.hbase.client">Append</a> append)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Appends values to one or more columns within a single row. |
| <p> |
| This operation guaranteed atomicity to readers. Appends are done under a single row lock, so |
| write operations to a row are synchronized, and readers are guaranteed to see this operation |
| fully completed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>append</code> - object that specifies the columns and values to be appended</dd> |
| <dt>Returns:</dt> |
| <dd>values of columns after the append operation (maybe null)</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - e</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="increment(org.apache.hadoop.hbase.client.Increment)"> |
| <h3>increment</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-476">increment</a></span><wbr><span class="parameters">(<a href="Increment.html" title="class in org.apache.hadoop.hbase.client">Increment</a> increment)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Increments one or more columns within a single row. |
| <p> |
| This operation ensures atomicity to readers. Increments are done under a single row lock, so |
| write operations to a row are synchronized, and readers are guaranteed to see this operation |
| fully completed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>increment</code> - object that specifies the columns and amounts to be used for the increment |
| operations</dd> |
| <dt>Returns:</dt> |
| <dd>values of columns after the increment</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - e</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="incrementColumnValue(byte[],byte[],byte[],long)"> |
| <h3>incrementColumnValue</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-492">incrementColumnValue</a></span><wbr><span class="parameters">(byte[] row, |
| byte[] family, |
| byte[] qualifier, |
| long amount)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">See <a href="#incrementColumnValue(byte%5B%5D,byte%5B%5D,byte%5B%5D,long,org.apache.hadoop.hbase.client.Durability)"><code>incrementColumnValue(byte[], byte[], byte[], long, Durability)</code></a> |
| <p> |
| The <a href="Durability.html" title="enum class in org.apache.hadoop.hbase.client"><code>Durability</code></a> is defaulted to <a href="Durability.html#SYNC_WAL"><code>Durability.SYNC_WAL</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - The row that contains the cell to increment.</dd> |
| <dd><code>family</code> - The column family of the cell to increment.</dd> |
| <dd><code>qualifier</code> - The column qualifier of the cell to increment.</dd> |
| <dd><code>amount</code> - The amount to increment the cell with (or decrement, if the amount is |
| negative).</dd> |
| <dt>Returns:</dt> |
| <dd>The new value, post increment.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="incrementColumnValue(byte[],byte[],byte[],long,org.apache.hadoop.hbase.client.Durability)"> |
| <h3>incrementColumnValue</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-515">incrementColumnValue</a></span><wbr><span class="parameters">(byte[] row, |
| byte[] family, |
| byte[] qualifier, |
| long amount, |
| <a href="Durability.html" title="enum class in org.apache.hadoop.hbase.client">Durability</a> durability)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Atomically increments a column value. If the column value already exists and is not a |
| big-endian long, this could throw an exception. If the column value does not yet exist it is |
| initialized to <code>amount</code> and written to the specified column. |
| <p> |
| Setting durability to <a href="Durability.html#SKIP_WAL"><code>Durability.SKIP_WAL</code></a> means that in a fail scenario you will lose |
| any increments that have not been flushed.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - The row that contains the cell to increment.</dd> |
| <dd><code>family</code> - The column family of the cell to increment.</dd> |
| <dd><code>qualifier</code> - The column qualifier of the cell to increment.</dd> |
| <dd><code>amount</code> - The amount to increment the cell with (or decrement, if the amount is |
| negative).</dd> |
| <dd><code>durability</code> - The persistence guarantee for this increment.</dd> |
| <dt>Returns:</dt> |
| <dd>The new value, post increment.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-527">close</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Releases any resources held or pending changes in internal buffers.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a remote or network exception occurs.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="coprocessorService(byte[])"> |
| <h3>coprocessorService</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">default</span> <span class="return-type"><a href="../ipc/CoprocessorRpcChannel.html" title="interface in org.apache.hadoop.hbase.ipc">CoprocessorRpcChannel</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-562">coprocessorService</a></span><wbr><span class="parameters">(byte[] row)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0. This is too low level, please stop using it any |
| more. Use the coprocessorService methods in <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a> instead.</div> |
| </div> |
| <div class="block">Creates and returns a <code>RpcChannel</code> |
| instance connected to the table region containing the specified row. The row given does not |
| actually have to exist. Whichever region would contain the row based on start and end keys will |
| be used. Note that the <code>row</code> parameter is also not passed to the coprocessor handler |
| registered for this protocol, unless the <code>row</code> is separately passed as an argument in the |
| service request. The parameter here is only used to locate the region used to handle the call. |
| <p/> |
| The obtained <code>RpcChannel</code> instance can be |
| used to access a published coprocessor <code>Service</code> using standard protobuf service |
| invocations: |
| <p/> |
| <div style="background-color: #cccccc; padding: 2px"> <blockquote> |
| |
| <pre> |
| CoprocessorRpcChannel channel = myTable.coprocessorService(rowkey); |
| MyService.BlockingInterface service = MyService.newBlockingStub(channel); |
| MyCallRequest request = MyCallRequest.newBuilder() |
| ... |
| .build(); |
| MyCallResponse response = service.myCall(null, request); |
| </pre> |
| |
| </blockquote> </div></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>row</code> - The row key used to identify the remote region location</dd> |
| <dt>Returns:</dt> |
| <dd>A CoprocessorRpcChannel instance</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Connection.html#toAsyncConnection()"><code>Connection.toAsyncConnection()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="coprocessorService(java.lang.Class,byte[],byte[],org.apache.hadoop.hbase.client.coprocessor.Batch.Call)"> |
| <h3>coprocessorService</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">default</span> <span class="type-parameters-long"><T extends org.apache.hbase.thirdparty.com.google.protobuf.Service,<wbr> |
| R></span> |
| <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><byte[],<wbr>R></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-592">coprocessorService</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> service, |
| byte[] startKey, |
| byte[] endKey, |
| <a href="coprocessor/Batch.Call.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Call</a><T,<wbr>R> callable)</span> |
| throws <span class="exceptions">org.apache.hbase.thirdparty.com.google.protobuf.ServiceException, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0. The batch call here references the blocking |
| interface for of a protobuf stub, so it is not possible to do it in an asynchronous |
| way, even if now we are building the <a href="Table.html" title="interface in org.apache.hadoop.hbase.client"><code>Table</code></a> implementation based on the |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a>, which is not good. Use the coprocessorService methods in |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a> directly instead.</div> |
| </div> |
| <div class="block">Creates an instance of the given <code>Service</code> subclass for each table region spanning the |
| range from the <code>startKey</code> row to <code>endKey</code> row (inclusive), and invokes the passed |
| <a href="coprocessor/Batch.Call.html#call(T)"><code>Batch.Call.call(T)</code></a> method with each |
| <code>Service</code> instance.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the <code>Service</code> subclass to connect to</dd> |
| <dd><code>R</code> - Return type for the <code>callable</code> parameter's |
| <a href="coprocessor/Batch.Call.html#call(T)"><code>Batch.Call.call(T)</code></a> method</dd> |
| <dt>Parameters:</dt> |
| <dd><code>service</code> - the protocol buffer <code>Service</code> implementation to call</dd> |
| <dd><code>startKey</code> - start region selection with region containing this row. If <code>null</code>, the |
| selection will start with the first table region.</dd> |
| <dd><code>endKey</code> - select regions up to and including the region containing this row. If |
| <code>null</code>, selection will continue through the last table region.</dd> |
| <dd><code>callable</code> - this instance's |
| <a href="coprocessor/Batch.Call.html#call(T)"><code>Batch.Call.call(T)</code></a> method will |
| be invoked once per table region, using the <code>Service</code> instance connected |
| to that region.</dd> |
| <dt>Returns:</dt> |
| <dd>a map of result values keyed by region name</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.hbase.thirdparty.com.google.protobuf.ServiceException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Connection.html#toAsyncConnection()"><code>Connection.toAsyncConnection()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="coprocessorService(java.lang.Class,byte[],byte[],org.apache.hadoop.hbase.client.coprocessor.Batch.Call,org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)"> |
| <h3>coprocessorService</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">default</span> <span class="type-parameters-long"><T extends org.apache.hbase.thirdparty.com.google.protobuf.Service,<wbr> |
| R></span> |
| <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-638">coprocessorService</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> service, |
| byte[] startKey, |
| byte[] endKey, |
| <a href="coprocessor/Batch.Call.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Call</a><T,<wbr>R> callable, |
| <a href="coprocessor/Batch.Callback.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Callback</a><R> callback)</span> |
| throws <span class="exceptions">org.apache.hbase.thirdparty.com.google.protobuf.ServiceException, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0. The batch call here references the blocking |
| interface for of a protobuf stub, so it is not possible to do it in an asynchronous |
| way, even if now we are building the <a href="Table.html" title="interface in org.apache.hadoop.hbase.client"><code>Table</code></a> implementation based on the |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a>, which is not good. Use the coprocessorService methods in |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a> directly instead.</div> |
| </div> |
| <div class="block">Creates an instance of the given <code>Service</code> subclass for each table region spanning the |
| range from the <code>startKey</code> row to <code>endKey</code> row (inclusive), and invokes the passed |
| <a href="coprocessor/Batch.Call.html#call(T)"><code>Batch.Call.call(T)</code></a> method with each |
| <code>Service</code> instance. |
| <p/> |
| The given |
| <a href="coprocessor/Batch.Callback.html#update(byte%5B%5D,byte%5B%5D,R)"><code>Batch.Callback.update(byte[],byte[],Object)</code></a> |
| method will be called with the return value from each region's |
| <a href="coprocessor/Batch.Call.html#call(T)"><code>Batch.Call.call(T)</code></a> invocation.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the <code>Service</code> subclass to connect to</dd> |
| <dd><code>R</code> - Return type for the <code>callable</code> parameter's |
| <a href="coprocessor/Batch.Call.html#call(T)"><code>Batch.Call.call(T)</code></a> method</dd> |
| <dt>Parameters:</dt> |
| <dd><code>service</code> - the protocol buffer <code>Service</code> implementation to call</dd> |
| <dd><code>startKey</code> - start region selection with region containing this row. If <code>null</code>, the |
| selection will start with the first table region.</dd> |
| <dd><code>endKey</code> - select regions up to and including the region containing this row. If |
| <code>null</code>, selection will continue through the last table region.</dd> |
| <dd><code>callable</code> - this instance's |
| <a href="coprocessor/Batch.Call.html#call(T)"><code>Batch.Call.call(T)</code></a> method will |
| be invoked once per table region, using the <code>Service</code> instance connected |
| to that region.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.hbase.thirdparty.com.google.protobuf.ServiceException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Connection.html#toAsyncConnection()"><code>Connection.toAsyncConnection()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="batchCoprocessorService(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor,org.apache.hbase.thirdparty.com.google.protobuf.Message,byte[],byte[],R)"> |
| <h3 id="batchCoprocessorService(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor,org.apache.hbase.thirdparty.com.google.protobuf.Message,byte[],byte[],org.apache.hbase.thirdparty.com.google.protobuf.Message)">batchCoprocessorService</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">default</span> <span class="type-parameters-long"><R extends org.apache.hbase.thirdparty.com.google.protobuf.Message></span> |
| <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><byte[],<wbr>R></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-666">batchCoprocessorService</a></span><wbr><span class="parameters">(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor, |
| org.apache.hbase.thirdparty.com.google.protobuf.Message request, |
| byte[] startKey, |
| byte[] endKey, |
| R responsePrototype)</span> |
| throws <span class="exceptions">org.apache.hbase.thirdparty.com.google.protobuf.ServiceException, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0. The batch call here references the blocking |
| interface for of a protobuf stub, so it is not possible to do it in an asynchronous |
| way, even if now we are building the <a href="Table.html" title="interface in org.apache.hadoop.hbase.client"><code>Table</code></a> implementation based on the |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a>, which is not good. Use the coprocessorService methods in |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a> directly instead.</div> |
| </div> |
| <div class="block">Creates an instance of the given <code>Service</code> subclass for each table region spanning the |
| range from the <code>startKey</code> row to <code>endKey</code> row (inclusive), all the invocations to |
| the same region server will be batched into one call. The coprocessor service is invoked |
| according to the service instance, method name and parameters.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>R</code> - the response type for the coprocessor Service method</dd> |
| <dt>Parameters:</dt> |
| <dd><code>methodDescriptor</code> - the descriptor for the protobuf service method to call.</dd> |
| <dd><code>request</code> - the method call parameters</dd> |
| <dd><code>startKey</code> - start region selection with region containing this row. If |
| <code>null</code>, the selection will start with the first table region.</dd> |
| <dd><code>endKey</code> - select regions up to and including the region containing this row. If |
| <code>null</code>, selection will continue through the last table region.</dd> |
| <dd><code>responsePrototype</code> - the proto type of the response of the method in Service.</dd> |
| <dt>Returns:</dt> |
| <dd>a map of result values keyed by region name</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.hbase.thirdparty.com.google.protobuf.ServiceException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Connection.html#toAsyncConnection()"><code>Connection.toAsyncConnection()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="batchCoprocessorService(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor,org.apache.hbase.thirdparty.com.google.protobuf.Message,byte[],byte[],R,org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)"> |
| <h3 id="batchCoprocessorService(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor,org.apache.hbase.thirdparty.com.google.protobuf.Message,byte[],byte[],org.apache.hbase.thirdparty.com.google.protobuf.Message,org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)">batchCoprocessorService</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">default</span> <span class="type-parameters-long"><R extends org.apache.hbase.thirdparty.com.google.protobuf.Message></span> |
| <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-709">batchCoprocessorService</a></span><wbr><span class="parameters">(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor, |
| org.apache.hbase.thirdparty.com.google.protobuf.Message request, |
| byte[] startKey, |
| byte[] endKey, |
| R responsePrototype, |
| <a href="coprocessor/Batch.Callback.html" title="interface in org.apache.hadoop.hbase.client.coprocessor">Batch.Callback</a><R> callback)</span> |
| throws <span class="exceptions">org.apache.hbase.thirdparty.com.google.protobuf.ServiceException, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0, will removed in 4.0.0. The batch call here references the blocking |
| interface for of a protobuf stub, so it is not possible to do it in an asynchronous |
| way, even if now we are building the <a href="Table.html" title="interface in org.apache.hadoop.hbase.client"><code>Table</code></a> implementation based on the |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a>, which is not good. Use the coprocessorService methods in |
| <a href="AsyncTable.html" title="interface in org.apache.hadoop.hbase.client"><code>AsyncTable</code></a> directly instead.</div> |
| </div> |
| <div class="block">Creates an instance of the given <code>Service</code> subclass for each table region spanning the |
| range from the <code>startKey</code> row to <code>endKey</code> row (inclusive), all the invocations to |
| the same region server will be batched into one call. The coprocessor service is invoked |
| according to the service instance, method name and parameters. |
| <p/> |
| The given |
| <a href="coprocessor/Batch.Callback.html#update(byte%5B%5D,byte%5B%5D,R)"><code>Batch.Callback.update(byte[],byte[],Object)</code></a> |
| method will be called with the return value from each region's invocation.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>R</code> - the response type for the coprocessor Service method</dd> |
| <dt>Parameters:</dt> |
| <dd><code>methodDescriptor</code> - the descriptor for the protobuf service method to call.</dd> |
| <dd><code>request</code> - the method call parameters</dd> |
| <dd><code>startKey</code> - start region selection with region containing this row. If |
| <code>null</code>, the selection will start with the first table region.</dd> |
| <dd><code>endKey</code> - select regions up to and including the region containing this row. If |
| <code>null</code>, selection will continue through the last table region.</dd> |
| <dd><code>responsePrototype</code> - the proto type of the response of the method in Service.</dd> |
| <dd><code>callback</code> - callback to invoke with the response for each region</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.hbase.thirdparty.com.google.protobuf.ServiceException</code></dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Throwable.html" title="class or interface in java.lang" class="external-link">Throwable</a></code></dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="Connection.html#toAsyncConnection()"><code>Connection.toAsyncConnection()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRpcTimeout(java.util.concurrent.TimeUnit)"> |
| <h3>getRpcTimeout</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-724">getRpcTimeout</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</span></div> |
| <div class="block">Get timeout of each rpc request in this Table instance. It will be overridden by a more |
| specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unit</code> - the unit of time the timeout to be represented in</dd> |
| <dt>Returns:</dt> |
| <dd>rpc timeout in the specified time unit</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getReadRpcTimeout(java.util.concurrent.TimeUnit)"><code>getReadRpcTimeout(TimeUnit)</code></a></li> |
| <li><a href="#getWriteRpcTimeout(java.util.concurrent.TimeUnit)"><code>getWriteRpcTimeout(TimeUnit)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReadRpcTimeout(java.util.concurrent.TimeUnit)"> |
| <h3>getReadRpcTimeout</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-733">getReadRpcTimeout</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</span></div> |
| <div class="block">Get timeout of each rpc read request in this Table instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unit</code> - the unit of time the timeout to be represented in</dd> |
| <dt>Returns:</dt> |
| <dd>read rpc timeout in the specified time unit</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWriteRpcTimeout(java.util.concurrent.TimeUnit)"> |
| <h3>getWriteRpcTimeout</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-742">getWriteRpcTimeout</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</span></div> |
| <div class="block">Get timeout of each rpc write request in this Table instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unit</code> - the unit of time the timeout to be represented in</dd> |
| <dt>Returns:</dt> |
| <dd>write rpc timeout in the specified time unit</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getOperationTimeout(java.util.concurrent.TimeUnit)"> |
| <h3>getOperationTimeout</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-751">getOperationTimeout</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/TimeUnit.html" title="class or interface in java.util.concurrent" class="external-link">TimeUnit</a> unit)</span></div> |
| <div class="block">Get timeout of each operation in Table instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unit</code> - the unit of time the timeout to be represented in</dd> |
| <dt>Returns:</dt> |
| <dd>operation rpc timeout in the specified time unit</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequestAttributes()"> |
| <h3>getRequestAttributes</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>byte[]></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/Table.html#line-759">getRequestAttributes</a></span>()</div> |
| <div class="block">Get the attributes to be submitted with requests</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>map of request attributes</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |