Contents Menu Expand Light mode Dark mode Auto light/dark mode
HyperShell v2
HyperShell v2

Intro

  • Getting Started
  • Installation

Reference

  • Command-line Interface
    • cluster
    • server
    • client
    • submit
    • initdb
    • config get
    • config set
    • config edit
    • config which
    • task submit
    • task info
    • task wait
    • task run
    • task search
    • task update
  • Library
    • hypershell.submit
    • hypershell.server
    • hypershell.client
    • hypershell.database
  • Configuration
  • Logging
  • Database
  • Templates

Tutorial

  • Basic
  • Distributed
  • Hybrid
  • Advanced

Project

  • Blog
    • Release Notes (v2.2.0)
  • Roadmap

Development

  • Contributing
  • License

Supplemental

  • Citation
  v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds
Back to top
Edit this page

Task Search#

Usage#

hyper-shell task search [-h]

[FIELD [FIELD ...]] [--where COND [COND ...]] [--order-by FIELD [--desc]] [-x | --json | --csv] [--count | --limit NUM]

Description#

Search for tasks in database.

A database must be configured. Fields will be columns in the output. Options relate to SQL concepts. For single column output, use -x/--extract to disable formatting and quotations (useful for piping output).


Arguments#

FIELD

Select specific named fields to include in output. Default is to include all fields.

Options#

-w, --where COND…

List of conditional statements to filter results (e.g., -w 'exit_status != 0').

-s, --order-by FIELD

Order results by field.

-x, --extract

Disable formatting for single column output.

--failed

Alias for -w 'exit_status != 0'.

--succeeded

Alias for -w 'exit_status == 0'.

--finished

Alias for -w 'exit_status != null'.

--remaining

Alias for -w 'exit_status == null'.

--json

Format output as JSON.

--csv

Format output as CSV.

-l, --limit NUM

Limit number of returned results.

-c, --count

Only print number of results that would be returned.

Next
Task Update
Previous
Task Run
Copyright © 2019-2023 Geoffrey Lentner
Made with Sphinx and @pradyunsg's Furo
On this page
  • Task Search
    • Usage
    • Description
      • Arguments
      • Options