Document delete() and all()

Browse Source
This commit is contained in:
Friedrich Lindenberg 2013-04-02 00:20:02 +02:00
parent 963aefe9da
commit 82153522cb
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
dataset/persistence/table.py
View File

@ -82,6 +82,16 @@ class Table(object):
self.insert(row, ensure=ensure, types=types) self.insert(row, ensure=ensure, types=types)
def delete(self, **kw): def delete(self, **kw):
""" Delete rows from the table. Keyword arguments can be used
to add column-based filters. The filter criterion will always
be equality:
.. code-block:: python
table.delete(place='Berlin')
If no arguments are given, all records are deleted.
"""
q = self._args_to_clause(kw) q = self._args_to_clause(kw)
stmt = self.table.delete(q) stmt = self.table.delete(q)
self.database.engine.execute(stmt) self.database.engine.execute(stmt)
@ -171,5 +181,8 @@ class Table(object):
return self.database.query(q) return self.database.query(q)
def all(self): def all(self):
""" Return all records in the table, ordered by their
``id``. This is an alias for calling ``find`` without
any arguments. """
return self.find() return self.find()