Skip to content

commands.md

Latest commit

 

History

History
35 lines (29 loc) · 1.41 KB

commands.md

File metadata and controls

35 lines (29 loc) · 1.41 KB
Raw

commands

Documentation on individual commands can be see with

    dataset -help COMMAND_NAME

where "COMMAND_NAME" is

replaced with one of the commands below --

  • init - initialize a new collection if none exists, requires a path to collection
  • keys - returns the keys to stdout, one key per line
  • has-key - returns true is key is in collection, false otherwise
  • create - creates a new JSON document or replace an existing one in collection
  • read - displays a JSON document to stdout
  • update - updates a JSON document in collection
  • delete - removes a JSON document from collection
  • count - returns a count of keys in a collection
  • Attachments
    • attachments - lists any attached content for JSON document
    • attach - attaches a non-JSON content to a JSON record
    • retrieve - returns attachments for a JSON document
    • prune - remove attachments to a JSON document
  • dump - export collection to a JSON lines file
  • load - import a collection using a JSON lines file

NOTE: The options create, update can read JSON documents piped from standard in if you use the '-i -' or '-include -' option. Likewise keys can be read from standard input with the '-i -' or '-include -' options for read, list, keys and count.