couchdb-common 1.5.0-0ubuntu1 / usr / share / couchdb / www / docs / experimental.html

This file is indexed.

/usr/share/couchdb/www/docs/experimental.html is in couchdb-common 1.5.0-0ubuntu1.

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
<!--

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

   http://www.apache.org/licenses/LICENSE-2.0

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.

-->

<!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>12. Experimental Features &mdash; Apache CouchDB 1.5 Documentation</title>
    
    <link rel="stylesheet" href="_static/rtd.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.5.0',
        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="shortcut icon" href="_static/favicon.ico"/>
    <link rel="author" title="About these documents" href="about.html" />
    <link rel="top" title="Apache CouchDB 1.5 Documentation" href="index.html" />
    <link rel="next" title="13. Contributing to this Documentation" href="contributing.html" />
    <link rel="prev" title="11. JSON Structure Reference" href="json-structure.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="http-api.html" title="HTTP API Reference"
             >API Reference</a></li>
        <li class="right" >
          <a href="config-ref.html" title="Configuration Reference"
             >Config Reference</a> |</li>
        <li class="right" >
          <a href="contributing.html" title="13. Contributing to this Documentation"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="json-structure.html" title="11. JSON Structure Reference"
             accesskey="P">previous</a> |</li>
  <li><a href="index.html">Apache CouchDB 1.5 Documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="experimental-features">
<span id="experimental"></span><h1>12. Experimental Features<a class="headerlink" href="#experimental-features" title="Permalink to this headline"></a></h1>
<p>This is a list of experimental features in CouchDB. They are included in
a release because the development team is requesting feedback from the
larger developer community. As such, please play around with these features
and send us feedback, thanks!</p>
<p>Use at your own risk! Do not rely on these features for critical
applications.</p>
<div class="section" id="nodejs-query-server">
<h2>12.1. NodeJS Query Server<a class="headerlink" href="#nodejs-query-server" title="Permalink to this headline"></a></h2>
<p>The NodeJS Query Server is an alternative runtime environment for
the default JavaScript Query Server that runs on top of Node.JS and
not SpiderMonkey like the default Query Server.</p>
<div class="section" id="setup">
<h3>12.1.1. Setup<a class="headerlink" href="#setup" title="Permalink to this headline"></a></h3>
<p>You will need to install Node.JS version 0.10.0 or later. See <a class="reference external" href="http://nodejs.org/download/">Node.JS
Downloads</a> for options.</p>
<ol class="arabic">
<li><p class="first">Install the <cite>couchjs-node</cite> binary. Either from the CouchDB sources:</p>
<div class="highlight-json"><pre>cd src/couchjs-node
npm link</pre>
</div>
</li>
</ol>
<p>Or via NPM:</p>
<div class="highlight-json"><pre>npm install -g couchjs</pre>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p><strong>NPM in non-standard locations</strong></p>
<p>If your Node.JS installation doesn’t store binaries in <cite>/usr/local/bin</cite>
you will need to adjust CouchDB’s configuration. Add this to your <cite>local.ini</cite>
file:</p>
<div class="highlight-ini"><div class="highlight"><pre><span class="k">[query_servers]</span>
<span class="na">nodejs</span> <span class="o">=</span> <span class="s">/path/to/couchjs-node /path/to/couchdb/share/server/main.js</span>
</pre></div>
</div>
<p class="last">And then restart your CouchDB instance.</p>
</div>
<p>2. Done. Now you can create design documents with the <cite>language</cite> parameter
set to <cite>nodejs</cite> and all JavaScript functions in this design document will
be processed by the Node.JS query server.</p>
<p>Enjoy!</p>
</div>
<div class="section" id="differences-from-the-spidermonkey-query-server">
<h3>12.1.2. Differences from the SpiderMonkey Query Server<a class="headerlink" href="#differences-from-the-spidermonkey-query-server" title="Permalink to this headline"></a></h3>
<p>V8 and SpiderMonkey roughly behave similar, but there might be engine-
specific differences that make or break a JavaScript function in one or
the other server.</p>
</div>
</div>
<div class="section" id="plugins">
<h2>12.2. Plugins<a class="headerlink" href="#plugins" title="Permalink to this headline"></a></h2>
<p>See <cite>src/couch_plugins/README.md</cite>.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
    <p class="logo"><a href="index.html">
      <img class="logo" src="_static/logo.png" alt="Logo"/>
    </a></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

   http://www.apache.org/licenses/LICENSE-2.0

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.

-->

<div id="searchbox" style="display: none">

<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>

<br>

</div>

<script type="text/javascript">$('#searchbox').show(0);</script>
  <h3><a href="contents.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">12. Experimental Features</a><ul>
<li><a class="reference internal" href="#nodejs-query-server">12.1. NodeJS Query Server</a><ul>
<li><a class="reference internal" href="#setup">12.1.1. Setup</a></li>
<li><a class="reference internal" href="#differences-from-the-spidermonkey-query-server">12.1.2. Differences from the SpiderMonkey Query Server</a></li>
</ul>
</li>
<li><a class="reference internal" href="#plugins">12.2. Plugins</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="json-structure.html"
                        title="previous chapter">11. JSON Structure Reference</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="contributing.html"
                        title="next chapter">13. Contributing to this Documentation</a></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

   http://www.apache.org/licenses/LICENSE-2.0

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.

-->


<h3>Utilities</h3>

<ul>
<li><a href="../">Futon</a></li>
</ul>
<!--

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

   http://www.apache.org/licenses/LICENSE-2.0

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.

-->

<h3>More Help</h3>

<ul>
<li><a href="https://couchdb.apache.org/">Homepage</a></li>
<li><a href="http://wiki.apache.org/couchdb/">Wiki</a></li>
<li><a href="https://couchdb.apache.org/#mailing-list">Mailing Lists</a></li>
<li><a href="http://webchat.freenode.net/?channels=couchdb">IRC</a></li>
<li><a href="https://issues.apache.org/jira/browse/CouchDB">Issues</a></li>
<li><a href="download.html">Download</a></li>
<li><a href="https://github.com/apache/couchdb/blob/master/share/doc/src/experimental.rst"
       rel="nofollow">Show on GitHub</a></li>
<li><a href="https://github.com/apache/couchdb/edit/master/share/doc/src/experimental.rst"
       rel="nofollow">Edit on GitHub</a></li>
</ul>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="http-api.html" title="HTTP API Reference"
             >API Reference</a></li>
        <li class="right" >
          <a href="config-ref.html" title="Configuration Reference"
             >Config Reference</a> |</li>
        <li class="right" >
          <a href="contributing.html" title="13. Contributing to this Documentation"
             >next</a> |</li>
        <li class="right" >
          <a href="json-structure.html" title="11. JSON Structure Reference"
             >previous</a> |</li>
  <li><a href="index.html">Apache CouchDB 1.5 Documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2014, The Apache Software Foundation.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.