feat(grzctl): add configurable display limit for db list command (#344)

Resolves #340

feat(grz-db): add limit parameter to database list_submissions

Author: Travis Wrightsman

packages/grz-db/src/grz_db/models/submission.py

@@ -449,15 +449,19 @@ def get_submission(self, submission_id: str) -> Submission | None:
             submission = session.exec(statement).first()
             return submission
 
-    def list_submissions(self) -> Sequence[Submission]:
+    def list_submissions(self, limit: int | None) -> Sequence[Submission]:
         """
         Lists all submissions in the database.
 
         Returns:
-            A list of all submissions in the database, ordered by their ID.
+            A list of all submissions in the database, ordered by their submission date, latest first.
         """
         with self._get_session() as session:
-            statement = select(Submission).options(selectinload(Submission.states)).order_by(Submission.id)  # type: ignore[arg-type]
+            statement = (
+                select(Submission).options(selectinload(Submission.states)).order_by(Submission.submission_date.desc())  # type: ignore[arg-type,union-attr]
+            )
+            if limit is not None:
+                statement = statement.limit(limit)
             submissions = session.exec(statement).all()
             return submissions
 

packages/grzctl/src/grzctl/commands/__init__.py

@@ -1,3 +1,7 @@
 """
 Command modules for the grzctl package.
 """
+
+import click
+
+limit = click.option("--limit", type=click.IntRange(min=0), default=10)

packages/grzctl/src/grzctl/commands/db.py

@@ -37,6 +37,7 @@
 from grz_pydantic_models.submission.metadata import GrzSubmissionMetadata, LibraryType
 
 from ..models.config import DbConfig
+from . import limit
 from .pruefbericht import get_pruefbericht_library_type
 
 console = rich.console.Console()
@@ -140,14 +141,15 @@ def upgrade(
 
 @db.command("list")
 @output_json
+@limit
 @click.pass_context
-def list_submissions(ctx: click.Context, output_json: bool = False):
+def list_submissions(ctx: click.Context, output_json: bool, limit: int):
     """Lists all submissions in the database with their latest state."""
     db = ctx.obj["db_url"]
     db_service = get_submission_db_instance(db)
 
     try:
-        submissions = db_service.list_submissions()
+        submissions = db_service.list_submissions(limit=limit)
     except Exception as e:
         raise click.ClickException(str(e)) from e
 

packages/grzctl/src/grzctl/commands/list_submissions.py

@@ -15,6 +15,7 @@
 from pydantic_core import to_jsonable_python
 
 from ..models.config import ListConfig
+from . import limit
 from .db import get_submission_db_instance
 
 log = logging.getLogger(__name__)
@@ -90,7 +91,7 @@ def _prepare_table(summaries: list[InboxSubmissionSummary], database_states: dic
 @config_file
 @output_json
 @click.option("--show-cleaned/--hide-cleaned", help="Show cleaned submissions.")
-@click.option("--limit", type=click.IntRange(min=0), default=10)
+@limit
 def list_submissions(config_file: Path, output_json: bool, show_cleaned: bool, limit: int):
     """
     List submissions within an inbox from oldest to newest, up to the requested limit.