pwfdf item sbjson¶

Synopsis¶

pwfdf item sbjson ID [options]

Description¶

Returns the sbJSON for the specified ScienceBase item.

Arguments¶

The ID of the ScienceBase item whose sbJSON should be returned.

Example:

pwfdf item sbjson abc123

Options¶

-h, --help¶: Displays the command’s help text and exits.

-t, --show-traceback¶: Shows the full traceback when an error occurs.

--fields FIELD,FIELD,...¶

Specifies the sbJSON fields that should be queried.

Example:

pwfdf item sbjson abc123 --fields id,title,summary
pwfdf item sbjson abc123 --fields "id title summary"

--timeout SECONDS¶

Specifies the maximum allowed amount of time to connect with the ScienceBase server. Raises an error if the command cannot connect in this time frame. Defaults to 15 seconds.

Example:

pwfdf item sbjson abc123 --timeout 60

Logging¶

-q, --quiet¶

Do not log progress messages to the console.

Example:

pwfdf item sbjson abc123 -q

-v, --verbose¶

Prints more detailed progress messages to the console. (Useful for debugging).

Example:

pwfdf item sbjson abc123 -v

--log PATH¶

Logs detailed progress to the indicated file

Example:

pwfdf item sbjson abc123 --log my-file.log

--rotate-bytes N¶

A maximum allowed file size (in bytes), after which the log file will be rotated.

Example:

pwfdf item sbjson abc123 --log my-file.log --rotate-bytes 500000

--backup-count N¶

When rotating file logs, the number of backup log files to save. Defaults to 1.

Example:

pwfdf item sbjson abc123 --log my-file.log --rotate-bytes 500000 --backup-count 3