/usr/share/doc/python-elasticsearch-curator-doc/html/index.html is in python-elasticsearch-curator-doc 3.4.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Elasticsearch Curator Python API — Elasticsearch Curator 3.4.1 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '3.4.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Elasticsearch Curator 3.4.1 documentation" href="#" />
<link rel="next" title="Command Methods" href="commands.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="commands.html" title="Command Methods"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Elasticsearch Curator 3.4.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="elasticsearch-curator-python-api">
<h1>Elasticsearch Curator Python API<a class="headerlink" href="#elasticsearch-curator-python-api" title="Permalink to this headline">¶</a></h1>
<p>The Elasticsearch Curator Python API helps you manage your indices and
snapshots.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This documentation is for the Elasticsearch Curator Python API. Documentation
for the Elasticsearch Curator <em>CLI</em> – which uses this API and is installed
as an entry_point as part of the package – is available in the
<a class="reference external" href="http://www.elastic.co/guide/en/elasticsearch/client/curator/current/index.html">Elastic guide</a>.</p>
</div>
<div class="section" id="compatibility">
<h2>Compatibility<a class="headerlink" href="#compatibility" title="Permalink to this headline">¶</a></h2>
<p>The Elasticsearch Curator Python API is compatible with Elasticsearch versions 1.x
through 2.0, and supports Python versions 2.6 and later.</p>
</div>
<div class="section" id="example-usage">
<h2>Example Usage<a class="headerlink" href="#example-usage" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">elasticsearch</span>
<span class="kn">import</span> <span class="nn">curator</span>
<span class="n">client</span> <span class="o">=</span> <span class="n">elasticsearch</span><span class="o">.</span><span class="n">Elasticsearch</span><span class="p">()</span>
<span class="n">curator</span><span class="o">.</span><span class="n">close_indices</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="p">[</span><span class="s1">'logstash-2014.08.16'</span><span class="p">,</span><span class="s1">'logstash-2014.08.17'</span><span class="p">])</span>
<span class="n">curator</span><span class="o">.</span><span class="n">disable_bloom_filter</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="s1">'logstash-2014.08.31'</span><span class="p">)</span>
<span class="n">curator</span><span class="o">.</span><span class="n">optimize_index</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="s1">'logstash-2014.08.31'</span><span class="p">)</span>
<span class="n">curator</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="p">[</span><span class="s1">'logstash-2014.07.16'</span><span class="p">,</span> <span class="s1">'logstash-2014.07.17'</span><span class="p">])</span>
</pre></div>
</div>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">See more examples in the <a class="reference internal" href="examples.html"><em>Examples</em></a> page.</p>
</div>
</div>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
<p>The API methods fall into the following categories:</p>
<ul class="simple">
<li><a class="reference internal" href="commands.html"><em>Commands</em></a> take a single index, or in some cases a list of indices and perform an action on them.</li>
<li><a class="reference internal" href="filters.html"><em>Filters</em></a> are there to filter indices or snapshots based on provided criteria.</li>
<li><a class="reference internal" href="utilities.html"><em>Utilities</em></a> are helper methods for commands and filters.</li>
</ul>
<p>Filtering indices is now handled by the <a class="reference internal" href="filters.html#curator.api.build_filter" title="curator.api.build_filter"><code class="xref py py-func docutils literal"><span class="pre">curator.api.build_filter()</span></code></a> method.</p>
<div class="section" id="logging">
<h3>Logging<a class="headerlink" href="#logging" title="Permalink to this headline">¶</a></h3>
<p>The Elasticsearch Curator Python API uses the standard <a class="reference external" href="http://docs.python.org/3.3/library/logging.html">logging library</a> from Python.
It inherits two loggers from <code class="docutils literal"><span class="pre">elasticsearch-py</span></code>: <code class="docutils literal"><span class="pre">elasticsearch</span></code> and
<code class="docutils literal"><span class="pre">elasticsearch.trace</span></code>. Clients use the <code class="docutils literal"><span class="pre">elasticsearch</span></code> logger to log
standard activity, depending on the log level. The <code class="docutils literal"><span class="pre">elasticsearch.trace</span></code>
logger logs requests to the server in JSON format as pretty-printed <code class="docutils literal"><span class="pre">curl</span></code>
commands that you can execute from the command line. The <code class="docutils literal"><span class="pre">elasticsearch.trace</span></code>
logger is not inherited from the base logger and must be activated separately.</p>
</div>
</div>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="commands.html">Command Methods</a><ul>
<li class="toctree-l2"><a class="reference internal" href="commands.html#aliasing-indices">Aliasing Indices</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#index-routing-allocation">Index Routing Allocation</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#disabling-bloom-filters">Disabling Bloom Filters</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#closing-indices">Closing Indices</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#deleting-indices">Deleting Indices</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#opening-indices">Opening Indices</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#optimizing-indices">Optimizing Indices</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#changing-index-replica-count">Changing Index Replica Count</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#sealing-synced-flush-indices">Sealing (Synced Flush) Indices</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#show-indices">Show Indices</a></li>
<li class="toctree-l2"><a class="reference internal" href="commands.html#snapshot-indices">Snapshot Indices</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="filters.html">Filter Methods</a><ul>
<li class="toctree-l2"><a class="reference internal" href="filters.html#regex">Regex</a></li>
<li class="toctree-l2"><a class="reference internal" href="filters.html#date-time">Date & Time</a></li>
<li class="toctree-l2"><a class="reference internal" href="filters.html#disk-space">Disk Space</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="utilities.html">Utility & Helper Methods</a><ul>
<li class="toctree-l2"><a class="reference internal" href="utilities.html#get-information">Get Information</a></li>
<li class="toctree-l2"><a class="reference internal" href="utilities.html#verification">Verification</a></li>
<li class="toctree-l2"><a class="reference internal" href="utilities.html#index-pruning">Index Pruning</a></li>
<li class="toctree-l2"><a class="reference internal" href="utilities.html#other">Other</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#build-filter-examples"><cite>build_filter</cite> Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#february-2016">3.4.1 (10 February 2016)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#october-2015">3.4.0 (28 October 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#august-2015">3.3.0 (31 August 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#july-2015">3.2.3 (16 July 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id2">3.2.2 (13 July 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id3">3.2.1 (10 July 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#june-2015">3.2.0 (25 June 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#may-2015">3.1.0 (21 May 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#mar-2015">3.0.3 (27 Mar 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id4">3.0.2 (23 Mar 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id5">3.0.1 (16 Mar 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#march-2015">3.0.0 (9 March 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#rc1-5-march-2015">3.0.0rc1 (5 March 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#b4-5-march-2015">3.0.0b4 (5 March 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#b3-4-march-2015">3.0.0b3 (4 March 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#beta2-3-march-2015">3.0.0-beta2 (3 March 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#beta1-3-march-2015">3.0.0-beta1 (3 March 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#january-2015">2.1.2 (22 January 2015)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#december-2014">2.1.1 (30 December 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id6">2.1.0 (30 December 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#october-2014">2.0.2 (8 October 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id7">2.0.1 (1 October 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#september-2014">2.0.0 (25 September 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#july-2014">1.2.2 (29 July 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id8">1.2.1 (24 July 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id9">1.2.0 (24 July 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id10">1.1.3 (18 July 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#june-2014">1.1.2 (13 June 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id11">1.1.0 (12 June 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#mar-2014">1.0.0 (25 Mar 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#feb-2014">0.6.2 (18 Feb 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id12">0.6.1 (08 Feb 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id13">0.6.0 (08 Feb 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#jan-2014">0.5.2 (26 Jan 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id14">0.5.1 (20 Jan 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id15">0.5.0 (17 Jan 2014)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Changelog.html#id16">0.4.0</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h2>
<p>Copyright 2013–2015 Elastic <<a class="reference external" href="http://elastic.co">http://elastic.co</a>> and contributors.</p>
<p>Licensed under the Apache License, Version 2.0 (the “License”);
you may not use this file except in compliance with the License.
You may obtain a copy of the License at</p>
<blockquote>
<div><a class="reference external" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></div></blockquote>
<p>Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an “AS IS” BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.</p>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span>Index</span></a></li>
<li><a class="reference internal" href="search.html"><span>Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Elasticsearch Curator Python API</a><ul>
<li><a class="reference internal" href="#compatibility">Compatibility</a></li>
<li><a class="reference internal" href="#example-usage">Example Usage</a></li>
<li><a class="reference internal" href="#features">Features</a><ul>
<li><a class="reference internal" href="#logging">Logging</a></li>
</ul>
</li>
<li><a class="reference internal" href="#contents">Contents</a></li>
<li><a class="reference internal" href="#license">License</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="commands.html"
title="next chapter">Command Methods</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="commands.html" title="Command Methods"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">Elasticsearch Curator 3.4.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011-2015, Elasticsearch.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
</div>
</body>
</html>
|