def find_one(cls, spec_or_id=None, *args, **kwargs):
"""Returns one Document that meets criteria. Wraps pymongo's find_one
method and supports all of the same arguments.
"""
timer = Timer()
with timer:
result = cls.collection.find_one(spec_or_id, *args, **kwargs)
found_record, num_found = None, 0
if result:
found_record, num_found = cls(**result), 1
logger.info(
"(%ss) %s FIND ONE %s, %s, %s (%s record(s) found)",
timer.duration_in_seconds(),
cls.__name__,
spec_or_id,
args,
kwargs,
num_found
)
return found_record
def save(self, w=1, wtimeout=0, j=False):
"""Saves the Document by inserting it into the collection if it does
not exist or updating it if it does. Returns True if save was
successful. Ensures that the Document is valid before saving and
returns False if it was not.
This function performs an upsert if the model has an ID, but is not in
the database.
If the document model has a field named 'created_at', this field's
value will be set to the current time when the document is inserted.
Supports the following arguments that are passed to pymongo:
w: Write concern level. Default is 1
wtimeout: Timeout in ms for write concern. Default is 0
j: Journaling option for write concern. Default is False
See Pymongo docs for more information on these arguments:
http://api.mongodb.org/python/current/api/pymongo/collection.html
See the Mongo docs for more information on Write Concern:
http://docs.mongodb.org/manual/core/write-concern/
"""
if not self.valid:
return False
write_opts = frozenset(["w", "j", "wtimeout"])
kwargs = {k: v for k, v in locals().iteritems() if k in write_opts}
operation = Update if self.bson_id else Insert
operation = operation(self, **kwargs)
timer = Timer()
with timer:
try:
operation.execute()
except pymongo.errors.PyMongoError as e:
operation.reset_fields()
if isinstance(e, pymongo.errors.DuplicateKeyError):
logger.warn(
"%s %s failed due to unique index violation (%s)",
self.__class__.__name__, operation.name, e.message)
f = re.search(r'\$(.+)_unique_index', e.message).group(1)
self.errors.add(f, "must be unique")
return False
raise
self.changed_fields = set()
logger.info("(%ss) %s %s %s, %s", timer.duration_in_seconds(),
self.__class__.__name__, operation.name,
self.mongo_field_values, self._id)
return True
def delete(self):
"""Removes the Document from the collection."""
timer = Timer()
with timer:
result = self.__class__.collection.remove({"_id": self._id})
logger.info("(%ss) %s DELETE %s", timer.duration_in_seconds(),
self.__class__.__name__, self._id)
if result.get("err"):
logger.error(result.get("err"))
def find(cls, *args, **kwargs):
"""Returns all Documents in collection that meet criteria. Wraps
pymongo's *find* method and supports all of the same arguments.
"""
timer = Timer()
with timer:
results = cls.collection.find(*args, **kwargs)
logger.info("(%ss) %s FIND %s, %s (%s record(s) found)",
timer.duration_in_seconds(), cls.__name__, args, kwargs,
results.count())
return [cls(**result) for result in results]
def delete(self):
"""Removes the Document from the collection."""
timer = Timer()
with timer:
result = self.__class__.collection.remove({"_id": self._id})
logger.info(
"(%ss) %s DELETE %s",
timer.duration_in_seconds(),
self.__class__.__name__,
self._id
)
if result.get("err"):
logger.error(result.get("err"))
def find_one(cls, spec_or_id=None, *args, **kwargs):
"""Returns one Document that meets criteria. Wraps pymongo's find_one
method and supports all of the same arguments.
"""
timer = Timer()
with timer:
result = cls.collection.find_one(spec_or_id, *args, **kwargs)
found_record, num_found = None, 0
if result:
found_record, num_found = cls(**result), 1
logger.info("(%ss) %s FIND ONE %s, %s, %s (%s record(s) found)",
timer.duration_in_seconds(), cls.__name__, spec_or_id,
args, kwargs, num_found)
return found_record
def find(cls, *args, **kwargs):
"""Returns all Documents in collection that meet criteria. Wraps
pymongo's *find* method and supports all of the same arguments.
"""
timer = Timer()
with timer:
results = cls.collection.find(*args, **kwargs)
logger.info(
"(%ss) %s FIND %s, %s (%s record(s) found)",
timer.duration_in_seconds(),
cls.__name__,
args,
kwargs,
results.count()
)
return [cls(**result) for result in results]
def save(self, w=1, wtimeout=0, j=False):
"""Saves the Document by inserting it into the collection if it does
not exist or updating it if it does. Returns True if save was
successful. Ensures that the Document is valid before saving and
returns False if it was not.
This function performs an upsert if the model has an ID, but is not in
the database.
If the document model has a field named 'created_at', this field's
value will be set to the current time when the document is inserted.
Supports the following arguments that are passed to pymongo:
w: Write concern level. Default is 1
wtimeout: Timeout in ms for write concern. Default is 0
j: Journaling option for write concern. Default is False
See Pymongo docs for more information on these arguments:
http://api.mongodb.org/python/current/api/pymongo/collection.html
See the Mongo docs for more information on Write Concern:
http://docs.mongodb.org/manual/core/write-concern/
"""
if not self.valid:
return False
write_opts = frozenset(["w", "j", "wtimeout"])
kwargs = {k: v for k, v in locals().iteritems() if k in write_opts}
operation = Update if self.bson_id else Insert
operation = operation(self, **kwargs)
timer = Timer()
with timer:
try:
operation.execute()
except pymongo.errors.PyMongoError as e:
operation.reset_fields()
if isinstance(e, pymongo.errors.DuplicateKeyError):
logger.warn(
"%s %s failed due to unique index violation (%s)",
self.__class__.__name__,
operation.name,
e.message
)
f = re.search(r'\$(.+)_unique_index', e.message).group(1)
self.errors.add(f, "must be unique")
return False
raise
self.changed_fields = set()
logger.info(
"(%ss) %s %s %s, %s",
timer.duration_in_seconds(),
self.__class__.__name__,
operation.name,
self.mongo_field_values,
self._id
)
return True
