Go to: Synopsis. Return value. Keywords.
Related. Flags.
MEL examples.
dataStructure [-asFile string] [-asString string] [-format string] [-name string] [-remove] [-removeAll]
dataStructure is undoable, queryable, and NOT
editable.
Takes in a description of the structure and creates it, adding it
to the list of available data structures. The structure definition
can either be supplied in the asString flag or exist in a
file that is referenced by the asFile flag. If the
remove flag is specified with a name flag then the
data structure will be removed. This is to keep all structure
operations in a single command rather than create separate commands
to create, remove, and query the data structures. When you use the
removeAll flag then every existing metadata structure is
removed. Use with care! Note that removed structures may still be
in use in metadata Streams after removal, they are just no longer
available for the creation of new Streams. Both the creation modes
and the remove mode are undoable. Creation of an exact duplicate of
an existing structure (including name) will succeed silently
without actually creating a new structure. Attempting to create a
new non-duplicate structure with the same name as an existing
structure will fail as there is no way to disambiguate two
structures with the same name. Querying modes are defined to show
information both on the created structures and the structure
serialization formats that have been registered. The serialization
formats preserve the structure information as text (e.g. raw, XML,
JSON). Since the raw structure type is built in it will be
assumed when none are specified. General query with no flags will
return the list of names of all currently existing structures.
Querying the format flag will return the list of all
registered structure serialization formats. Querying with the
format supplied before the query flag will show the
detailed description of that particular structure serialization
format. Querying the asString flag with a structure name and
serialization format supplied before the query flag will
return a string representing the named data structure in the
serialization format specified by the format flag. Even if
the format is the same as the one that created the structure the
query return string may not be identical since the queried value is
formatted in a standard way - original formatting is not preserved.
Querying the asFile flag with a structure name supplied
before the query flag will return the original file from
which the structure was generated. If the structure was created
using the asString flag or through the API then an empty
string will be returned. Querying the name flag returns the
list of all structures created so far.
| string |
Name of the resulting structure, should match the name defined
in the structure description |
| string[] |
Name(s) of the removed structures. |
In query mode, return type is based on queried flag.
metadata, component
addMetadata, applyMetadata, editMetadata, getMetadata, hasMetadata
asFile, asString, format,
name, remove,
removeAll
 Flag can appear in Create mode of
command |
 Flag can appear in Edit mode of command |
 Flag can appear in Query mode of command |
 Flag can be used more than once in a
command. |
dataStructure -q -format;
// Result: raw debug //
dataStructure -format "raw" -asString "name=NameAndID:string=name:int32=ID";
// Result: NameAndID //
// Note that this file does not exist, it is just an example of how to read
// from the file after you have created it. The file contents should look
// like this:
// name=FileBasedStructure
// string=fileInformation
dataStructure -asFile "someFile.raw";
dataStructure -q;
// Result: NameAndID FileBasedStructure //
dataStructure -name "NameAndID" -format "raw" -q -asString;
// Result: name=NameAndID:string=name:int32=ID //
dataStructure -remove -name "NameAndID";
// Result: NameAndID //
dataStructure -q;
// Result: FileBasedStructure //
dataStructure -removeAll;
// Result: FileBasedStructure //
