dataset
Usage
>> dataset [ count | maxcount | list ]
>> dataset <dataset_label> [ status | schedulelist | bytecount | datatype ]
>> dataset <dataset_label>/[<schedule_label>/]<block>
>> dataset delete <dataset_label> | all
Security
Open.
Description
This command is used to access information regarding all of the datasets stored in the instrument. Datasets contain a list of schedules to be run in a deployment. The configuration is specified at the time of enabling the instrument. A dataset is created automatically when the instrument is enabled. Datasets cannot be modified but they can be deleted.
To access general information about all of the datasets stored within the instrument use the dataset command without any arguments. The following list of parameters will be returned:
count reports the number of datasets currently stored in the instrument's memory.
maxcount reports the maximum number of datasets that the instrument can store in its memory.
list reports a list of the labels assigned to the datasets; the labels are separated by a pipe character ('|'), with no spaces. Labels are reported in the order that the datasets were created, earliest first.
>> dataset
<< dataset count=3 maxcount=20 list=DeepCove|GullCove_sep22|GullCove_oct22If there are no datasets stored in the instrument the following response will be observed.
>> dataset
<< dataset count=0 maxcount=20 list=noneTo access parameters for a specific dataset, provide the <dataset_label> as an argument to the dataset command. The following parameters are available for a given dataset:
status reports one of two values:
open, if the dataset is for a deployment currently in progress, or
closed, for a historical dataset in memory which is no longer being updated because its deployment has stopped.
schedulelist reports a list of the schedules executed during the deployment associated with the specified dataset; these labels will identify the retrievable sample storage objects. It is important to realize that after a deployment has finished, schedules may be edited, renamed or deleted; this option reports the schedules as they were when the specified dataset was started, not as they are presently defined in the logger.
bytecount reports the total amount of memory used by this dataset, in bytes. For more detailed information about how this total is broken down, use the second form of the command.
datatype reports the numerical format used for data storage in this dataset; one of float32, float64 or calfloat64; see also the storage and enable commands.
>> dataset DeepCove
<< dataset DeepCove status=closed schedulelist=tides_schedule|DO_schedule bytecount=3749498 datatype=float32The second form of the command reports read-only information about the specified dataset's usage of memory. It can be used to find out how much memory is used for sample data, events or metadata, either for the whole dataset or on a per-schedule basis. The general form of the command is:
>> dataset <dataset_label>[/<schedule_label>][/<block>]
<< dataset <dataset_label>[/<schedule_label>][/<block>] bytecount=<block_bytes> <count_key>=<count_value>...<dataset_label> is always required, and identifies the dataset of interest, For a list of available datasets, use dataset list.
<schedule_label> is optional, although at least one of <schedule_label> or <block> must be provided. If <schedule_label> is given, the reported information applies to the named schedule only. If <schedule_label> is omitted, the reported information is the sum for all schedules in the dataset. For a list of available schedules, use datasets <dataset_label> schedulelist.
<block> is optional, although at least one of <schedule_label> or <block> must be provided. If <block> is given, it must be one of the three keywords data, events, or meta; it determines the type of information retrieved for the specified schedule. If <block> is omitted, all three types of information will be reported.
data, to report memory usage for sample data.
events, to report memory usage for events.
meta, to report this schedule's memory usage for metadata.
When reporting about events or meta, a <schedule_label> should not be specified; these types of data can not be retrieved on a per-schedule basis, only for the entire deployment. Use one of <dataset_label>/events or <dataset_label>/meta.
It is important to understand that the '/' character is not just a separator; although it marks the boundaries between components, it also combines them into a single parameter. ensuring that they appear in the correct order with no other parameters in between.
The elements in the response to the command are as follows:
bytecount = <block_bytes> is always reported, and gives the size in bytes of the requested block (data / events / meta).
<count_key> = <count_value> is specific to the requested block, and gives the size in more 'natural' units than bytes:
for data, the form is samplecount = <number_of_samples>.
for events, the form is eventcount = <number_of_events>.
For metadata, there is no underlying 'natural' measure of size, so only the bytecount is reported.
>> dataset DeepCove/DO_schedule
<< dataset DeepCove/DO_schedule bytecount=3501264 samplecount=291106 eventcount=498>> dataset DeepCove/DO_schedule/data
<< dataset DeepCove/DO_schedule/data bytecount=3493272 samplecount=291106delete
Usage
>> dataset delete <dataset_label> | all
Security
Open.
Description
Datasets can be deleted using the delete action within the dataset command. A <dataset_label> must be specified as an argument to the action. Only a single dataset can be deleted at a time. The only exception to that is when the all argument is provided as the <dataset_label>. This will cause all datasets to be deleted.
>> dataset
<< dataset count=3 maxcount=20 list=DeepCove|GullCove_sep22|GullCove_oct22
>> dataset delete DeepCove
<< dataset delete DeepCove
>> dataset
<< dataset count=2 maxcount=20 list=GullCove_sep22|GullCove_oct22
>> dataset delete all
<< dataset delete all
>> dataset
<< dataset count=0 maxcount=20 list=none