Skip to content

Commit

Permalink
sqlite-utils rows --limit and --offset options, closes #381
Browse files Browse the repository at this point in the history
  • Loading branch information
simonw committed Jan 11, 2022
1 parent 1d44b0c commit 324ebc3
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/cli-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,8 @@ See :ref:`cli_rows`.

Options:
-c, --column TEXT Columns to return
--limit INTEGER Number of rows to return - defaults to everything
--offset INTEGER SQL offset to use
--nl Output newline-delimited JSON
--arrays Output rows as arrays instead of objects
--csv Output CSV
Expand Down
2 changes: 2 additions & 0 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,8 @@ You can use the ``-c`` option to specify a subset of columns to return::
[{"age": 4, "name": "Cleo"},
{"age": 2, "name": "Pancakes"}]

Use ``--limit N`` to only return the first ``N`` rows. Use ``--offset N`` to return rows starting from the specified offset.

.. _cli_tables:

Listing tables
Expand Down
19 changes: 18 additions & 1 deletion sqlite_utils/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -1723,6 +1723,16 @@ def search(
)
@click.argument("dbtable")
@click.option("-c", "--column", type=str, multiple=True, help="Columns to return")
@click.option(
"--limit",
type=int,
help="Number of rows to return - defaults to everything",
)
@click.option(
"--offset",
type=int,
help="SQL offset to use",
)
@output_options
@load_extension_option
@click.pass_context
Expand All @@ -1731,6 +1741,8 @@ def rows(
path,
dbtable,
column,
limit,
offset,
nl,
arrays,
csv,
Expand All @@ -1745,10 +1757,15 @@ def rows(
columns = "*"
if column:
columns = ", ".join("[{}]".format(c) for c in column)
sql = "select {} from [{}]".format(columns, dbtable)
if limit:
sql += " limit {}".format(limit)
if offset:
sql += " offset {}".format(offset)
ctx.invoke(
query,
path=path,
sql="select {} from [{}]".format(columns, dbtable),
sql=sql,
nl=nl,
arrays=arrays,
csv=csv,
Expand Down
8 changes: 8 additions & 0 deletions tests/test_cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -851,6 +851,14 @@ def test_query_memory_does_not_create_file(tmpdir):
["--nl", "-c", "age", "-c", "name"],
'{"age": 4, "name": "Cleo"}\n{"age": 2, "name": "Pancakes"}',
),
(
["-c", "name", "--limit", "1"],
'[{"name": "Cleo"}]',
),
(
["-c", "name", "--limit", "1", "--offset", "1"],
'[{"name": "Pancakes"}]',
),
],
)
def test_rows(db_path, args, expected):
Expand Down

0 comments on commit 324ebc3

Please sign in to comment.