This repository has been archived by the owner on Nov 23, 2020. It is now read-only.
/
store.py
280 lines (232 loc) · 8.91 KB
/
store.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
'''CouchDB_ document store::
store = create_store('http+couchdb://localhost:5984/mydb')
Models
=========
A :class:`.Model` is stored as a document in the store database, this
means instances of different models which use the same couchdb store
are stored in exactly the same database.
To differentiate and query over different types of models, the
``Type`` field is added to the document representing a model.
Queries
===========
Search
==========
https://github.com/rnewson/couchdb-lucene
CouchDBStore
=================
.. autoclass:: CouchDBStore
:members:
:member-order: bysource
.. _CouchDB: http://couchdb.apache.org/
'''
from base64 import b64encode, b64decode
from pulsar import asyncio, coroutine_return, task, multi_async
from pulsar.utils.system import json
from pulsar.apps.data import Store, Command, register_store
from pulsar.utils.pep import zip
from pulsar.apps.data import odm
from .query import CauchDbQuery, CouchDbError, couch_db_error, CouchDBMixin
index_view = '''function (doc) {{
if(doc.Type == '{0}' && doc.{1} !== undefined) emit(doc.{1}, doc._rev);
}};
'''
class CouchDBStore(CouchDBMixin, Store):
_lock = None
@property
def scheme(self):
return self._scheme
# COUCHDB operation
def info(self):
'''Information about the running server
'''
return self.request('get')
ping = info
# DATABASE OPERATIONS
def create_database(self, dbname=None, **kw):
'''Create a new database
:param dbname: optional database name. If not provided
the :attr:`~Store._database` is created instead.
'''
return self.request('put', dbname or self._database)
def delete_database(self, dbname=None):
'''Delete a database ``dbname``
'''
return self.request('delete', dbname or self._database)
def all_databases(self):
'''The list of all databases
'''
return self.request('get', '_all_dbs')
# DESIGN VIEWS
def design_create(self, name, views, language=None, **kwargs):
'''Create a new design document
'''
return self.request('put', self._database, '_design', name,
views=views,
language=language or 'javascript', **kwargs)
@task
def design_delete(self, name):
'''Delete an existing design document at ``name``.
'''
response = yield self.request('head', self._database, '_design', name)
if response.status_code == 200:
rev = json.loads(response.headers['etag'])
yield self.request('delete', self._database, '_design', name,
rev=rev)
def design_info(self, name):
return self.request('get', self._database, '_design', name, '_info')
# DOCUMENTS API
def get_document(self, dbname, pkvalue):
'''Fetch a document from ``dbname`` with id ``pkvalue``
'''
return self.request('get', dbname, pkvalue)
def update_document(self, dbname, document):
return self.request('post', dbname, **document)
def update_documents(self, dbname, documents, new_edits=True):
'''Bulk update/insert of documents in a database
'''
return self.request('post', dbname, '_bulk_docs', docs=documents,
new_edits=new_edits)
# ODM
def create_table(self, model, remove_existing=False):
# Build views
meta = model._meta
table = meta.table_name
if remove_existing:
yield self.design_delete(table)
views = {}
for index in meta.indexes:
name = key = index.store_name
if index.primary_key:
name = 'id'
key = '_id'
views[name] = {'map': index_view.format(table, key),
'reduce': '_count'}
result = yield self.design_create(table, views)
coroutine_return(result)
def drop_table(self, model):
'''Drop model table by simply removing model design views'''
return self.design_delete(model._meta.table_name)
def table_info(self, model):
return self.design_info(model._meta.table_name)
def execute_transaction(self, transaction):
'''Execute a ``transaction``
'''
updates = []
models = []
for command in transaction.commands:
action = command.action
if not action:
raise NotImplementedError
else:
model = command.args
updates.append(dict(self.model_data(model, action)))
models.append(model)
#
if updates:
executed = yield self.update_documents(self._database, updates)
errors = []
for doc, model in zip(executed, models):
if doc.get('ok'):
model['id'] = doc['id']
model['_rev'] = doc['rev']
model._modified.clear()
elif doc.get('error'):
errors.append(CouchDbError(doc['error'], doc['reason']))
if errors:
raise errors[0]
coroutine_return(models)
@task
def get_model(self, manager, pkvalue):
try:
data = yield self.request('get', self._database, pkvalue)
except CouchDbError:
raise odm.ModelNotFound(pkvalue)
else:
coroutine_return(self.build_model(manager, data))
def query_model_view(self, model, view_name, key=None, keys=None,
group=None, limit=None, include_docs=None,
reduce=True, method=None):
'''Query an existing view
All view parameters here:
http://wiki.apache.org/couchdb/HTTP_view_API
'''
meta = model._meta
kwargs = {}
if key:
kwargs['key'] = json.dumps(key)
elif keys:
kwargs['keys'] = json.dumps(keys)
if group:
kwargs['group'] = 'true'
if limit:
kwargs['limit'] = int(limit)
if include_docs:
kwargs['include_docs'] = 'true'
if not reduce:
kwargs['reduce'] = 'false'
return self.request(method or 'get', self._database, '_design',
meta.table_name, '_view', view_name, **kwargs)
def compile_query(self, query):
return CauchDbQuery(self, query)
def build_model(self, manager, *args, **kwargs):
pkname = manager._meta.pkname()
if args:
params = args[0]
if pkname not in params:
params[pkname] = params.pop('_id')
return super(CouchDBStore, self).build_model(manager, *args, **kwargs)
# INTERNALS
@task
def request(self, method, *bits, **kwargs):
'''Execute the HTTP request'''
if self._password:
try:
lock = self._lock
if not lock:
self._lock = lock = asyncio.Lock(loop=self._loop)
yield lock.acquire()
url = '%s/_session' % self._address
response = yield self._http.post(
url, data={'name': self._user,
'password': self._password},
encode_multipart=False)
self.fire_event('request', response)
if response.status_code != 200:
response.raise_for_status()
self._lock = None
else:
yield lock.acquire()
finally:
lock.release()
url = '%s/%s' % (self._address, '/'.join(bits))
response = yield self._http.request(method, url, data=kwargs,
headers=self.headers)
self.fire_event('request', response)
if response.request.method == 'HEAD':
coroutine_return(response)
else:
data = response.decode_content()
if 'error' in data:
raise couch_db_error(**data)
else:
coroutine_return(data)
def encode_bytes(self, data):
return b64encode(data).decode(self._encoding)
def dencode_bytes(self, data):
return b64decode(data.encode(self._encoding))
def model_data(self, model, action):
'''A generator of field/value pair for the store
'''
meta = model._meta
pkname = meta.pkname()
_id = '_id'
if action == Command.DELETE:
yield _id, model.id
yield '_deleted', True
else:
for key, value in meta.store_data(model, self, action):
yield _id if key == pkname else key, value
yield 'Type', meta.table_name
register_store("couchdb", "pulsar.apps.data.stores.CouchDBStore")
register_store("http+couchdb", "pulsar.apps.data.stores.CouchDBStore")
register_store("https+couchdb", "pulsar.apps.data.stores.CouchDBStore")