/usr/share/doc/mapproxy/html/caches.html is in mapproxy-doc 1.9.0-3+deb9u1.
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 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 | <!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Caches — MapProxy 1.8.2a0 Docs</title>
<link rel="stylesheet" href="_static/basic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-3.3.6/css/bootstrap.min.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-3.3.6/css/bootstrap-theme.min.css" type="text/css" />
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/mapproxy.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.8.2a0',
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>
<script type="text/javascript" src="_static/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="_static/bootstrap-3.3.6/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="MapProxy 1.8.2a0 Docs" href="index.html" />
<link rel="next" title="Seeding" href="seed.html" />
<link rel="prev" title="Sources" href="sources.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
</head>
<body role="document">
<div id="navbar" class="navbar navbar-default ">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a href="index.html" class="pull-left"><img src="_static/logo.png" height="50">
</a>
<a class="navbar-brand" href="index.html">
<span>
MapProxy</span>
<span>1.8.2a0</span>
</a>
</div>
<div class="collapse navbar-collapse nav-collapse">
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3">
<div id="sidebar" class="bs-sidenav" role="complementary"><ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="install_windows.html">Installation on Windows</a></li>
<li class="toctree-l1"><a class="reference internal" href="install_osgeo4w.html">Installation on OSGeo4W</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="services.html">Services</a></li>
<li class="toctree-l1"><a class="reference internal" href="sources.html">Sources</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Caches</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#configuration">Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="#file"><code class="docutils literal"><span class="pre">file</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#mbtiles"><code class="docutils literal"><span class="pre">mbtiles</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#sqlite"><code class="docutils literal"><span class="pre">sqlite</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#couchdb"><code class="docutils literal"><span class="pre">couchdb</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#riak"><code class="docutils literal"><span class="pre">riak</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="seed.html">Seeding</a></li>
<li class="toctree-l1"><a class="reference internal" href="coverages.html">Coverages</a></li>
<li class="toctree-l1"><a class="reference internal" href="mapproxy_util.html">mapproxy-util</a></li>
<li class="toctree-l1"><a class="reference internal" href="mapproxy_util_autoconfig.html">mapproxy-util autoconfig</a></li>
<li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration_examples.html">Configuration examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="inspire.html">INSPIRE View Service</a></li>
<li class="toctree-l1"><a class="reference internal" href="labeling.html">WMS Labeling</a></li>
<li class="toctree-l1"><a class="reference internal" href="auth.html">Authentication and Authorization</a></li>
<li class="toctree-l1"><a class="reference internal" href="decorate_img.html">Decorate Image</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="mapproxy_2.html">MapProxy 2.0</a></li>
</ul>
</div>
</div>
<div class="col-md-8">
<div class="section" id="caches">
<h1>Caches<a class="headerlink" href="#caches" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.2.0.</span></p>
</div>
<p>MapProxy supports multiple backends to store the internal tiles. The default backend is file based and does not require any further configuration.</p>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<p>You can configure a backend for each cache with the <code class="docutils literal"><span class="pre">cache</span></code> option.
Each backend has a <code class="docutils literal"><span class="pre">type</span></code> and one or more options.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">caches</span><span class="p">:</span>
<span class="n">mycache</span><span class="p">:</span>
<span class="n">sources</span><span class="p">:</span> <span class="p">[</span><span class="o">...</span><span class="p">]</span>
<span class="n">grids</span><span class="p">:</span> <span class="p">[</span><span class="o">...</span><span class="p">]</span>
<span class="n">cache</span><span class="p">:</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">backendtype</span>
<span class="n">backendoption1</span><span class="p">:</span> <span class="n">value</span>
<span class="n">backendoption2</span><span class="p">:</span> <span class="n">value</span>
</pre></div>
</div>
<p>The following backend types are available.</p>
</div>
<div class="section" id="file">
<h2><code class="docutils literal"><span class="pre">file</span></code><a class="headerlink" href="#file" title="Permalink to this headline">¶</a></h2>
<p>This is the default cache type and it uses a single file for each tile. Available options are:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">directory_layout</span></code>:</dt>
<dd><p class="first">The directory layout MapProxy uses to store tiles on disk. Defaults to <code class="docutils literal"><span class="pre">tc</span></code> which uses a TileCache compatible directory layout (<code class="docutils literal"><span class="pre">zz/xxx/xxx/xxx/yyy/yyy/yyy.format</span></code>). <code class="docutils literal"><span class="pre">mp</span></code> uses a directory layout with less nesting (<code class="docutils literal"><span class="pre">zz/xxxx/xxxx/yyyy/yyyy.format`</span></code>). <code class="docutils literal"><span class="pre">tms</span></code> uses TMS compatible directories (<code class="docutils literal"><span class="pre">zz/xxxx/yyyy.format</span></code>). <code class="docutils literal"><span class="pre">quadkey</span></code> uses Microsoft Virtual Earth or quadkey compatible directories (see <a class="reference external" href="http://msdn.microsoft.com/en-us/library/bb259689.aspx">http://msdn.microsoft.com/en-us/library/bb259689.aspx</a>). <code class="docutils literal"><span class="pre">arcgis</span></code> uses a directory layout with hexadecimal row and column numbers that is compatible to ArcGIS exploded caches (<code class="docutils literal"><span class="pre">Lzz/Rxxxxxxxx/Cyyyyyyyy.format</span></code>).</p>
<div class="last admonition note">
<p class="first admonition-title">Note</p>
<p class="last"><code class="docutils literal"><span class="pre">tms</span></code>, <code class="docutils literal"><span class="pre">quadkey</span></code> and <code class="docutils literal"><span class="pre">arcgis</span></code> layout are not suited for large caches, since it will create directories with thousands of files, which most file systems do not handle well.</p>
</div>
</dd>
<dt><code class="docutils literal"><span class="pre">use_grid_names</span></code>:</dt>
<dd><p class="first">When <code class="docutils literal"><span class="pre">true</span></code> MapProxy will use the actual grid name in the path instead of the SRS code. E.g. tiles will be stored in <code class="docutils literal"><span class="pre">./cache_data/mylayer/mygrid/</span></code> instead of <code class="docutils literal"><span class="pre">./cache_data/mylayer/EPSG1234/</span></code>.</p>
<div class="last versionadded">
<p><span class="versionmodified">New in version 1.5.0.</span></p>
</div>
</dd>
</dl>
<dl class="docutils" id="cache-file-directory">
<dt><code class="docutils literal"><span class="pre">directory</span></code>:</dt>
<dd><p class="first">Directory where MapProxy should directly store the tiles. This will not add the cache name or grid name (<code class="docutils literal"><span class="pre">use_grid_name</span></code>) to the path. You can use this option to point MapProxy to an existing tile collection (created with <code class="docutils literal"><span class="pre">gdal2tiles</span></code> for example).</p>
<div class="last versionadded">
<p><span class="versionmodified">New in version 1.5.0.</span></p>
</div>
</dd>
<dt><code class="docutils literal"><span class="pre">tile_lock_dir</span></code>:</dt>
<dd><p class="first">Directory where MapProxy should write lock files when it creates new tiles for this cache. Defaults to <code class="docutils literal"><span class="pre">cache_data/tile_locks</span></code>.</p>
<div class="last versionadded">
<p><span class="versionmodified">New in version 1.6.0.</span></p>
</div>
</dd>
</dl>
</div>
<div class="section" id="mbtiles">
<h2><code class="docutils literal"><span class="pre">mbtiles</span></code><a class="headerlink" href="#mbtiles" title="Permalink to this headline">¶</a></h2>
<p>Use a single SQLite file for this cache. It uses the <a class="reference external" href="http://mbtiles.org/">MBTile specification</a>.</p>
<p>Available options:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">filename</span></code>:</dt>
<dd>The path to the MBTiles file. Defaults to <code class="docutils literal"><span class="pre">cachename.mbtiles</span></code>.</dd>
<dt><code class="docutils literal"><span class="pre">tile_lock_dir</span></code>:</dt>
<dd><p class="first">Directory where MapProxy should write lock files when it creates new tiles for this cache. Defaults to <code class="docutils literal"><span class="pre">cache_data/tile_locks</span></code>.</p>
<div class="last versionadded">
<p><span class="versionmodified">New in version 1.6.0.</span></p>
</div>
</dd>
</dl>
<p>You can set the <code class="docutils literal"><span class="pre">sources</span></code> to an empty list, if you use an existing MBTiles file and do not have a source.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">caches</span><span class="p">:</span>
<span class="n">mbtiles_cache</span><span class="p">:</span>
<span class="n">sources</span><span class="p">:</span> <span class="p">[]</span>
<span class="n">grids</span><span class="p">:</span> <span class="p">[</span><span class="n">GLOBAL_MERCATOR</span><span class="p">]</span>
<span class="n">cache</span><span class="p">:</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">mbtiles</span>
<span class="n">filename</span><span class="p">:</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">bluemarble</span><span class="o">.</span><span class="n">mbtiles</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The MBTiles format specification does not include any timestamps for each tile and the seeding function is limited therefore. If you include any <code class="docutils literal"><span class="pre">refresh_before</span></code> time in a seed task, all tiles will be recreated regardless of the value. The cleanup process does not support any <code class="docutils literal"><span class="pre">remove_before</span></code> times for MBTiles and it always removes all tiles.
Use the <code class="docutils literal"><span class="pre">--summary</span></code> option of the <code class="docutils literal"><span class="pre">mapproxy-seed</span></code> tool.</p>
</div>
</div>
<div class="section" id="sqlite">
<h2><code class="docutils literal"><span class="pre">sqlite</span></code><a class="headerlink" href="#sqlite" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.6.0.</span></p>
</div>
<p>Use SQLite databases to store the tiles, similar to <code class="docutils literal"><span class="pre">mbtiles</span></code> cache. The difference to <code class="docutils literal"><span class="pre">mbtiles</span></code> cache is that the <code class="docutils literal"><span class="pre">sqlite</span></code> cache stores each level into a separate databse. This makes it easy to remove complete levels during mapproxy-seed cleanup processes. The <code class="docutils literal"><span class="pre">sqlite</span></code> cache also stores the timestamp of each tile.</p>
<p>Available options:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">dirname</span></code>:</dt>
<dd>The direcotry where the level databases will be stored.</dd>
<dt><code class="docutils literal"><span class="pre">tile_lock_dir</span></code>:</dt>
<dd><p class="first">Directory where MapProxy should write lock files when it creates new tiles for this cache. Defaults to <code class="docutils literal"><span class="pre">cache_data/tile_locks</span></code>.</p>
<div class="last versionadded">
<p><span class="versionmodified">New in version 1.6.0.</span></p>
</div>
</dd>
</dl>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">caches</span><span class="p">:</span>
<span class="n">sqlite_cache</span><span class="p">:</span>
<span class="n">sources</span><span class="p">:</span> <span class="p">[</span><span class="n">mywms</span><span class="p">]</span>
<span class="n">grids</span><span class="p">:</span> <span class="p">[</span><span class="n">GLOBAL_MERCATOR</span><span class="p">]</span>
<span class="n">cache</span><span class="p">:</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">sqlite</span>
<span class="n">directory</span><span class="p">:</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">cache</span>
</pre></div>
</div>
</div>
<div class="section" id="couchdb">
<h2><code class="docutils literal"><span class="pre">couchdb</span></code><a class="headerlink" href="#couchdb" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.3.0.</span></p>
</div>
<p>Store tiles inside a <a class="reference external" href="http://couchdb.apache.org/">CouchDB</a>. MapProxy creates a JSON document for each tile. This document contains metadata, like timestamps, and the tile image itself as a attachment.</p>
<div class="section" id="requirements">
<h3>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h3>
<p>Besides a running CouchDB you will need the <a class="reference external" href="http://python-requests.org/">Python requests package</a>. You can install it the usual way, for example <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">requests</span></code>.</p>
</div>
<div class="section" id="id2">
<h3>Configuration<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
<p>You can configure the database and database name and the tile ID and additional metadata.</p>
<p>Available options:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">url</span></code>:</dt>
<dd>The URL of the CouchDB server. Defaults to <code class="docutils literal"><span class="pre">http://localhost:5984</span></code>.</dd>
<dt><code class="docutils literal"><span class="pre">db_name</span></code>:</dt>
<dd>The name of the database MapProxy uses for this cache. Defaults to the name of the cache.</dd>
<dt><code class="docutils literal"><span class="pre">tile_lock_dir</span></code>:</dt>
<dd><p class="first">Directory where MapProxy should write lock files when it creates new tiles for this cache. Defaults to <code class="docutils literal"><span class="pre">cache_data/tile_locks</span></code>.</p>
<div class="last versionadded">
<p><span class="versionmodified">New in version 1.6.0.</span></p>
</div>
</dd>
<dt><code class="docutils literal"><span class="pre">tile_id</span></code>:</dt>
<dd><p class="first">Each tile document needs a unique ID. You can change the format with a Python format string that expects the following keys:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">x</span></code>, <code class="docutils literal"><span class="pre">y</span></code>, <code class="docutils literal"><span class="pre">z</span></code>:</dt>
<dd>The tile coordinate.</dd>
<dt><code class="docutils literal"><span class="pre">grid_name</span></code>:</dt>
<dd>The name of the grid.</dd>
</dl>
<p>The default ID uses the following format:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="p">(</span><span class="n">grid_name</span><span class="p">)</span><span class="n">s</span><span class="o">-%</span><span class="p">(</span><span class="n">z</span><span class="p">)</span><span class="n">d</span><span class="o">-%</span><span class="p">(</span><span class="n">x</span><span class="p">)</span><span class="n">d</span><span class="o">-%</span><span class="p">(</span><span class="n">y</span><span class="p">)</span><span class="n">d</span>
</pre></div>
</div>
<div class="last admonition note">
<p class="first admonition-title">Note</p>
<p class="last">You can’t use slashes (<code class="docutils literal"><span class="pre">/</span></code>) in CouchDB IDs.</p>
</div>
</dd>
<dt><code class="docutils literal"><span class="pre">tile_metadata</span></code>:</dt>
<dd><p class="first">MapProxy stores a JSON document for each tile in CouchDB and you can add additional key-value pairs with metadata to each document.
There are a few predefined values that MapProxy will replace with tile-depended values, all other values will be added as they are.</p>
<p>Predefined values:</p>
<dl class="last docutils">
<dt><code class="docutils literal"><span class="pre">{{x}}</span></code>, <code class="docutils literal"><span class="pre">{{y}}</span></code>, <code class="docutils literal"><span class="pre">{{z}}</span></code>:</dt>
<dd>The tile coordinate.</dd>
<dt><code class="docutils literal"><span class="pre">{{timestamp}}</span></code>:</dt>
<dd>The creation time of the tile as seconds since epoch. MapProxy will add a <code class="docutils literal"><span class="pre">timestamp</span></code> key for you, if you don’t provide a custom timestamp key.</dd>
<dt><code class="docutils literal"><span class="pre">{{utc_iso}}</span></code>:</dt>
<dd>The creation time of the tile in UTC in ISO format. For example: <code class="docutils literal"><span class="pre">2011-12-31T23:59:59Z</span></code>.</dd>
<dt><code class="docutils literal"><span class="pre">{{tile_centroid}}</span></code>:</dt>
<dd>The center coordinate of the tile in the cache’s coordinate system as a list of long/lat or x/y values.</dd>
<dt><code class="docutils literal"><span class="pre">{{wgs_tile_centroid}}</span></code>:</dt>
<dd>The center coordinate of the tile in WGS 84 as a list of long/lat values.</dd>
</dl>
</dd>
</dl>
</div>
<div class="section" id="example">
<h3>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">caches</span><span class="p">:</span>
<span class="n">mycouchdbcache</span><span class="p">:</span>
<span class="n">sources</span><span class="p">:</span> <span class="p">[</span><span class="n">mywms</span><span class="p">]</span>
<span class="n">grids</span><span class="p">:</span> <span class="p">[</span><span class="n">mygrid</span><span class="p">]</span>
<span class="n">cache</span><span class="p">:</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">couchdb</span>
<span class="n">url</span><span class="p">:</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="p">:</span><span class="mi">9999</span>
<span class="n">db_name</span><span class="p">:</span> <span class="n">mywms_tiles</span>
<span class="n">tile_metadata</span><span class="p">:</span>
<span class="n">mydata</span><span class="p">:</span> <span class="n">myvalue</span>
<span class="n">tile_col</span><span class="p">:</span> <span class="s1">'{{x}}'</span>
<span class="n">tile_row</span><span class="p">:</span> <span class="s1">'{{y}}'</span>
<span class="n">tile_level</span><span class="p">:</span> <span class="s1">'{{z}}'</span>
<span class="n">created_ts</span><span class="p">:</span> <span class="s1">'{{timestamp}}'</span>
<span class="n">created</span><span class="p">:</span> <span class="s1">'{{utc_iso}}'</span>
<span class="n">center</span><span class="p">:</span> <span class="s1">'{{wgs_tile_centroid}}'</span>
</pre></div>
</div>
<p>MapProxy will place the JSON document for tile z=3, x=1, y=2 at <code class="docutils literal"><span class="pre">http://localhost:9999/mywms_tiles/mygrid-3-1-2</span></code>. The document will look like:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s2">"_attachments"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"tile"</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">"content_type"</span><span class="p">:</span> <span class="s2">"image/png"</span><span class="p">,</span>
<span class="s2">"digest"</span><span class="p">:</span> <span class="s2">"md5-ch4j5Piov6a5FlAZtwPVhQ=="</span><span class="p">,</span>
<span class="s2">"length"</span><span class="p">:</span> <span class="mi">921</span><span class="p">,</span>
<span class="s2">"revpos"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s2">"stub"</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"_id"</span><span class="p">:</span> <span class="s2">"mygrid-3-1-2"</span><span class="p">,</span>
<span class="s2">"_rev"</span><span class="p">:</span> <span class="s2">"2-9932acafd060e10bc0db23231574f933"</span><span class="p">,</span>
<span class="s2">"center"</span><span class="p">:</span> <span class="p">[</span>
<span class="o">-</span><span class="mf">112.5</span><span class="p">,</span>
<span class="o">-</span><span class="mf">55.7765730186677</span>
<span class="p">],</span>
<span class="s2">"created"</span><span class="p">:</span> <span class="s2">"2011-12-15T12:56:21Z"</span><span class="p">,</span>
<span class="s2">"created_ts"</span><span class="p">:</span> <span class="mf">1323953781.531889</span><span class="p">,</span>
<span class="s2">"mydata"</span><span class="p">:</span> <span class="s2">"myvalue"</span><span class="p">,</span>
<span class="s2">"tile_col"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">"tile_level"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
<span class="s2">"tile_row"</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">_attachments</span></code>-part is the internal structure of CouchDB where the tile itself is stored. You can access the tile directly at: <code class="docutils literal"><span class="pre">http://localhost:9999/mywms_tiles/mygrid-3-1-2/tile</span></code>.</p>
</div>
</div>
<div class="section" id="riak">
<h2><code class="docutils literal"><span class="pre">riak</span></code><a class="headerlink" href="#riak" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
<p><span class="versionmodified">New in version 1.6.0.</span></p>
</div>
<p>Store tiles in a <a class="reference external" href="http://basho.com/riak/">Riak</a> cluster. MapProxy creates keys with binary data as value and timestamps as user defined metadata.
This backend is good for very large caches which can be distributed over many nodes. Data can be distributed over multiple nodes providing a fault-tolernt and high-available storage. A Riak cluster is masterless and each node can handle read and write requests.</p>
<div class="section" id="id4">
<h3>Requirements<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
<p>You will need the <a class="reference external" href="https://pypi.python.org/pypi/riak">Python Riak client</a> version 2.0 or newer. You can install it in the usual way, for example with <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">riak</span></code>. Environments with older version must be upgraded with <code class="docutils literal"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-U</span> <span class="pre">riak</span></code>.</p>
</div>
<div class="section" id="id5">
<h3>Configuration<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
<p>Available options:</p>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">nodes</span></code>:</dt>
<dd>A list of riak nodes. Each node needs a <code class="docutils literal"><span class="pre">host</span></code> and optionally a <code class="docutils literal"><span class="pre">pb_port</span></code> and an <code class="docutils literal"><span class="pre">http_port</span></code> if the ports differ from the default. A single localhost node is used if you don’t configure any nodes.</dd>
<dt><code class="docutils literal"><span class="pre">protocol</span></code>:</dt>
<dd>Communication protocol. Allowed options is <code class="docutils literal"><span class="pre">http</span></code>, <code class="docutils literal"><span class="pre">https</span></code> and <code class="docutils literal"><span class="pre">pbc</span></code>. Defaults to <code class="docutils literal"><span class="pre">pbc</span></code>.</dd>
<dt><code class="docutils literal"><span class="pre">bucket</span></code>:</dt>
<dd>The name of the bucket MapProxy uses for this cache. The bucket is the namespace for the tiles and needs to be unique for each cache. Defaults to cache name suffixed with grid name (e.g. <code class="docutils literal"><span class="pre">mycache_webmercator</span></code>).</dd>
<dt><code class="docutils literal"><span class="pre">default_ports</span></code>:</dt>
<dd>Default <code class="docutils literal"><span class="pre">pb</span></code> and <code class="docutils literal"><span class="pre">http</span></code> ports for <code class="docutils literal"><span class="pre">pbc</span></code> and <code class="docutils literal"><span class="pre">http</span></code> protocols. Will be used as the default for each defined node.</dd>
<dt><code class="docutils literal"><span class="pre">secondary_index</span></code>:</dt>
<dd>If <code class="docutils literal"><span class="pre">true</span></code> enables secondary index for tiles. This improves seed cleanup performance but requires that Riak uses LevelDB as the backend. Refer to the Riak documentation. Defaults to <code class="docutils literal"><span class="pre">false</span></code>.</dd>
</dl>
</div>
<div class="section" id="id6">
<h3>Example<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">myriakcache</span><span class="p">:</span>
<span class="n">sources</span><span class="p">:</span> <span class="p">[</span><span class="n">mywms</span><span class="p">]</span>
<span class="n">grids</span><span class="p">:</span> <span class="p">[</span><span class="n">mygrid</span><span class="p">]</span>
<span class="nb">type</span><span class="p">:</span> <span class="n">riak</span>
<span class="n">nodes</span><span class="p">:</span>
<span class="o">-</span> <span class="n">host</span><span class="p">:</span> <span class="mf">1.</span><span class="n">example</span><span class="o">.</span><span class="n">org</span>
<span class="n">pb_port</span><span class="p">:</span> <span class="mi">9999</span>
<span class="o">-</span> <span class="n">host</span><span class="p">:</span> <span class="mf">1.</span><span class="n">example</span><span class="o">.</span><span class="n">org</span>
<span class="o">-</span> <span class="n">host</span><span class="p">:</span> <span class="mf">1.</span><span class="n">example</span><span class="o">.</span><span class="n">org</span>
<span class="n">protocol</span><span class="p">:</span> <span class="n">pbc</span>
<span class="n">bucket</span><span class="p">:</span> <span class="n">myriakcachetiles</span>
<span class="n">default_ports</span><span class="p">:</span>
<span class="n">pb</span><span class="p">:</span> <span class="mi">8087</span>
<span class="n">http</span><span class="p">:</span> <span class="mi">8098</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<p class="pull-right">
<a href="#">Back to top</a>
</p>
<p>
© Copyright Oliver Tonnhofer, Omniscale, <a href="http://mapproxy.org/about">Legal</a>
<br/>
Last updated on 2018-01-07
<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.9.
</p>
</div>
</footer>
</body>
</html>
|