Spectre flowinfo Options
The Spectre command line flowinfo sub-command displays information about a Flow script. It has the following syntax:
spectre flowinfo <filename> [options]
The <filename> points to an existing Flow file. The <filename> can take various forms:
- If you set DI_PROJECT or pass --project as an argument, you can use a project path such as /programs/sales.flow. This format always uses forward slashes regardless of the operating system.
- If you do not set DI_PROJECT and do not pass --project as an argument, you can use a file system path. For example, use C:\di\project\sales\programs\sales.flow, or use sales.flow if the current working directory is C:\di\project\sales\programs.
For example:
spectre flowinfo /programs/sales.flow
Enter spectre flowinfo -h to display the syntax and options as shown in the following table.
Spectre flowinfo Sub-command Options
| Option | Description |
|---|---|
| --dataroot arg |
Set the path to the DiveLine server dataroot. For example: spectre flowinfo /programs/sales.flow --dataroot c:\di\solution\dl-dataroot Instead of using this option, you can set the DI_HOME environment variable. See Setting Environment Variables. |
| --project arg |
Set the project name. For example: spectre flowinfo /programs/sales.flow --project sales Instead of using this option, you can set the DI_PROJECT environment variable. See Setting Environment Variables. |
| -u [ --username ] arg | Run as the provided user. |
| -l [ --limit-rows ] arg |
Limit the number of output rows. For example: spectre flowinfo /programs/sales.flow --limit-rows 500 |
| -a [ --all-nodes ] | Report column information for all nodes in the Flow script. |
| -j [ --jobs ] arg |
Set the maximum number of threads to use when running the script. For example: spectre flowinfo /programs/sales.flow --jobs 5 Use arg to set the number of core processors (likely between 2 and 8). Start with a lower number as this depends on the I/O capabilities of the host system. |
| --test | Use testing default values for parameters. |
| --node arg |
Only show information about the named node. For example: spectre flowinfo /programs/sales.flow --node Sales Text Input |
| --properties |
Print property values. For example: spectre flowinfo /programs/sales.flow --properties |
| -p [--param ] name value |
Set a parameter. For example: spectre flowinfo /programs/sales.flow --param month 01 --param year 2015 |
| --timing |
Print timing information. For example: spectre flowinfo /programs/sales.flow --timing |
| -q [ --quiet] |
Do not print program information. For example: spectre flowinfo /programs/sales.flow --quiet |
| --human-readable |
Align columns in table output. This option is the default unless writing to a file. For example: spectre flowinfo /programs/sales.flow --human-readable NOTE: This option is intended for looking at small result sets—it is costly because of the layout required. |
Example
The following command assumes that the environment variable PATH includes the location of the Spectre executable file.
spectre flowinfo --project PRs /programs/test.flow
--dataroot c:\di\solution\dl-dataroot
This command locates test.flow in the PRs project, displays a count for how many flows are present (that is, parallel processes), nodes, and warnings.