-
Notifications
You must be signed in to change notification settings - Fork 110
/
client.py
498 lines (407 loc) · 16.8 KB
/
client.py
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
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
#
# Copyright 2012, Couchbase, Inc.
# All Rights Reserved
#
# 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.
#
import uuid
import json
import time
from copy import deepcopy
from threading import Thread, Lock
import warnings
from collections import Set
import requests
from couchbase.logger import logger
from couchbase.rest_client import RestConnection
from couchbase.couchbaseclient import CouchbaseClient
from couchbase.exception import BucketUnavailableException
log = logger("client")
class Couchbase(object):
"""This is the primary class through which the Python "smart client"
communicates with the cluster. It combines and simplifies access to both
the memcached and HTTP protocols used in Couchbase Server."""
def __init__(self, host, username, password):
if (':' in host):
[ip, port] = host.split(':')
else:
[ip, port] = host, 8091
server = {'ip': ip,
'port': port,
'username': username,
'password': password
}
self.servers = [server]
self.servers_lock = Lock()
self.rest_username = username
self.rest_password = password
server_config_uri = "http://%s:%s/pools/default" % (ip, port)
config = requests.get(server_config_uri).json
#couchApiBase will not be in node config before Couchbase Server 2.0
self.couch_api_base = config["nodes"][0].get("couchApiBase")
self.streaming_thread = Thread(name="streaming",
target=self._start_streaming, args=())
self.streaming_thread.daemon = True
self.streaming_thread.start()
def _start_streaming(self):
# this will dynamically update servers
url = "http://%s:%s/poolsStreaming/default" % (self.servers[0]["ip"],
self.servers[0]["port"])
response = requests.get(url)
for line in response.iter_lines():
if line:
data = json.loads(line)
new_servers = []
nodes = data["nodes"]
for node in nodes:
if (node["clusterMembership"] == "active" and
node["status"] in ["healthy", "warmup"]):
ip, port = node["hostname"].split(":")
couch_api_base = node.get("couchApiBase")
new_servers.append({"ip": ip,
"port": port,
"username": self.rest_username,
"password": self.rest_password,
"couchApiBase": couch_api_base
})
new_servers.sort()
self.servers_lock.acquire()
self.servers = deepcopy(new_servers)
self.servers_lock.release()
def bucket(self, bucket_name):
return Bucket(bucket_name, self)
def buckets(self):
"""Get a list of all buckets as Buckets"""
rest = self._rest()
buckets = []
for rest_bucket in rest.get_buckets():
buckets.append(Bucket(rest_bucket.name, self))
return buckets
def create(self, bucket_name, bucket_password='', ram_quota_mb=100,
replica=0):
rest = self._rest()
rest.create_bucket(bucket=bucket_name,
ramQuotaMB=ram_quota_mb,
authType='sasl',
saslPassword=bucket_password,
replicaNumber=replica,
bucketType='membase')
ip, port, _, _ = self._rest_info()
while True:
try:
content = '{"basicStats":{"quotaPercentUsed":0.0}}'
api = "/pools/default/buckets/{0}".format(bucket_name)
status, content = rest._http_request(api,
method='GET', params='',
headers=None, timeout=120)
content = json.loads(content)
except ValueError:
pass
if content['basicStats']['quotaPercentUsed'] > 0.0:
time.sleep(2)
break
time.sleep(1)
return Bucket(bucket_name, self)
def delete(self, bucket_name):
rest = self._rest()
rest.delete_bucket(bucket_name)
def __getitem__(self, key):
return self.bucket(key)
def __iter__(self):
return BucketIterator(self.buckets())
def _rest(self):
self.servers_lock.acquire()
server_info = deepcopy(self.servers[0])
self.servers_lock.release()
server_info['username'] = self.rest_username
server_info['password'] = self.rest_password
server_info['couchApiBase'] = self.couch_api_base
rest = RestConnection(server_info)
return rest
def _rest_info(self):
self.servers_lock.acquire()
server_info = deepcopy(self.servers[0])
self.servers_lock.release()
return (server_info['ip'], server_info['port'],
server_info['username'], server_info['password'])
class Server(Couchbase):
"""This is the earlier name of the Couchbase() class. It is now deprecated.
"""
def __init__(self, host, username, password):
warnings.warn("Server is deprecated; use Couchbase instead",
DeprecationWarning)
Couchbase.__init__(self, host, username, password)
class BucketIterator(object):
"""Pythonic Iterator for Bucket objects."""
def __init__(self, buckets):
self.buckets = buckets
def __iter__(self):
return self
def next(self):
try:
return self.buckets.pop(0)
except IndexError:
raise StopIteration
class Bucket(object):
"""Handles Bucket management as well as key/value access for a specific
bucket."""
def __init__(self, name, server):
self.server = server
self.name = name
rest = server._rest()
self.info = rest.get_bucket(self.name)
self.password = self.info.saslPassword
ip, port, rest_username, rest_password = server._rest_info()
formatter_uri = "http://%s:%s/pools/default"
self.mc_client = CouchbaseClient(formatter_uri % (ip, port), self.name,
self.password)
def __del__(self):
self.mc_client.done()
def append(self, key, value, cas=0):
return self.mc_client.append(key, value, cas)
def prepend(self, key, value, cas=0):
return self.mc_client.prepend(key, value, cas)
def incr(self, key, amt=1, init=0, exp=0):
return self.mc_client.incr(key, amt, init, exp)
def decr(self, key, amt=1, init=0, exp=0):
return self.mc_client.decr(key, amt, init, exp)
def set(self, key, expiration, flags, value):
if isinstance(value, dict):
value = json.dumps(value)
return self.mc_client.set(key, expiration, flags, value)
def add(self, key, exp, flags, val):
return self.mc_client.add(key, exp, flags, val)
def replace(self, key, exp, flags, val):
return self.mc_client.replace(key, exp, flags, val)
def get(self, key):
return self.mc_client.get(key)
def getl(self, key, exp=15):
return self.mc_client.getl(key, exp)
def cas(self, key, exp, flags, oldVal, val):
return self.mc_client.cas(key, exp, flags, oldVal, val)
def touch(self, key, exp):
return self.mc_client.touch(key, exp)
def gat(self, key, exp):
return self.mc_client.gat(key, exp)
def stats(self, sub=''):
return self.mc_client.stats(sub)
def delete(self, key, cas=0):
if key.startswith('_design/'):
# this is a design doc, we need to handle it differently
view = key.split('/')[1]
rest = self.server._rest()
rest.delete_view(self.name, view)
else:
return self.mc_client.delete(key, cas)
def save(self, document):
warnings.warn("save is deprecated; use set instead",
DeprecationWarning)
value = deepcopy(document)
if '_id' in value:
key = value['_id']
del value['_id']
else:
key = str(uuid.uuid4())
if '$flags' in value:
flags = value['$flags']
del value['$flags']
else:
flags = 0
if '$expiration' in value:
expiration = value['$expiration']
del value['$expiration']
else:
expiration = 0
if key.startswith('_design/'):
self[key] = value
else:
if '_rev' in value:
# couchbase works in clobber mode so for "set" _rev is useless
del value['_rev']
self.set(key, expiration, flags, json.dumps(value))
return key
def __setitem__(self, key, value):
if isinstance(value, dict):
if 'expiration' in value or 'flags' in value:
assert 'value' in value
if isinstance(value['value'], dict):
v = json.dumps(value['value'])
else:
v = value['value']
self.set(key, value.get('expiration', 0),
value.get('flags', 0), v)
elif key.startswith('_design/'):
rest = self.server._rest()
rest.create_design_doc(self.name, key[8:], json.dumps(value))
else:
self.set(key, 0, 0, json.dumps(value))
else:
self.set(key, 0, 0, value)
def __getitem__(self, key):
if key.startswith("_design/"):
rest = self.server._rest()
doc = rest.get_design_doc(self.name, key[8:])
return DesignDoc(key[8:], doc, self)
else:
return self.get(key)
def view(self, view, **options):
params = deepcopy(options)
limit = None
if 'limit' in params:
limit = params['limit']
del params['limit']
if view.startswith("_design/"):
view_s = view.split('/')
view_doc = view_s[1]
view_map = view_s[3]
else:
view_doc = view
view_map = None
rest = self.server._rest()
results = rest.view_results(self.name, view_doc, view_map,
params, limit)
if 'rows' in results:
return results['rows']
else:
return None
def design_docs(self):
"""List all design documents and return DesignDoc objects for each"""
(ip, port, _, _) = self.server._rest_info()
api = ''.join(['http://{0}:{1}'.format(ip, port),
self.info.ddocs['uri']])
r = requests.get(api, auth=(self.server.rest_username,
self.server.rest_password))
ddocs = []
for ddoc in r.json.get('rows'):
ddocs.append(DesignDoc(ddoc['doc']['meta']['id'],
ddoc['doc']['json'], bucket=self))
return ddocs
def flush(self):
"""RESTful Bucket flushing - will destory all the data in a bucket."""
ip, port, rest_username, rest_password = self.server._rest_info()
api = ''.join(["http://{0}:{1}".format(ip, port),
self.info.controllers['flush']])
response = requests.post(api, auth=(rest_username, rest_password))
if response.status_code is 503:
raise Exception("Only buckets of type 'memcached' support flush.")
elif response.status_code is 404:
raise BucketUnavailableException
elif response.status_code is 200:
return True
class DesignDoc(object):
"""Object representation of a Couchbase Server Design Document--the thing
that holds the MapReduce Views.
This Object handles the core logic behind creating and updating views to
a specific design doc. It also handles copying/publishing a design doc into
(or out of) production."""
def __init__(self, name, ddoc=None, bucket=None):
assert isinstance(name, (str, unicode)), \
"name parameter must be of type string or unicode"
assert isinstance(ddoc, (str, unicode, dict)), \
"ddoc parameter must be of type string, unicode, or dictionary"
if name.startswith('_design/'):
name = name[8:]
self.name = name
self.bucket = bucket
if ddoc is None:
self.ddoc = {'type': 'javascript', 'views': {}}
elif isinstance(ddoc, unicode):
self.ddoc = json.loads(ddoc)
else:
self.ddoc = ddoc
def __str__(self):
"""Return the name of the Design Doc when using print"""
return self.name
def __eq__(self, other):
"""Compare name or "views" section of the Design Doc. This allows the
use of "for ddoc in" style syntax when used with
Bucket().design_docs()"""
if isinstance(other, str) and "{" not in other and "}" not in other:
return other == self.name
elif isinstance(other, dict):
return other['views'] == self.ddoc['views']
def __neq__(self, other):
return not self.__eq__(other)
def __getitem__(self, name):
return View(name, self.ddoc['views'][name], self)
def views(self):
return [View(view, self.ddoc['views'][view], self)
for view in self.ddoc['views']]
class View(object):
def __init__(self, name, view, ddoc=None):
"""Object for holding View information.
Keyword arguments:
name (str): Name of the View within the Design Doc
view (dict): View dictionary containing a 'map' and/or 'reduce' key
who's value should be of type string or unicode and
contain the JS MapReduce function
"""
assert isinstance(name, (str, unicode)), \
"name parameter must be of type string or unicode"
assert isinstance(view, dict), \
"view parameter must be of type dictionary"
assert 'map' in view, \
"name parameter must be of type string or unicode"
assert isinstance(view['map'], (str, unicode)), \
"name parameter must be of type string or unicode"
self.name = name
self.view = view
self.ddoc = ddoc
def __str__(self):
"""Return the name of the View when using print"""
return self.name
def __eq__(self, other):
"""Compare name or "views" section of the Design Doc. This allows the
use of "for ddoc in" style syntax when used with
Bucket().design_docs()"""
if isinstance(other, str) and "{" not in other and "}" not in other:
return other == self.name
elif isinstance(other, dict):
return other == {self.name: self.view}
def __neq__(self, other):
return not self.__eq__(other)
def results(self, params={}):
assert self.ddoc is not None, \
"View must be connected to a saved Design Document to retrieve" \
" results"
rest = self.ddoc.bucket.server._rest()
results = rest.view_results(self.ddoc.bucket.name, self.ddoc.name,
self.name, params)
return ViewResultsIterator(results)
class ViewResultsIterator(Set):
def __init__(self, results):
self.results = results['rows']
self.errors = results.get('errors')
if 'total_rows' in results:
self.total_rows = results['total_rows']
else:
# reduced values don't really have a "length" so setting to 1
self.total_rows = 1
def __eq__(self, other):
if len(self.results) == 1 and self.results[0]['key'] is None:
return self.results[0]['value'] == other
else:
return self.results == other
def __neq__(self, other):
return not self.__eq__(other)
def __iter__(self):
return self
def __len__(self):
return self.total_rows
def __contains__(self, item):
return item in self.results
def next(self):
try:
return self.results.pop(0)
except IndexError:
raise StopIteration