diff options
| -rw-r--r-- | lib/sqlalchemy/orm/query.py | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/lib/sqlalchemy/orm/query.py b/lib/sqlalchemy/orm/query.py index cb1773e5a..c9f29e6be 100644 --- a/lib/sqlalchemy/orm/query.py +++ b/lib/sqlalchemy/orm/query.py @@ -1038,8 +1038,20 @@ class Query(object): "Multiple rows were found for one()") def scalar(self): - """Return """ + """Return the first element of the first result or None. + >>> session.query(Item).scalar() + <Item> + >>> session.query(Item.id).scalar() + 1 + >>> session.query(Item.id, Item.name).scalar() + 1 + >>> session.query(func.count(Parent.id)).scalar() + 20 + + This results in an execution of the underlying query. + + """ ret = list(self)[0] if not isinstance(ret, tuple): return ret |