Dynomate
Browse documentation

Request collections

On this page8
  1. 1Overview
  2. 2Collection layout
  3. 3Create a collection
  4. 4Open an existing collection
  5. 5Browse a collection
  6. 6Create a request
  7. 7Save, rename, and delete
  8. 8Invalid files

A collection is a folder of requests. Each request is a .dnml file that runs in the app and in the CLI.

You can keep a collection in Git. Request collections are included in the trial and in Professional and Enterprise. With Community or Indie access, request tabs open locked.

Collection layout

Text 
orders/├── collection.dnml├── find-and-update-order.dnml├── archive-old-orders.dnml└── environments/    ├── local.json    └── staging.json
  • collection.dnml marks the folder as a DNML collection. See Collection marker.
  • Each request is a <name>.dnml file in the collection folder, not in a subfolder.
  • The request name must be the filename without the extension, and cannot be collection. See Naming rules.
  • Collection environments are JSON files in environments/. See Variables and environments.

Create a collection

  1. In Request Collections, select New collection, the + button.
  2. Enter a Collection name.
  3. Enter the parent Directory, or select Browse folders.
  4. Select Create collection.

Dynomate creates the folder with collection.dnml and watches the parent directory for changes.

A collection or request name must not be empty or end with a period. It must not contain /, \, :, *, ?, ", <, >, |, or control characters.

Open an existing collection

  1. In Request Collections, select Open collection, the folder button.
  2. Select the folder that contains collection.dnml.

The sidebar also shows the other collections in the parent folder. Migrate a legacy collection before you open its requests. See Migrate legacy collections.

Browse a collection

  • Select a collection to show its requests. Select a request to open it in a tab.
  • To open a saved request from anywhere, use Global Search.
  • An issue count, for example 2 issues, shows next to a collection with problem files.
  • To open the folder, right-click the collection and select Reveal in Finder.
  • To check the folders for changes, select Refresh collections.

Create a request

  1. Expand a collection.
  2. Select New request.
  3. Enter a Request name.
  4. Select Create request.

The request opens as a draft. Dynomate creates the file when you save.

To save a table query as a request:

  1. In the query panel, select Save to collection.
  2. Select a Collection, or select Create collection.
  3. Enter a Request name.
  4. Select Save request.

Dynomate opens a request with one Query operation. See Build a request.

Save, rename, and delete

  • Save or Cmd/Ctrl + S writes the full request to its file. Until then, the header shows Unsaved.
  • To rename a request and its file, select the name in the header.
  • Request actions, the … button, shows the file location.
  • You do not have to save before you run.
  • If you close a tab with unsaved changes, select Save, Discard, or Cancel. You cannot close a request while it runs.

To delete a saved request:

  1. Select Request actions.
  2. Select Delete request.
  3. Select Delete permanently. Dynomate deletes the file from disk. You cannot undo this.

Invalid files

  • A request with values that are not valid opens, and the fields show their errors.
  • Dynomate keeps unknown keys and lists them under Unrecognized fields. Remove them to repair the request.
  • A file with TOML errors, an unknown operation type, or a structure that the editor cannot show appears as a diagnostic.

To repair a file that has a diagnostic:

  1. Select Reveal file.
  2. Correct the file in a text editor.
  3. Select Refresh collections.