1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (version 1.6.0_27) on Thu Oct 17 21:45:04 EDT 2013 -->
6 <meta http-equiv="Content-Type" content="text/html" charset="utf-8">
7 <title>UpdateParams (Solr 4.5.1 API)</title>
8 <meta name="date" content="2013-10-17">
9 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
12 <script type="text/javascript"><!--
13 if (location.href.indexOf('is-external=true') == -1) {
14 parent.document.title="UpdateParams (Solr 4.5.1 API)";
19 <div>JavaScript is disabled on your browser.</div>
21 <!-- ========= START OF TOP NAVBAR ======= -->
22 <div class="topNav"><a name="navbar_top">
24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
27 <ul class="navList" title="Navigation">
28 <li><a href="../../../../../overview-summary.html">Overview</a></li>
29 <li><a href="package-summary.html">Package</a></li>
30 <li class="navBarCell1Rev">Class</li>
31 <li><a href="class-use/UpdateParams.html">Use</a></li>
32 <li><a href="package-tree.html">Tree</a></li>
33 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
34 <li><a href="../../../../../help-doc.html">Help</a></li>
39 <li><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html" title="interface in org.apache.solr.common.params"><span class="strong">PREV CLASS</span></a></li>
43 <li><a href="../../../../../index.html?org/apache/solr/common/params/UpdateParams.html" target="_top">FRAMES</a></li>
44 <li><a href="UpdateParams.html" target="_top">NO FRAMES</a></li>
46 <ul class="navList" id="allclasses_navbar_top">
47 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
50 <script type="text/javascript"><!--
51 allClassesLink = document.getElementById("allclasses_navbar_top");
53 allClassesLink.style.display = "block";
56 allClassesLink.style.display = "none";
62 <ul class="subNavList">
63 <li>SUMMARY: </li>
64 <li>NESTED | </li>
65 <li><a href="#field_summary">FIELD</a> | </li>
66 <li>CONSTR | </li>
69 <ul class="subNavList">
70 <li>DETAIL: </li>
71 <li><a href="#field_detail">FIELD</a> | </li>
72 <li>CONSTR | </li>
76 <a name="skip-navbar_top">
79 <!-- ========= END OF TOP NAVBAR ========= -->
80 <!-- ======== START OF CLASS DATA ======== -->
82 <p class="subTitle">org.apache.solr.common.params</p>
83 <h2 title="Interface UpdateParams" class="title">Interface UpdateParams</h2>
85 <div class="contentContainer">
86 <div class="description">
87 <ul class="blockList">
88 <li class="blockList">
91 <pre>public interface <strong>UpdateParams</strong></pre>
92 <div class="block">A collection of standard params used by Update handlers</div>
93 <dl><dt><span class="strong">Since:</span></dt>
94 <dd>solr 1.2</dd></dl>
99 <ul class="blockList">
100 <li class="blockList">
101 <!-- =========== FIELD SUMMARY =========== -->
102 <ul class="blockList">
103 <li class="blockList"><a name="field_summary">
106 <h3>Field Summary</h3>
107 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
108 <caption><span>Fields</span><span class="tabEnd"> </span></caption>
110 <th class="colFirst" scope="col">Modifier and Type</th>
111 <th class="colLast" scope="col">Field and Description</th>
113 <tr class="altColor">
114 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
115 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#ASSUME_CONTENT_TYPE">ASSUME_CONTENT_TYPE</a></strong></code>
116 <div class="block">Override the content type used for UpdateLoader</div>
119 <tr class="rowColor">
120 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
121 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#COMMIT">COMMIT</a></strong></code>
122 <div class="block">Commit everything after the command completes</div>
125 <tr class="altColor">
126 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
127 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#COMMIT_WITHIN">COMMIT_WITHIN</a></strong></code>
128 <div class="block">Commit within a certain time period (in ms)</div>
131 <tr class="rowColor">
132 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
133 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#EXPUNGE_DELETES">EXPUNGE_DELETES</a></strong></code> </td>
135 <tr class="altColor">
136 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
137 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#MAX_OPTIMIZE_SEGMENTS">MAX_OPTIMIZE_SEGMENTS</a></strong></code>
138 <div class="block">If optimizing, set the maximum number of segments left in the index after optimization.</div>
141 <tr class="rowColor">
142 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
143 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#OPEN_SEARCHER">OPEN_SEARCHER</a></strong></code>
144 <div class="block">Open up a new searcher as part of a commit</div>
147 <tr class="altColor">
148 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
149 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#OPTIMIZE">OPTIMIZE</a></strong></code>
150 <div class="block">Optimize the index and commit everything after the command completes</div>
153 <tr class="rowColor">
154 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
155 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#OVERWRITE">OVERWRITE</a></strong></code>
156 <div class="block">overwrite indexing fields</div>
159 <tr class="altColor">
160 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
161 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#PREPARE_COMMIT">PREPARE_COMMIT</a></strong></code>
162 <div class="block">expert: calls IndexWriter.prepareCommit</div>
165 <tr class="rowColor">
166 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
167 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#ROLLBACK">ROLLBACK</a></strong></code>
168 <div class="block">Rollback update commands</div>
171 <tr class="altColor">
172 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
173 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#SOFT_COMMIT">SOFT_COMMIT</a></strong></code> </td>
175 <tr class="rowColor">
176 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
177 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#UPDATE_CHAIN">UPDATE_CHAIN</a></strong></code>
178 <div class="block">Select the update processor chain to use.</div>
181 <tr class="altColor">
182 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
183 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#VERSIONS">VERSIONS</a></strong></code>
184 <div class="block">Return versions of updates?</div>
187 <tr class="rowColor">
188 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
189 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/common/params/UpdateParams.html#WAIT_SEARCHER">WAIT_SEARCHER</a></strong></code>
190 <div class="block">wait for the searcher to be registered/visible</div>
199 <div class="details">
200 <ul class="blockList">
201 <li class="blockList">
202 <!-- ============ FIELD DETAIL =========== -->
203 <ul class="blockList">
204 <li class="blockList"><a name="field_detail">
207 <h3>Field Detail</h3>
208 <a name="OPEN_SEARCHER">
211 <ul class="blockList">
212 <li class="blockList">
213 <h4>OPEN_SEARCHER</h4>
214 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OPEN_SEARCHER</pre>
215 <div class="block">Open up a new searcher as part of a commit</div>
216 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.OPEN_SEARCHER">Constant Field Values</a></dd></dl>
219 <a name="WAIT_SEARCHER">
222 <ul class="blockList">
223 <li class="blockList">
224 <h4>WAIT_SEARCHER</h4>
225 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> WAIT_SEARCHER</pre>
226 <div class="block">wait for the searcher to be registered/visible</div>
227 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.WAIT_SEARCHER">Constant Field Values</a></dd></dl>
230 <a name="SOFT_COMMIT">
233 <ul class="blockList">
234 <li class="blockList">
236 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SOFT_COMMIT</pre>
237 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.SOFT_COMMIT">Constant Field Values</a></dd></dl>
243 <ul class="blockList">
244 <li class="blockList">
246 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OVERWRITE</pre>
247 <div class="block">overwrite indexing fields</div>
248 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.OVERWRITE">Constant Field Values</a></dd></dl>
254 <ul class="blockList">
255 <li class="blockList">
257 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> COMMIT</pre>
258 <div class="block">Commit everything after the command completes</div>
259 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.COMMIT">Constant Field Values</a></dd></dl>
262 <a name="COMMIT_WITHIN">
265 <ul class="blockList">
266 <li class="blockList">
267 <h4>COMMIT_WITHIN</h4>
268 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> COMMIT_WITHIN</pre>
269 <div class="block">Commit within a certain time period (in ms)</div>
270 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.COMMIT_WITHIN">Constant Field Values</a></dd></dl>
276 <ul class="blockList">
277 <li class="blockList">
279 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> OPTIMIZE</pre>
280 <div class="block">Optimize the index and commit everything after the command completes</div>
281 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.OPTIMIZE">Constant Field Values</a></dd></dl>
284 <a name="PREPARE_COMMIT">
287 <ul class="blockList">
288 <li class="blockList">
289 <h4>PREPARE_COMMIT</h4>
290 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PREPARE_COMMIT</pre>
291 <div class="block">expert: calls IndexWriter.prepareCommit</div>
292 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.PREPARE_COMMIT">Constant Field Values</a></dd></dl>
298 <ul class="blockList">
299 <li class="blockList">
301 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ROLLBACK</pre>
302 <div class="block">Rollback update commands</div>
303 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.ROLLBACK">Constant Field Values</a></dd></dl>
306 <a name="UPDATE_CHAIN">
309 <ul class="blockList">
310 <li class="blockList">
311 <h4>UPDATE_CHAIN</h4>
312 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> UPDATE_CHAIN</pre>
313 <div class="block">Select the update processor chain to use. A RequestHandler may or may not respect this parameter</div>
314 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.UPDATE_CHAIN">Constant Field Values</a></dd></dl>
317 <a name="ASSUME_CONTENT_TYPE">
320 <ul class="blockList">
321 <li class="blockList">
322 <h4>ASSUME_CONTENT_TYPE</h4>
323 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ASSUME_CONTENT_TYPE</pre>
324 <div class="block">Override the content type used for UpdateLoader</div>
325 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.ASSUME_CONTENT_TYPE">Constant Field Values</a></dd></dl>
328 <a name="MAX_OPTIMIZE_SEGMENTS">
331 <ul class="blockList">
332 <li class="blockList">
333 <h4>MAX_OPTIMIZE_SEGMENTS</h4>
334 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> MAX_OPTIMIZE_SEGMENTS</pre>
335 <div class="block">If optimizing, set the maximum number of segments left in the index after optimization. 1 is the default (and is equivalent to calling IndexWriter.optimize() in Lucene).</div>
336 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.MAX_OPTIMIZE_SEGMENTS">Constant Field Values</a></dd></dl>
339 <a name="EXPUNGE_DELETES">
342 <ul class="blockList">
343 <li class="blockList">
344 <h4>EXPUNGE_DELETES</h4>
345 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> EXPUNGE_DELETES</pre>
346 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.EXPUNGE_DELETES">Constant Field Values</a></dd></dl>
352 <ul class="blockListLast">
353 <li class="blockList">
355 <pre>static final <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> VERSIONS</pre>
356 <div class="block">Return versions of updates?</div>
357 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.solr.common.params.UpdateParams.VERSIONS">Constant Field Values</a></dd></dl>
366 <!-- ========= END OF CLASS DATA ========= -->
367 <!-- ======= START OF BOTTOM NAVBAR ====== -->
368 <div class="bottomNav"><a name="navbar_bottom">
370 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
373 <ul class="navList" title="Navigation">
374 <li><a href="../../../../../overview-summary.html">Overview</a></li>
375 <li><a href="package-summary.html">Package</a></li>
376 <li class="navBarCell1Rev">Class</li>
377 <li><a href="class-use/UpdateParams.html">Use</a></li>
378 <li><a href="package-tree.html">Tree</a></li>
379 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
380 <li><a href="../../../../../help-doc.html">Help</a></li>
385 <li><a href="../../../../../org/apache/solr/common/params/TermVectorParams.html" title="interface in org.apache.solr.common.params"><span class="strong">PREV CLASS</span></a></li>
389 <li><a href="../../../../../index.html?org/apache/solr/common/params/UpdateParams.html" target="_top">FRAMES</a></li>
390 <li><a href="UpdateParams.html" target="_top">NO FRAMES</a></li>
392 <ul class="navList" id="allclasses_navbar_bottom">
393 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
396 <script type="text/javascript"><!--
397 allClassesLink = document.getElementById("allclasses_navbar_bottom");
399 allClassesLink.style.display = "block";
402 allClassesLink.style.display = "none";
408 <ul class="subNavList">
409 <li>SUMMARY: </li>
410 <li>NESTED | </li>
411 <li><a href="#field_summary">FIELD</a> | </li>
412 <li>CONSTR | </li>
415 <ul class="subNavList">
416 <li>DETAIL: </li>
417 <li><a href="#field_detail">FIELD</a> | </li>
418 <li>CONSTR | </li>
422 <a name="skip-navbar_bottom">
425 <!-- ======== END OF BOTTOM NAVBAR ======= -->
426 <p class="legalCopy"><small>
427 <i>Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.</i>
428 <script src='../../../../../prettify.js' type='text/javascript'></script>
429 <script type='text/javascript'>
431 var oldonload = window.onload;
432 if (typeof oldonload != 'function') {
433 window.onload = prettyPrint;
435 window.onload = function() {