-
Notifications
You must be signed in to change notification settings - Fork 35
/
README.md.html
263 lines (196 loc) · 9.08 KB
/
README.md.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>lua-cassandra documentation</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>lua-cassandra</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Installation">Installation </a></li>
<li><a href="#Usage">Usage </a></li>
<li><a href="#Examples">Examples </a></li>
<li><a href="#Credits">Credits </a></li>
<li><a href="#License">License </a></li>
</ul>
<h2>Manual</h2>
<ul class="nowrap">
<li><strong>README</strong></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/cassandra.html">cassandra</a></li>
<li><a href="../modules/resty.cassandra.cluster.html">resty.cassandra.cluster</a></li>
<li><a href="../modules/resty.cassandra.policies.lb.dc_rr.html">resty.cassandra.policies.lb.dc_rr</a></li>
<li><a href="../modules/resty.cassandra.policies.lb.req_dc_rr.html">resty.cassandra.policies.lb.req_dc_rr</a></li>
<li><a href="../modules/resty.cassandra.policies.lb.req_rr.html">resty.cassandra.policies.lb.req_rr</a></li>
<li><a href="../modules/resty.cassandra.policies.lb.rr.html">resty.cassandra.policies.lb.rr</a></li>
<li><a href="../modules/resty.cassandra.policies.reconnection.const.html">resty.cassandra.policies.reconnection.const</a></li>
<li><a href="../modules/resty.cassandra.policies.reconnection.exp.html">resty.cassandra.policies.reconnection.exp</a></li>
<li><a href="../modules/resty.cassandra.policies.retry.simple.html">resty.cassandra.policies.retry.simple</a></li>
</ul>
<h2>Examples</h2>
<ul class="nowrap">
<li><a href="../examples/authentication.lua.html">authentication.lua</a></li>
<li><a href="../examples/batch.lua.html">batch.lua</a></li>
<li><a href="../examples/intro.lua.html">intro.lua</a></li>
<li><a href="../examples/pagination.lua.html">pagination.lua</a></li>
<li><a href="../examples/ssl.lua.html">ssl.lua</a></li>
</ul>
</div>
<div id="content">
<h1>lua-cassandra</h1>
<p>A pure Lua client library for Apache Cassandra (2.x/3.x), compatible with
<a href="https://openresty.org">OpenResty</a>.</p>
<p>This library offers 2 modules: a "single host" module (<a href="../modules/cassandra.html#">cassandra</a>), compatible
with PUC Lua 5.1/5.2, LuaJIT and OpenResty, which allows your application to
connect itself to a given Cassandra node, and a "cluster" module
(<a href="../modules/resty.cassandra.cluster.html#">resty.cassandra.cluster</a>), only compatible with OpenResty which adds support
for multi-node Cassandra datacenters.</p>
<p>The following table describes which version(s) of the binary protocol is
supported by each Cassandra version:</p>
<p><br /></p>
<table class="module_list">
<tr><td>Cassandra Version</td><td>Binary Protocol support</td></tr>
<tr><td>1.2</td><td>1</td></tr>
<tr><td>2.0</td><td>1, 2</td></tr>
<tr><td>2.1</td><td>1, 2, 3</td></tr>
<tr><td>2.2</td><td>1, 2, 3, 4</td></tr>
<tr><td>3.0</td><td>3, 4</td></tr>
</table>
<p><br /></p>
<p>This library supports binary protocols 2 and 3, hence supports Cassandra 2.x
and 3.x only.</p>
<p><a name="Installation"></a></p>
<h2>Installation</h2>
<p>With <a href="https://luarocks.org">Luarocks</a>:</p>
<pre>
$ luarocks install lua-cassandra
</pre>
<p>Manually:</p>
<p>Once you have a local copy of this module's <code>lib/</code> directory, add it to your
<code>LUA_PATH</code> (or <code>lua_package_path</code> directive for OpenResty):</p>
<pre><code> /path/to/lib/?.lua;/path/to/lib/?/init.lua;
</code></pre>
<p><strong>Note</strong>: When used <em>outside</em> of OpenResty, or in the <code>init_by_lua</code> context,
this module requires additional dependencies:</p>
<ul>
<li><a href="http://w3.impa.br/~diego/software/luasocket/">LuaSocket</a></li>
<li>If you wish to use SSL client-to-node connections,
<a href="https://github.com/brunoos/luasec">LuaSec</a></li>
</ul>
<p><a name="Usage"></a></p>
<h2>Usage</h2>
<p>Single host module (Lua and OpenResty):</p>
<pre>
<span class="keyword">local</span> cassandra = <span class="global">require</span> <span class="string">"cassandra"</span>
<span class="keyword">local</span> peer = <span class="global">assert</span>(cassandra.new {
host = <span class="string">"127.0.0.1"</span>,
port = <span class="number">9042</span>,
keyspace = <span class="string">"my_keyspace"</span>
})
peer:settimeout(<span class="number">1000</span>)
<span class="global">assert</span>(peer:connect())
<span class="global">assert</span>(peer:execute(<span class="string">"INSERT INTO users(id, name, age) VALUES(?, ?, ?)"</span>, {
cassandra.uuid(<span class="string">"1144bada-852c-11e3-89fb-e0b9a54a6d11"</span>),
<span class="string">"John O Reilly"</span>,
<span class="number">42</span>
}))
<span class="keyword">local</span> rows = <span class="global">assert</span>(peer:execute <span class="string">"SELECT * FROM users"</span>)
<span class="keyword">local</span> user = rows[<span class="number">1</span>]
<span class="global">print</span>(user.name) <span class="comment">-- John O Reilly
</span><span class="global">print</span>(user.age) <span class="comment">-- 42
</span>
peer:close()
</pre>
<p>Cluster module (OpenResty only):</p>
<pre><code> http {
# you do not need the following line if you are using luarocks
lua_package_path "/path/to/src/?.lua;/path/to/src/?/init.lua;;";
# all cluster informations will be stored here
lua_shared_dict cassandra 1m;
server {
...
location / {
content_by_lua_block {
local Cluster = require 'resty.cassandra.cluster'
-- can live in an upvalue at the main chunk level of your
-- modules, to avoid creating it on every request.
-- see the intro example in the documentation.
local cluster, err = Cluster.new {
shm = 'cassandra', -- defined by the lua_shared_dict directive
contact_points = {'127.0.0.1', '127.0.0.2'},
keyspace = 'my_keyspace'
}
if not cluster then
ngx.log(ngx.ERR, 'could not create cluster: ', err)
return ngx.exit(500)
end
local rows, err = cluster:execute "SELECT * FROM users"
if not rows then
ngx.log(ngx.ERR, 'could not retrieve users: ', err)
return ngx.exit(500)
end
ngx.say('users: ', #rows)
}
}
}
}
</code></pre>
<p>See the <a href="../modules/cassandra.html#">cassandra</a> and <a href="../modules/resty.cassandra.cluster.html#">resty.cassandra.cluster</a> modules references for a
detailed list of available methods and options.</p>
<p><a name="Examples"></a></p>
<h2>Examples</h2>
<p>Also check out the examples section for concrete examples of basic and advanced
usage.</p>
<p><a name="Credits"></a></p>
<h2>Credits</h2>
<p>This project was originally a fork of
<a href="https://github.com/jbochi/lua-resty-cassandra">jbochi/lua-resty-cassandra</a> with bugfixes and new
features. It was completely rewritten in its <code>0.4.0</code> version to allow serious
improvements in terms of features and maintainability.</p>
<p><a name="License"></a></p>
<h2>License</h2>
<p>The MIT License (MIT)</p>
<p>Original work Copyright (c) 2016 Thibault Charbonnier
Based on the work of Juarez Bochi Copyright 2014</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.</p>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2021-02-18 11:29:23 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>