Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fixed #214 -- Added get_values() and get_values_iterator() module-lev…

…el functions to DB API. Thanks, rmunn

git-svn-id: http://code.djangoproject.com/svn/django/trunk@359 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 1a8fc57bf6e4b86fe047d04fea2efe50296634d0 1 parent 3aa33ed
@adrianholovaty adrianholovaty authored
Showing with 52 additions and 1 deletion.
  1. +32 −1 django/core/meta.py
  2. +20 −0 tests/testapp/models/lookup.py
View
33 django/core/meta.py
@@ -562,6 +562,12 @@ def __new__(cls, name, bases, attrs):
new_mod.get_iterator = curry(function_get_iterator, opts, new_class)
new_mod.get_iterator.__doc__ = "Returns an iterator of %s objects matching the given parameters." % name
+ new_mod.get_values = curry(function_get_values, opts, new_class)
+ new_mod.get_values.__doc__ = "Returns a list of dictionaries matching the given parameters."
+
+ new_mod.get_values_iterator = curry(function_get_values_iterator, opts, new_class)
+ new_mod.get_values_iterator.__doc__ = "Returns an iterator of dictionaries matching the given parameters."
+
new_mod.get_count = curry(function_get_count, opts)
new_mod.get_count.__doc__ = "Returns the number of %s objects matching the given parameters." % name
@@ -1083,6 +1089,31 @@ def function_get_count(opts, **kwargs):
cursor.execute("SELECT COUNT(*)" + sql, params)
return cursor.fetchone()[0]
+def function_get_values_iterator(opts, klass, **kwargs):
+ # select_related and select aren't supported in get_values().
+ kwargs['select_related'] = False
+ kwargs['select'] = {}
+
+ # 'fields' is a list of field names to fetch.
+ try:
+ fields = kwargs.pop('fields')
+ except KeyError: # Default to all fields.
+ fields = [f.name for f in opts.fields]
+
+ cursor = db.db.cursor()
+ _, sql, params = function_get_sql_clause(opts, **kwargs)
+ select = ['%s.%s' % (opts.db_table, f) for f in fields]
+ cursor.execute("SELECT " + (kwargs.get('distinct') and "DISTINCT " or "") + ",".join(select) + sql, params)
+ while 1:
+ rows = cursor.fetchmany(GET_ITERATOR_CHUNK_SIZE)
+ if not rows:
+ raise StopIteration
+ for row in rows:
+ yield dict(zip(fields, row))
+
+def function_get_values(opts, klass, **kwargs):
+ return list(function_get_values_iterator(opts, klass, **kwargs))
+
def _fill_table_cache(opts, select, tables, where, old_prefix, cache_tables_seen):
"""
Helper function that recursively populates the select, tables and where (in
@@ -1228,7 +1259,7 @@ def function_get_sql_clause(opts, **kwargs):
_fill_table_cache(opts, select, tables, where, opts.db_table, [opts.db_table])
# Add any additional SELECTs passed in via kwargs.
- if kwargs.get('select', False):
+ if kwargs.get('select'):
select.extend(['(%s) AS %s' % (s[1], s[0]) for s in kwargs['select']])
# ORDER BY clause
View
20 tests/testapp/models/lookup.py
@@ -58,6 +58,26 @@ def __repr__(self):
>>> articles.get_in_bulk([1000])
{}
+# get_values() is just like get_list(), except it returns a list of
+# dictionaries instead of object instances -- and you can specify which fields
+# you want to retrieve.
+>>> articles.get_values(fields=['headline'])
+[{'headline': 'Article 4'}, {'headline': 'Article 2'}, {'headline': 'Article 3'}, {'headline': 'Article 1'}]
+>>> articles.get_values(pub_date__exact=datetime(2005, 7, 27), fields=['id'])
+[{'id': 2}, {'id': 3}]
+>>> articles.get_values(fields=['id', 'headline']) == [{'id': 4, 'headline': 'Article 4'}, {'id': 2, 'headline': 'Article 2'}, {'id': 3, 'headline': 'Article 3'}, {'id': 1, 'headline': 'Article 1'}]
+True
+
+# get_values_iterator() is just like get_values(), but it's a generator.
+>>> for d in articles.get_values_iterator(fields=['id', 'headline']):
+... i = d.items()
+... i.sort()
+... i
+[('headline', 'Article 4'), ('id', 4)]
+[('headline', 'Article 2'), ('id', 2)]
+[('headline', 'Article 3'), ('id', 3)]
+[('headline', 'Article 1'), ('id', 1)]
+
# Every DateField and DateTimeField creates get_next_by_FOO() and
# get_previous_by_FOO() methods.
>>> a3.get_next_by_pub_date()
Please sign in to comment.
Something went wrong with that request. Please try again.