-
Notifications
You must be signed in to change notification settings - Fork 102
/
collection.py
387 lines (317 loc) · 13.2 KB
/
collection.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
# coding: utf-8
# Copyright 2009 Alexandre Fiori
#
# 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 types
from txmongo import filter as qf
from txmongo._pymongo import errors
from txmongo._pymongo.son import SON
from txmongo._pymongo.code import Code
from txmongo._pymongo.objectid import ObjectId
from twisted.internet.defer import Deferred
class Collection(object):
def __init__(self, database, name):
if not isinstance(name, basestring):
raise TypeError("name must be an instance of basestring")
if not name or ".." in name:
raise errors.InvalidName("collection names cannot be empty")
if "$" in name and not (name.startswith("oplog.$main") or
name.startswith("$cmd")):
raise errors.InvalidName("collection names must not "
"contain '$': %r" % name)
if name[0] == "." or name[-1] == ".":
raise errors.InvalidName("collection names must not start "
"or end with '.': %r" % name)
if "\x00" in name:
raise errors.InvalidName("collection names must not contain the "
"null character")
self._database = database
self._collection_name = name
def __str__(self):
return "%s.%s" % (str(self._database), self._collection_name)
def __repr__(self):
return "<mongodb Collection: %s>" % str(self)
def __getitem__(self, collection_name):
return Collection(self._database,
"%s.%s" % (self._collection_name, collection_name))
def __cmp__(self, other):
if isinstance(other, Collection):
return cmp((self._database, self._collection_name),
(other._database, other._collection_name))
return NotImplemented
def __getattr__(self, collection_name):
return self[collection_name]
def __call__(self, collection_name):
return self[collection_name]
def _fields_list_to_dict(self, fields):
"""
transform a list of fields from ["a", "b"] to {"a":1, "b":1}
"""
as_dict = {}
for field in fields:
if not isinstance(field, types.StringTypes):
raise TypeError("fields must be a list of key names")
as_dict[field] = 1
return as_dict
def _gen_index_name(self, keys):
return u"_".join([u"%s_%s" % item for item in keys])
def options(self):
def wrapper(result):
if result:
options = result.get("options", {})
if "create" in options:
del options["create"]
return options
return {}
d = self._database.system.namespaces.find_one({"name": str(self)})
d.addCallback(wrapper)
return d
def find(self, spec=None, skip=0, limit=0, fields=None, filter=None, _proto=None):
if spec is None:
spec = SON()
if not isinstance(spec, types.DictType):
raise TypeError("spec must be an instance of dict")
if not isinstance(fields, (types.DictType, types.ListType, types.NoneType)):
raise TypeError("fields must be an instance of dict or list")
if not isinstance(skip, types.IntType):
raise TypeError("skip must be an instance of int")
if not isinstance(limit, types.IntType):
raise TypeError("limit must be an instance of int")
if fields is not None:
if not isinstance(fields, types.DictType):
if not fields:
fields = ["_id"]
fields = self._fields_list_to_dict(fields)
if isinstance(filter, (qf.sort, qf.hint, qf.explain, qf.snapshot)):
spec = SON(dict(query=spec))
for k, v in filter.items():
spec[k] = isinstance(v, types.TupleType) and SON(v) or v
# send the command through a specific connection
# this is required for the connection pool to work
# when safe=True
if _proto is None:
proto = self._database._connection
else:
proto = _proto
return proto.OP_QUERY(str(self), spec, skip, limit, fields)
def find_one(self, spec=None, fields=None, _proto=None):
def wrapper(docs):
doc = docs and docs[0] or {}
if doc.get("err") is not None:
if doc.get("code") == 11000:
raise errors.DuplicateKeyError
else:
raise errors.OperationFailure(doc)
else:
return doc
if isinstance(spec, ObjectId):
spec = SON(dict(_id=spec))
d = self.find(spec, limit=-1, fields=fields, _proto=_proto)
d.addCallback(wrapper)
return d
def count(self, spec=None, fields=None):
def wrapper(result):
return result["n"]
if fields is not None:
if not fields:
fields = ["_id"]
fields = self._fields_list_to_dict(fields)
spec = SON([("count", self._collection_name),
("query", spec or SON()),
("fields", fields)])
d = self._database["$cmd"].find_one(spec)
d.addCallback(wrapper)
return d
def group(self, keys, initial, reduce, condition=None, finalize=None):
body = {
"ns": self._collection_name,
"key": self._fields_list_to_dict(keys),
"initial": initial,
"$reduce": Code(reduce),
}
if condition:
body["cond"] = condition
if finalize:
body["finalize"] = Code(finalize)
return self._database["$cmd"].find_one({"group": body})
def filemd5(self, spec):
def wrapper(result):
return result.get('md5')
if not isinstance(spec, ObjectId):
raise ValueError(_("filemd5 expected an objectid for its "
"on-keyword argument"))
spec = SON([("filemd5", spec),
("root", self._collection_name)])
d = self._database['$cmd'].find_one(spec)
d.addCallback(wrapper)
return d
def __safe_operation(self, proto, safe=False, ids=None):
callit = False
if safe is True:
d = self._database["$cmd"].find_one({"getlasterror": 1}, _proto=proto)
else:
callit = True
d = Deferred()
if ids is not None:
d.addCallback(lambda _: ids)
if callit is True:
d.callback(None)
return d
def insert(self, docs, safe=False):
if isinstance(docs, types.DictType):
ids = docs.get('_id', ObjectId())
docs["_id"] = ids
docs = [docs]
elif isinstance(docs, types.ListType):
ids = []
for doc in docs:
if isinstance(doc, types.DictType):
id = doc.get('_id', ObjectId())
ids.append(id)
doc["_id"] = id
else:
raise TypeError("insert takes a document or a list of documents")
else:
raise TypeError("insert takes a document or a list of documents")
proto = self._database._connection
proto.OP_INSERT(str(self), docs)
return self.__safe_operation(proto, safe, ids)
def update(self, spec, document, upsert=False, multi=False, safe=False):
if not isinstance(spec, types.DictType):
raise TypeError("spec must be an instance of dict")
if not isinstance(document, types.DictType):
raise TypeError("document must be an instance of dict")
if not isinstance(upsert, types.BooleanType):
raise TypeError("upsert must be an instance of bool")
proto = self._database._connection
proto.OP_UPDATE(str(self), spec, document, upsert, multi)
return self.__safe_operation(proto, safe)
def save(self, doc, safe=False):
if not isinstance(doc, types.DictType):
raise TypeError("cannot save objects of type %s" % type(doc))
objid = doc.get("_id")
if objid:
return self.update({"_id": objid}, doc, safe=safe, upsert=True)
else:
return self.insert(doc, safe=safe)
def remove(self, spec, safe=False):
if isinstance(spec, ObjectId):
spec = SON(dict(_id=spec))
if not isinstance(spec, types.DictType):
raise TypeError("spec must be an instance of dict, not %s" % type(spec))
proto = self._database._connection
proto.OP_DELETE(str(self), spec)
return self.__safe_operation(proto, safe)
def drop(self, safe=False):
return self.remove({}, safe)
def create_index(self, sort_fields, **kwargs):
def wrapper(result, name):
return name
if not isinstance(sort_fields, qf.sort):
raise TypeError("sort_fields must be an instance of filter.sort")
if "name" not in kwargs:
name = self._gen_index_name(sort_fields["orderby"])
else:
name = kwargs.pop("name")
key = SON()
for k,v in sort_fields["orderby"]:
key.update({k:v})
index = SON(dict(
ns=str(self),
name=name,
key=key
))
if "drop_dups" in kwargs:
kwargs["dropDups"] = kwargs.pop("drop_dups")
if "bucket_size" in kwargs:
kwargs["bucketSize"] = kwargs.pop("bucket_size")
index.update(kwargs)
d = self._database.system.indexes.insert(index, safe=True)
d.addCallback(wrapper, name)
return d
def ensure_index(self, sort_fields, **kwargs):
# ensure_index is an alias of create_index since we are not
# keep an index cache same way pymongo does
return self.create_index(sort_fields, **kwargs)
def drop_index(self, index_identifier):
if isinstance(index_identifier, types.StringTypes):
name = index_identifier
elif isinstance(index_identifier, qf.sort):
name = self._gen_index_name(index_identifier["orderby"])
else:
raise TypeError("index_identifier must be a name or instance of filter.sort")
cmd = SON([("deleteIndexes", self._collection_name), ("index", name)])
return self._database["$cmd"].find_one(cmd)
def drop_indexes(self):
return self.drop_index("*")
def index_information(self):
def wrapper(raw):
info = {}
for idx in raw:
info[idx["name"]] = idx["key"].items()
return info
d = self._database.system.indexes.find({"ns": str(self)})
d.addCallback(wrapper)
return d
def rename(self, new_name):
cmd = SON([("renameCollection", str(self)), ("to", "%s.%s" % \
(str(self._database), new_name))])
return self._database("admin")["$cmd"].find_one(cmd)
def distinct(self, key, spec=None):
def wrapper(result):
if result:
return result.get("values")
return {}
cmd = SON([("distinct", self._collection_name), ("key", key)])
if spec:
cmd["query"] = spec
d = self._database["$cmd"].find_one(cmd)
d.addCallback(wrapper)
return d
def map_reduce(self, map, reduce, full_response=False, **kwargs):
def wrapper(result, full_response):
if full_response:
return result
return result.get("result")
cmd = SON([("mapreduce", self._collection_name),
("map", map), ("reduce", reduce)])
cmd.update(**kwargs)
d = self._database["$cmd"].find_one(cmd)
d.addCallback(wrapper, full_response)
return d
def find_and_modify(self, query={}, update=None, upsert=False, **kwargs):
def wrapper(result):
no_obj_error = "No matching object found"
if not result['ok']:
if result["errmsg"] == no_obj_error:
return None
else:
raise ValueError("Unexpected Error: %s" % (result,))
return result.get('value')
if (not update and not kwargs.get('remove', None)):
raise ValueError("Must either update or remove")
if (update and kwargs.get('remove', None)):
raise ValueError("Can't do both update and remove")
cmd = SON([("findAndModify", self._collection_name)])
cmd.update(kwargs)
# No need to include empty args
if query:
cmd['query'] = query
if update:
cmd['update'] = update
if upsert:
cmd['upsert'] = upsert
no_obj_error = "No matching object found"
d = self._database["$cmd"].find_one(cmd)
d.addCallback(wrapper)
return d