blob: 90bbb8846aa68765fd7e255d8ffda7be0f723851 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_201) on Thu Apr 11 20:05:14 EDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.accumulo.core.client (Apache Accumulo Project 1.9.3 API)</title>
<meta name="date" content="2019-04-11">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.accumulo.core.client (Apache Accumulo Project 1.9.3 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../../../../org/apache/accumulo/core/client/admin/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/accumulo/core/client/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.accumulo.core.client</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/BatchDeleter.html" title="interface in org.apache.accumulo.core.client">BatchDeleter</a></td>
<td class="colLast">
<div class="block">Implementations of BatchDeleter support efficient deletion of ranges in accumulo.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/BatchScanner.html" title="interface in org.apache.accumulo.core.client">BatchScanner</a></td>
<td class="colLast">
<div class="block">In exchange for possibly <b>returning scanned entries out of order</b>, BatchScanner
implementations may scan an Accumulo table more efficiently by
Looking up multiple ranges in parallel.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client">BatchWriter</a></td>
<td class="colLast">
<div class="block">Send Mutations to a single Table in Accumulo.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.html" title="interface in org.apache.accumulo.core.client">ConditionalWriter</a></td>
<td class="colLast">
<div class="block">ConditionalWriter provides the ability to do efficient, atomic read-modify-write operations on
rows.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/Instance.html" title="interface in org.apache.accumulo.core.client">Instance</a></td>
<td class="colLast">
<div class="block">This class represents the information a client needs to know to connect to an instance of
accumulo.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.RowBuffer.html" title="interface in org.apache.accumulo.core.client">IsolatedScanner.RowBuffer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.RowBufferFactory.html" title="interface in org.apache.accumulo.core.client">IsolatedScanner.RowBufferFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/MultiTableBatchWriter.html" title="interface in org.apache.accumulo.core.client">MultiTableBatchWriter</a></td>
<td class="colLast">
<div class="block">This class enables efficient batch writing to multiple tables.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></td>
<td class="colLast">
<div class="block">Scans a table over a given range.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></td>
<td class="colLast">
<div class="block">This class hosts configuration methods that are shared between different types of scanners.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/BatchWriterConfig.html" title="class in org.apache.accumulo.core.client">BatchWriterConfig</a></td>
<td class="colLast">
<div class="block">This object holds configuration settings used to instantiate a <a href="../../../../../org/apache/accumulo/core/client/BatchWriter.html" title="interface in org.apache.accumulo.core.client"><code>BatchWriter</code></a></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/ClientConfiguration.html" title="class in org.apache.accumulo.core.client">ClientConfiguration</a></td>
<td class="colLast">
<div class="block">Contains a list of property keys recognized by the Accumulo client and convenience methods for
setting them.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html" title="class in org.apache.accumulo.core.client">ClientSideIteratorScanner</a></td>
<td class="colLast">
<div class="block">A scanner that instantiates iterators on the client side instead of on the tablet server.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Result.html" title="class in org.apache.accumulo.core.client">ConditionalWriter.Result</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriterConfig.html" title="class in org.apache.accumulo.core.client">ConditionalWriterConfig</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/Connector.html" title="class in org.apache.accumulo.core.client">Connector</a></td>
<td class="colLast">
<div class="block">Connector connects to an Accumulo instance and allows the user to request readers and writers for
the instance as well as various objects that permit administrative operations.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.html" title="class in org.apache.accumulo.core.client">IsolatedScanner</a></td>
<td class="colLast">
<div class="block">A scanner that presents a row isolated view of an accumulo table.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.MemoryRowBuffer.html" title="class in org.apache.accumulo.core.client">IsolatedScanner.MemoryRowBuffer</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/IsolatedScanner.MemoryRowBufferFactory.html" title="class in org.apache.accumulo.core.client">IsolatedScanner.MemoryRowBufferFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.html" title="class in org.apache.accumulo.core.client">IteratorSetting</a></td>
<td class="colLast">
<div class="block">Configure an iterator for minc, majc, and/or scan.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/IteratorSetting.Column.html" title="class in org.apache.accumulo.core.client">IteratorSetting.Column</a></td>
<td class="colLast">
<div class="block">A convenience class for passing column family and column qualifiers to iterator configuration
methods.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/RowIterator.html" title="class in org.apache.accumulo.core.client">RowIterator</a></td>
<td class="colLast">
<div class="block">Group Key/Value pairs into Iterators over rows.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/ZooKeeperInstance.html" title="class in org.apache.accumulo.core.client">ZooKeeperInstance</a></td>
<td class="colLast">
<div class="block">An implementation of instance that looks in zookeeper to find information needed to connect to an
instance of accumulo.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/ClientConfiguration.ClientProperty.html" title="enum in org.apache.accumulo.core.client">ClientConfiguration.ClientProperty</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/Durability.html" title="enum in org.apache.accumulo.core.client">Durability</a></td>
<td class="colLast">
<div class="block">The value for the durability of a BatchWriter or ConditionalWriter.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></td>
<td class="colLast">
<div class="block">A generic Accumulo Exception for general accumulo failures.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></td>
<td class="colLast">
<div class="block">An Accumulo Exception for security violations, authentication failures, authorization failures,
etc.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/MutationsRejectedException.html" title="class in org.apache.accumulo.core.client">MutationsRejectedException</a></td>
<td class="colLast">
<div class="block">Communicate the failed mutations of a BatchWriter back to the client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/NamespaceExistsException.html" title="class in org.apache.accumulo.core.client">NamespaceExistsException</a></td>
<td class="colLast">
<div class="block">Thrown when the namespace specified already exists, and it was expected that it didn't</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/NamespaceNotEmptyException.html" title="class in org.apache.accumulo.core.client">NamespaceNotEmptyException</a></td>
<td class="colLast">
<div class="block">Thrown when the namespace specified contains tables</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/NamespaceNotFoundException.html" title="class in org.apache.accumulo.core.client">NamespaceNotFoundException</a></td>
<td class="colLast">
<div class="block">Thrown when the namespace specified doesn't exist when it was expected to</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/SampleNotPresentException.html" title="class in org.apache.accumulo.core.client">SampleNotPresentException</a></td>
<td class="colLast">
<div class="block">Exception thrown when a table does not have sampling configured or when sampling is configured
but it differs from what was requested.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/TableDeletedException.html" title="class in org.apache.accumulo.core.client">TableDeletedException</a></td>
<td class="colLast">
<div class="block">This exception is thrown if a table is deleted after an operation starts.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/TableExistsException.html" title="class in org.apache.accumulo.core.client">TableExistsException</a></td>
<td class="colLast">
<div class="block">Thrown when the table specified already exists, and it was expected that it didn't</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/TableNotFoundException.html" title="class in org.apache.accumulo.core.client">TableNotFoundException</a></td>
<td class="colLast">
<div class="block">Thrown when the table specified doesn't exist when it was expected to</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/TableOfflineException.html" title="class in org.apache.accumulo.core.client">TableOfflineException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/accumulo/core/client/TimedOutException.html" title="class in org.apache.accumulo.core.client">TimedOutException</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Package</li>
<li><a href="../../../../../org/apache/accumulo/core/client/admin/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/accumulo/core/client/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2011&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>