forked from objectrocket/python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTutorial.html
More file actions
235 lines (138 loc) · 9.66 KB
/
Copy pathTutorial.html
File metadata and controls
235 lines (138 loc) · 9.66 KB
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
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Tutorial — ObjectRocket Python Client 0.1.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="ObjectRocket Python Client 0.1.0 documentation" href="index.html"/>
<link rel="next" title="API Documentation" href="API.html"/>
<link rel="prev" title="Installation" href="Installation.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> ObjectRocket Python Client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="API.html">API Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="objectrocket.auth.html">objectrocket.auth</a></li>
<li class="toctree-l2"><a class="reference internal" href="objectrocket.bases.html">objectrocket.bases</a></li>
<li class="toctree-l2"><a class="reference internal" href="objectrocket.client.html">objectrocket.client</a></li>
<li class="toctree-l2"><a class="reference internal" href="objectrocket.constants.html">objectrocket.constants</a></li>
<li class="toctree-l2"><a class="reference internal" href="objectrocket.errors.html">objectrocket.errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="objectrocket.instances.html">objectrocket.instances</a><ul>
<li class="toctree-l3"><a class="reference internal" href="objectrocket.instances.mongodb.html">objectrocket.instances.mongodb</a></li>
<li class="toctree-l3"><a class="reference internal" href="objectrocket.instances.redis.html">objectrocket.instances.redis</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="objectrocket.util.html">objectrocket.util</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">changelog</a><ul class="simple">
</ul>
</li>
</ul>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">ObjectRocket Python Client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Tutorial</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/Tutorial.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document">
<div class="section" id="tutorial">
<h1>Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this headline">¶</a></h1>
<p>And now for a super awesome tutorial. Provided that you’ve already performed an <a class="reference internal" href="Installation.html#installation-label"><span>Installation</span></a>, here is an example of how you might want to use the client:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">objectrocket</span>
<span class="gp">>>> </span><span class="n">client</span> <span class="o">=</span> <span class="n">objectrocket</span><span class="o">.</span><span class="n">Client</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">authenticate</span><span class="p">(</span><span class="s">'<username>'</span><span class="p">,</span> <span class="s">'<password>'</span><span class="p">)</span>
<span class="go"># To create a new instance:</span>
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">instances</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">'mongodb_sharded_0'</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">zone</span><span class="o">=</span><span class="s">'US-East-IAD3'</span><span class="p">,</span> <span class="n">service_type</span><span class="o">=</span><span class="s">'mongodb'</span><span class="p">,</span> <span class="n">instance_type</span><span class="o">=</span><span class="s">'mongodb_sharded'</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s">'3.0.5'</span><span class="p">)</span>
<span class="go"><objectrocket.instances.MongodbInstance {...} at 0x10afeacd0></span>
<span class="go"># To get all of your instances in a list:</span>
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">instances</span><span class="o">.</span><span class="n">all</span><span class="p">()</span>
<span class="go">[<objectrocket.instances.MongodbInstance {...} at 0x1091f9990>]</span>
<span class="go"># To get one of your instances by name:</span>
<span class="gp">>>> </span><span class="n">inst</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">instances</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'mongodb_sharded_0'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">inst</span>
<span class="go"><objectrocket.instances.MongodbInstance {...} at 0x1097a8390></span>
<span class="go"># To add a shard to your instance:</span>
<span class="gp">>>> </span><span class="n">inst</span><span class="o">.</span><span class="n">shards</span><span class="p">(</span><span class="n">add_shard</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="go">{'data': [{'name': '7a0d6366f80f4a42995fabe01cbaea74', 'plan': 5, ...}, {...}]}</span>
<span class="go"># To request compaction for your instance:</span>
<span class="gp">>>> </span><span class="n">inst</span><span class="o">.</span><span class="n">compaction</span><span class="p">(</span><span class="n">request_compaction</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
<span class="go">{'data': {'state': 'requested', 'updated': '2015-01-01 00:00:00.000000'}}</span>
<span class="go"># To check the compaction state of your instance:</span>
<span class="gp">>>> </span><span class="n">inst</span><span class="o">.</span><span class="n">compaction</span><span class="p">()</span>
<span class="go">{'data': {'state': 'requested', 'updated': '2015-01-01 00:00:00.000000'}}</span>
</pre></div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="API.html" class="btn btn-neutral float-right" title="API Documentation" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="Installation.html" class="btn btn-neutral" title="Installation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014, ObjectRocket Engineering.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0.1.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>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>