remote/sqlite-utils
1
0
Fork 0
mirror of https://github.com/simonw/sqlite-utils.git synced 2026-09-07 17:14:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add rows_to_csv() Python API helper for writing rows as CSV (issue #580)

Browse source 
The CLI can render query/table output as CSV via --csv, but the Python
API had no equivalent. sqlite_utils.utils.rows_to_csv() takes rows from
db.query() or table.rows/rows_where() and writes CSV to a file-like
object, or returns it as a string, with a header row by default (skip
with no_headers=True) to mirror the CLI's behavior.
This commit is contained in:
Parker Gurney 2026-08-05 14:08:10 -07:00
commit 74c7038b8b
4 changed files with 105 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/python-api.rst
View file

@ -3307,6 +3307,29 @@ The ``sqlite_utils.utils.rows_from_file()`` helper function can read rows (a seq
.. autofunction:: sqlite_utils.utils.rows_from_file
:noindex:
.. _python_api_rows_to_csv:
Writing rows to CSV
===================
The CLI can render query and table output as CSV using ``--csv``, see :ref:`cli_query_csv`. The ``sqlite_utils.utils.rows_to_csv()`` helper provides the same behavior from the Python API - pass it rows from :meth:`db.query() <python_api_query>` or ``table.rows`` / ``table.rows_where()`` and it writes CSV to a file-like object, or returns the CSV as a string if you don't pass one:
.. code-block:: python
from sqlite_utils.utils import rows_to_csv
db = Database("dogs.db")
csv_string = rows_to_csv(db["dogs"].rows)
# Or write directly to a file:
with open("dogs.csv", "w", newline="") as fp:
rows_to_csv(db["dogs"].rows, fp=fp)
Like the CLI, a header row is included by default - taken from the keys of the first row - and can be skipped with ``no_headers=True``.
.. autofunction:: sqlite_utils.utils.rows_to_csv
:noindex:
.. _python_api_maximize_csv_field_size_limit:
Setting the maximum CSV field size limit