MANAGEDATASET

Description

MANAGEDATASET helps you manage data sets. You can use the algorithm to copy, delete, rename, move, or list the files of a data set.

Parameters

Name	Type	Caption	Length	Value range
FILE*	String	Input data set to manage	1 - 192
OUTDIR	String	Name of output folder	0 - 192
NEWBASE	String	Base name of renamed data set	0 - 192
OPERATION	String	Operation to apply to input data set	0 - 192	LIST \| LS \| DIR \| COPY \| CP \| MOVE \| MV \| RENAME \| DELETE \| RM Default: LIST
OPTIONS	String	Options to apply	0 - 192

* Required parameter

Parameter descriptions

FILE

The file name of the data set to manage.

The name must be the key file, or primary file, of the entire data set.

Note: Linked PCIDSK (.pix) files created with the LINK algorithm are not supported by MANAGEDATASET. If you specify a linked PCIDSK file, the algorithm will throw an exception.

OUTDIR

When copying or moving files, the name of output folder to which to write the copied or moved data set.

Note: If any files exist in the output folder that will, potentially, be overwritten during processing, and NO_OVERWRITE is specified for OPTIONS, the algorithm will throw an exception.

NEWBASE

When renaming a data set, the base name to use for renamed files and subfolders.

Renaming applies only to formats that support renaming. If the format of the input file does not support renaming, the algorithm throws an exception.

OPERATION

The operation to apply to the input data set.

You can specify the following:

LIST | LS | DIR: Create a list of all files that comprise the data set.
When you are creating a list, the algorithm will write the list of file names to the report when you specify OPTIONS as TERSE. To have the list preceded with a header and proceeded by a footer, specify OPTIONS as VERBOSE.
COPY | CP: Copy all files that comprise the data set to the output folder.
To write the names of the source and destination files on separate lines of the report, specify OPTIONS as TERSE. To have the list preceded with a header and proceeded by a footer, specify OPTIONS as VERBOSE.
MOVE | MV: Move all files that comprise the data set to the output folder.
RENAME: Rename all applicable files in the data set.
If the format of the input file does not support renaming, the algorithm throws an exception.
DELETE | RM: Delete all files that comprise the data set, based on the list created by the LIST operation, but retain the subfolders.
To write the names of the deleted files to the report, specify OPTIONS as TERSE. To have the list preceded with a header and proceeded by a footer, specify OPTIONS as VERBOSE.
DELETE_FOLDER: Delete all subfolders of the data set, including any files they contain, and delete the folder that contains the key file.
To write the names of the deleted folders and files to the report, specify OPTIONS as TERSE. To have the list preceded with a header and proceeded by a footer, specify OPTIONS as VERBOSE.

If you do not specify a value for this parameter, LIST is applied.

OPTIONS

The option or options to apply during processing.

When specifying more than one, separate each with a space, comma, or semicolon.

To control whether to overwrite files in the output folder, you can specify the following options:

OVERWRITE: Any files existing in the output folder are overwritten.
NO_OVERWRITE | NOOVERWRITE: If any input files exist in the output folder, the algorithm throws an exception.

When you do not specify a value to overwrite files, NO_OVERWRITE is applied.

To control how the report is compiled, you can specify the following options:

QUIET: No report is created.
You can specify QUIET for any operation, except LIST. When no report-level option is specified, QUIET is applied.
TERSE: Create a brief, summary report of file names only.
VERBOSE: Create a detailed report of file names and includes header and footer information.

To control how the paths of input and output files and folders are written to the report, you can specify the following options:

ABSOLUTE: Write paths as absolute.
RELATIVE:: Write paths as relative to the current working directory.
Note: If a file cannot be made relative to the current working directory, the path is written as absolute.

When you do not specify a value to control how paths are written, RELATIVE is applied.

When you do not specify any values for OPTIONS, NO_OVERWRITE, QUIET, and RELATIVE are applied.

Details

You use MANAGEDATASET to copy, delete, rename, move, or list the files of a data set.

For example, when you want to copy a shapefile (.shp), all its associated files (.dbf, .prj, .shp, .shx) must also be copied. Run MANAGEDATASET to copy the shapefile and all associated files to the output folder you specify.

Note: Not all data set formats support all operations. When a data set is not supported, the algorithm throws an exception.

Example

In the following example, the roadseg.shp data set is copied to the roadseg-copy folder.

EASI>file="roadseg.shp"      ! input data set to copy
EASI>outdir="roadseg-copy"   ! output folder to which to copy the data set
EASI>basename=""
EASI>operation="COPY"
EASI>options="VERBOSE"       ! write detailed information to the report
EASI>run managedataset

Environments	PYTHON :: EASI
Quick links	Description :: Parameters :: Parameter descriptions :: Details :: Example :: Related