blob: c7362594b074b1c6dc55a2dfd2ff6952b0939e95 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TableOperations.ImportMappingOptions (Apache Accumulo Project 2.1.2 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.accumulo.core.client.admin, interface: TableOperations, interface: ImportMappingOptions">
<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/TableOperations.ImportMappingOptions.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.accumulo.core.client.admin</a></div>
<h1 title="Interface TableOperations.ImportMappingOptions" class="title">Interface TableOperations.ImportMappingOptions</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="TableOperations.ImportOptions.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations.ImportOptions</a></code></dd>
</dl>
<dl class="notes">
<dt>Enclosing interface:</dt>
<dd><a href="TableOperations.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">TableOperations.ImportMappingOptions</span><span class="extends-implements">
extends <a href="TableOperations.ImportOptions.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations.ImportOptions</a></span></div>
<div class="block">Options giving control of how the bulk import file mapping is done.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>2.0.0</dd>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</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">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#BULK_LOAD_THREADS_DEFAULT" class="member-name-link">BULK_LOAD_THREADS_DEFAULT</a></code></div>
<div class="col-last even-row-color">
<div class="block">This is the default number of threads used to determine where to load files.</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></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-tab3"><code><a href="TableOperations.ImportOptions.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations.ImportOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#executor(java.util.concurrent.Executor)" class="member-name-link">executor</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a>&nbsp;service)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Files are examined to determine where to load them.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TableOperations.ImportOptions.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations.ImportOptions</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#plan(org.apache.accumulo.core.data.LoadPlan)" class="member-name-link">plan</a><wbr>(<a href="../../data/LoadPlan.html" title="class in org.apache.accumulo.core.data">LoadPlan</a>&nbsp;service)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Load files in the directory to the row ranges specified in the plan.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="TableOperations.ImportOptions.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations.ImportOptions</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#threads(int)" class="member-name-link">threads</a><wbr>(int&nbsp;numThreads)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Files are examined to determine where to load them.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.accumulo.core.client.admin.TableOperations.ImportOptions">Methods inherited from interface&nbsp;org.apache.accumulo.core.client.admin.<a href="TableOperations.ImportOptions.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations.ImportOptions</a></h3>
<code><a href="TableOperations.ImportOptions.html#ignoreEmptyDir(boolean)">ignoreEmptyDir</a>, <a href="TableOperations.ImportOptions.html#load()">load</a>, <a href="TableOperations.ImportOptions.html#tableTime(boolean)">tableTime</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="BULK_LOAD_THREADS_DEFAULT">
<h3>BULK_LOAD_THREADS_DEFAULT</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">BULK_LOAD_THREADS_DEFAULT</span></div>
<div class="block">This is the default number of threads used to determine where to load files. A suffix of
<code>C</code> means to multiply by the number of cores.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../../constant-values.html#org.apache.accumulo.core.client.admin.TableOperations.ImportMappingOptions.BULK_LOAD_THREADS_DEFAULT">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="plan(org.apache.accumulo.core.data.LoadPlan)">
<h3>plan</h3>
<div class="member-signature"><span class="return-type"><a href="TableOperations.ImportOptions.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations.ImportOptions</a></span>&nbsp;<span class="element-name">plan</span><wbr><span class="parameters">(<a href="../../data/LoadPlan.html" title="class in org.apache.accumulo.core.data">LoadPlan</a>&nbsp;service)</span></div>
<div class="block">Load files in the directory to the row ranges specified in the plan. The plan should contain
at least one entry for every file in the directory. When this option is specified, the files
are never examined so it is possible to send files to the wrong tablet.</div>
</section>
</li>
<li>
<section class="detail" id="executor(java.util.concurrent.Executor)">
<h3>executor</h3>
<div class="member-signature"><span class="return-type"><a href="TableOperations.ImportOptions.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations.ImportOptions</a></span>&nbsp;<span class="element-name">executor</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link">Executor</a>&nbsp;service)</span></div>
<div class="block">Files are examined to determine where to load them. This examination is done in the current
process using multiple threads. If this method is not called, then the client property
<code>bulk.threads</code> is used to create a thread pool. This property defaults to
<a href="#BULK_LOAD_THREADS_DEFAULT">"8C"</a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>service</code> - Use this executor to run file examination task</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="threads(int)">
<h3>threads</h3>
<div class="member-signature"><span class="return-type"><a href="TableOperations.ImportOptions.html" title="interface in org.apache.accumulo.core.client.admin">TableOperations.ImportOptions</a></span>&nbsp;<span class="element-name">threads</span><wbr><span class="parameters">(int&nbsp;numThreads)</span></div>
<div class="block">Files are examined to determine where to load them. This examination is done in the current
process using multiple threads. If this method is not called, then the client property
<code>bulk.threads</code> is used to create a thread pool. This property defaults to
<a href="#BULK_LOAD_THREADS_DEFAULT">"8C"</a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>numThreads</code> - Create a thread pool with this many thread to run file examination task.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2011&#x2013;2023 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>