/usr/share/doc/python-couchdb/getting-started.html is in python-couchdb 0.8-0ubuntu2.
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 | <!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>1. Getting started with couchdb-python — couchdb-python v0.8 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.8',
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="couchdb-python v0.8 documentation" href="index.html" />
<link rel="next" title="2. Writing views in Python" href="views.html" />
<link rel="prev" title="Introduction" href="index.html" />
</head>
<body>
<div class="related">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="views.html" title="2. Writing views in Python"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Introduction"
accesskey="P">previous</a> |</li>
<li><a href="index.html">couchdb-python v0.8 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="getting-started-with-couchdb-python">
<h1>1. Getting started with couchdb-python<a class="headerlink" href="#getting-started-with-couchdb-python" title="Permalink to this headline">ΒΆ</a></h1>
<p>Some snippets of code to get you started with writing code against CouchDB.</p>
<p>Starting off:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">couchdb</span>
<span class="gp">>>> </span><span class="n">couch</span> <span class="o">=</span> <span class="n">couchdb</span><span class="o">.</span><span class="n">Server</span><span class="p">()</span>
</pre></div>
</div>
<p>This gets you a Server object, representing a CouchDB server. By default, it
assumes CouchDB is running on localhost:5894. If your CouchDB server is
running elsewhere, set it up like this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">couch</span> <span class="o">=</span> <span class="n">couchdb</span><span class="o">.</span><span class="n">Server</span><span class="p">(</span><span class="s">'http://example.com:5984/'</span><span class="p">)</span>
</pre></div>
</div>
<p>You can create a new database from Python, or use an existing database:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span> <span class="o">=</span> <span class="n">couch</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="s">'test'</span><span class="p">)</span> <span class="c"># newly created</span>
<span class="gp">>>> </span><span class="n">db</span> <span class="o">=</span> <span class="n">couch</span><span class="p">[</span><span class="s">'mydb'</span><span class="p">]</span> <span class="c"># existing</span>
</pre></div>
</div>
<p>After selecting a database, create a document and insert it into the db:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">doc</span> <span class="o">=</span> <span class="p">{</span><span class="s">'foo'</span><span class="p">:</span> <span class="s">'bar'</span><span class="p">}</span>
<span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">doc</span><span class="p">)</span>
<span class="go">('e0658cab843b59e63c8779a9a5000b01', '1-4c6114c65e295552ab1019e2b046b10e')</span>
<span class="gp">>>> </span><span class="n">doc</span>
<span class="go">{'_rev': '1-4c6114c65e295552ab1019e2b046b10e', 'foo': 'bar', '_id': 'e0658cab843b59e63c8779a9a5000b01'}</span>
</pre></div>
</div>
<p>The <tt class="docutils literal"><span class="pre">save()</span></tt> method returns the ID and “rev” for the newly created document.
You can also set your own ID by including an <tt class="docutils literal"><span class="pre">_id</span></tt> item in the document.</p>
<p>Getting the document out again is easy:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span><span class="p">[</span><span class="s">'e0658cab843b59e63c8779a9a5000b01'</span><span class="p">]</span>
<span class="go"><Document 'e0658cab843b59e63c8779a9a5000b01'@'1-4c6114c65e295552ab1019e2b046b10e' {'foo': 'bar'}></span>
</pre></div>
</div>
<p>To find all your documents, simply iterate over the database:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">for</span> <span class="nb">id</span> <span class="ow">in</span> <span class="n">db</span><span class="p">:</span>
<span class="gp">... </span> <span class="k">print</span> <span class="nb">id</span>
<span class="gp">...</span>
<span class="go">'e0658cab843b59e63c8779a9a5000b01'</span>
</pre></div>
</div>
<p>Now we can clean up the test document and database we created:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">db</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">doc</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">couch</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="s">'test'</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Introduction</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="views.html"
title="next chapter">2. Writing views in Python</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/getting-started.txt"
rel="nofollow">Show Source</a></li>
</ul>
<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>
<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">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="views.html" title="2. Writing views in Python"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Introduction"
>previous</a> |</li>
<li><a href="index.html">couchdb-python v0.8 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, Dirkjan Ochtman.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.
</div>
</body>
</html>
|