Tell commands - D2000 Archiv

BACKUP [path]

Creates an archive database backup. If the parameter path is not specified, the backup will be performed in the directory specified by the configuration parameter BackupPath.
Note: This command is supported for Sybase SQL Anywhere only. To back up Oracle/PostgreSQL/MS SQL databases, use their respective utilities.

Executes recalcs of old values, which were redirected to the auxiliary calc task (see the RecalcImmediateDepth archive parameter), and then, instead of being performed, they were stored in the file (see the DropOldRequests archive parameter). If path+filename is not specified, the file name_ARCHIV_DROPPED_CALCS.DAT will be processed by name.ARC and then renamed to name_ARCHIV_DROPPED_CALCS.DONE (if such a file exists, it will be deleted).

Note: This command fails if the archive parameter DropOldRequests has a value of 1 because, in this case, the recalcs would be again stored to the file after being read.

A command that must be run after the change of the DataTableSlices parameter from value 1 to value 2 (i.e., after changing the time slices mode to time slices for structured archives only).
The archive will transfer the archived values from time slices of simple archives to the original data tables, and these time slices will be deleted.
Note: For simple archives, from the start of the archive till the transfer of archived values to the original data tables, the archive will provide only data that is located in the original data tables. Therefore, this conversion is recommended only for systems with redundant archives, and the archive performing the conversion should be set as a passive instance.

The command will perform time slice compression when TimescaleDB is active. The chunk of the time slice of a specific object (HOBJ) or objects with the specified mask that match the specified time (format is 'dd-mm-yyyy hh:mi') will be compressed. If the FORCE parameter is specified, the already compressed time slices will be recompressed. Without the FORCE parameter, only uncompressed chunks will be compressed.
Example: COMPRESS_TSDB H.Sec* "02-02-2026 00:00"

CRC path\filename mask from to [step] [PO]

Parameter checks the identity of data in instance archives. Creating the file with a CRC (checksum) for archive objects that correspond to the mask for the entered time period.
The optional parameter step (in hours) allows dividing the calculation for a time period into intervals.
The PO parameter ensures the calculation will be executed only for primary archive data.

CRC_TREE path\filename name row col from to [step]

Parameter checks the identity of data in instance archives. Creating the file with CRC (checking sum) for archive objects that correspond to the mask for the entered time period.
The calculation will be realized for the object that has been defined by the parameter "name row col" and for all objects that influence its value.
The optional parameter step (in hours) allows dividing the calculation for the time period into intervals.
See the note to the CRC command.

DEL mask [row [col]][before]

Physically delete data from the archive database of objects specified by a mask and optionally by row/column number as follows:

• The parameter before is not defined - for individual archive objects, all data older than the history depth (the parameter History depth) defined in the objects' configuration will be deleted.

• The parameter before is defined - all data with timestamps older than defined by the parameter before will be deleted.

Time format is "dd-mm-rrrr hh:mi:ss.mss".
Example:
DEL H.Sec "01-01-2010 00:00:00.000" 
DEL H.MyStructCol 3 "01-01-2010 00:00:00.000"
DEL H.MyStruct 3 2 "01-01-2010 00:00:00.000"

Deletes data from the archive database without activating dependent statistics evaluation (similar to the action  DELETEARCHDATA).
Time format is "dd-mm-rrrr hh:mi:ss.mss".
Example:
DELETE_DATA H.Sec "01-01-2010 00:00:00.000" "01-01-2010 00:00:01.000"
DELETE_DATA H.MyStructCol 3 "01-01-2010 00:00:00.000" "01-01-2010 00:00:01.000"
DELETE_DATA H.MyStruct 3 2 "01-01-2010 00:00:00.000" "01-01-2010 00:00:01.000"

DI ON/OFF [maska [row [col]]]

Debug Info - shows/hides internal debug information of the D2000 Archiv process (in the process window and in the D2000 Sysconsole process).

Debug Info for values - enables/disables displaying information about the evaluation of historical values with the specified HOBJ or with the name matching the given mask. For structured historical values, you can specify the required structure item, for column (if ROW=0) or row (if COL=0).

Example:
DP ON H.Test1 3 4 - enables debug information for the item of structured historical value H.Test1 on row 3 and column 4
DP ON H.Test2 - enables debug information for historical value H.Test2 (for all items if the object is a structure)
DP OFF 1234 0 4 - disables debug information for the whole column 4 in the structured historical value with HOBJ=1234

By default, debug information shows just the time and the value of historical value. Enabling the debug category DBG.ARCHIV.DATA (in the process D2000 System Console or using the start parameter /E+DBG.ARCHIV.DATA when starting the process D2000 Archiv) allows showing the complete data being archived, which is meant primarily for the D2000 System developers:
Time (archive value time)
Value (value)
Status (a True/False array containing Valid, ProcAlarm, NoAckPAlarm, PrAlSilent, Weak, NoAckValue, Transient, Default, Manual, AlCrit, Unknown values)
Limits (one of the value of InLimit, VL_Limit, L_Limit, H_Limit, VH_Limit, LimitsProblem)
ArchFlags (a True/False array containing Start, Stop, Block, UnBlock, Deleted, UserModify, OldVal, ProcesModify, LoadData, MONO_TIME, K, L, M, N, O, Ver1 values)

DI ONREC/OFFREC HOBJ/mask [ROW [COL]]

Debug Info for values - recursive. The command extends the functionality of the previous commands with the possibility of showing/hiding the debug information for historical values that depend on specified historical values (e.g., minute averages).

Sybase platform: The parameter path+trezor_name specifies the path and the name of the depository database to dismount. The * and ? characters for mask definition can be used in the depository database name. If more files match the entered mask, all these ones will be dismounted.

For more information, see the topic Online access to data from depository databases.

Oracle platform: The parameter Id or trezor_name defines the number (name) of the depository database to dismount.
The name of the depository database is the name of the depository tablespace (e.g., MYAPP_TS_TREZOR15 or MYAPP_TS_TREZOR15_02) or the name of the tablespace's datafile (e.g., MYAPP_TS_TREZOR0015_S02_20040801.ORA).
You can also dismount all depository databases (except the ones that are currently being filled) by using the parameter all. The parameters IdFrom and IdTo allow dismounting a sequence of depository databases.
The parameter SEGMENT seg (where seg is the number of the depository database segment) allows dismounting just the segment. Seg is the number between 0 and TrezorCountSegments. If the DISMOUNT_TREZOR command is used without the SEGMENT Seg parameter for a depository database with segments enabled, the process  D2000 Archiv attempts to dismount all segments of the specified depository database/s.

For more information, see the topic Online access to data from depository databases.

PostgreSQL platform: The parameter Id defines the number of depository databases to dismount.
You can also dismount all depository databases (except the ones that are currently being filled) by using the parameter all. The parameters IdFrom and IdTo allow dismounting a sequence of depository databases.
The parameter SEGMENT seg (where seg is the number of the depository database segment) allows dismounting just the segment. Seg is the number between 0 and TrezorCountSegments. If the command DISMOUNT_TREZOR  is used without the parameter SEGMENT Seg for depository database segments enabled, the process D2000 Archiv attempts to dismount all segments of the specified depository database/s.

For more information, see the topic Online access to data from depository databases.

DP ON/OFF

Debug Pipe - shows/hides the course of communication with D2000 Server (only if the process window is displayed on the desktop).

Creates the file (defined by the parameter path+filename) containing SQL commands to delete tables that are not used by the archive configuration. If the time slices are enabled, the file will also contain the commands to delete respective rows of the table ARC_SLICE, which contain information about the time slices corresponding to tables that are to be deleted.

Manual loading of archive cache (only available for isochronous cache mode) by reading values from the archive database.
Archive cache loading can also be automatic after startup - for more information, see the description of parameter IsoCacheAutoFill.

For the selected object(s), their ClearTime is set to a value of several hours in the past, which means that a periodic delete of the object's data should occur shortly - within a minute (unless it is disabled for some reason, e.g., if the time slices are enabled, it can depend on parameters DeleteInSlice0 and DeleteInSlices).

The FREEZE command causes the writing and calculating tasks of the archive to stop processing the requests for a period of freeze_seconds. Within this time, another task (deleting) will list the number of requests (primary and calculated) in the queues. After the elapse of the freeze_seconds time, the processing of values will be restored. If the report_seconds parameter is entered, the deleting task continues to list the number of requests in the queues for this period.
The FREEZE command is primarily used for performance tests (testing the maximum speed for processing the requests under load). Before its use, you should realize that it does not influence reading from the archive, but during its execution, the writing to the archive (so the newest values are not available when reading), and the calculations are not executed for the freeze_seconds period. In redundant systems with 2 or more archives, we recommend executing the FREEZE command on a passive instance, so that the functionality of the archiving subsystem will not be affected.
UNFREEZE command (without parameters) is used for aborting inactivity that was caused by the FREEZE command.

The parameter allows showing the list of depository databases used by the process D2000 Archiv. The contents of the list depend on the used platform - Sybase, PostgreSQL, or Oracle.
Parameter id:

• for Sybase - name of a depository database

• for Oracle - numerical identifier of the depository tablespace

• for PostgreSQL - numerical identifier of the depository database

LOAD_TREZOR path+filename [mask] [from] [to]

Online depository database import (Sybase only)

Sybase platform: The path+depository_name parameter defines the path and name of the depository database to be mounted. The name may contain "*" and "?" characters to define a mask. If more files match the specified mask, all of them will be mounted.

For more information, see the topic Online access to data from depository databases.

Oracle platform: The parameter Id (trezor_name) defines the number (name) of a depository database to be mounted.
The name of the depository database is the name of the depository tablespace (e.g., MYAPP_TS_TREZOR15 or MYAPP_TS_TREZOR15_02) or the name of the tablespace's datafile (e.g., MYAPP_TS_TREZOR0015_S02_20040801.ORA). 
The IdFrom and IdTo parameters allow mounting a sequence of depository databases.
The SEGMENT Seg parameter (where Seg is the number of the depository database segment) allows mounting a single depository database segment. If the MOUNT_TREZOR command is used without the SEGMENT Seg parameter for a depository database with segments enabled, the process  D2000 Archiv attempts to mount on all segments of the specified depository database/s. 
The parameter Write can be used to mount the depository database (s) for writing (for depository database synchronization through the Arcsynchro tool).

For more information, see the topic Online access to data from depository databases.

PostgreSQL platform: The parameter Id specifies the number of a depository database to be mounted. The parameter SEGMENT Seg (where Seg is the number of the depository database segment) allows mounting a single depository database segment. If the MOUNT_TREZOR command is used without the SEGMENT Seg parameter for a depository database with segments enabled, the process  D2000 Archiv attempts to mount on all segments of the specified depository database/s. 
The parameter Write can be used to mount the depository database (s) for writing (for depository database synchronization through the Arcsynchro tool).

For more information, see the topic Online access to data from depository databases.

OPTIMIZE_QUEUE

Reduction of the number of calc requests in the archive queue. If, for some reason, the number of requests in the archive queue has increased (for example, due to the arrival of old values from the communication), this TELL command can reduce duplicate requests.

Creates a file containing the descriptions of pending requests.

Recalculates the values in the statistical and calculated archives.
Mask - defines the list of objects that will be recalculated. If the specific row and/or column of the structured archive is recalculated, it is possible to specify parameters Row and Col (if unspecified, their default value is 0, meaning "whole row/column").

The parameters <From, To> define a time interval to be recalculated. If the end time is not entered, the current time will be used. Time format is dd-mm-yyyy [hh[:mi[:ss[.mss]]]].
The optional parameter BACKGROUND enables the recalculation to be performed by an auxiliary calculation task (see the archive parameter RecalcImmediateDepth). The parameter is recommended for long-term recalculation of historical values, which should be performed in the background while the archive continues to archive real-time data.

The following optional parameters specify the calculation mode:

• The NODEPEND parameter causes dependent statistical and calculated archive objects not to be recalculated. By default, dependent objects are recalculated (to maintain data consistency).

• The FORCE parameter causes dependent statistical and calculated archive objects to be always recalculated, even if the calculation of their source archives ends with no changed data (see the RecalcOptimize archive parameter). This parameter is used to consolidate an archive database that contains inconsistent data.

• The FORCEONDEMAND parameter causes dependent statistical and calculated archive objects that have calculation on demand set to be recalculated, even if the calculation of their source archives ends with no changed data (see the RecalcOptimize archive parameter).

• If none of these parameters are specified, dependent statistical and calculated archive objects will also be recalculated, with calculation optimizations applied depending on the archive parameters RecalcOptimize and IsochronousCache.

The VERBOSE parameter turns on auxiliary debugging information about individual calculations.

Note: If the parameter RecalcTimeIntervalLimit has a non-zero value and the time interval <From, To> is longer than RecalcTimeIntervalLimit hours, the parameter BACKGROUND is mandatory to ensure that the recalculation will be performed by auxiliary calc. This behavior is implemented as a protection against overloading the main tasks by recalculations.

Premature disconnection of the current depository database.

The command is used to force the reading of the last values of the specified objects from the archive database. Objects can be specified by name/mask and by type:

• SCRIPT - script

• PRIMARY - primary archive objects

• STATISTIC - statistical archive objects

• EVAL - calculated archive objects

• ALL - all types of archive objects

If e.g. in the test environment, the insertion of values of script-filled archives is not possible, but these are inserted into the archive database by the arcsynchro utility, it is possible to execute this command after the insertion is completed (e.g., RELOAD_VALUES * STATISTIC). Subsequently, a read (e.g., of all script-filled archive objects) is performed, and recalculations of archive objects that depend on the read objects can be initiated.

If the time slices are activated, the command causes the archive to review all time slices of simple archive objects according to the defined HOBJ or mask and to delete the time slices without data.
The command is used to clean up the archive database from empty time slices that were created due to an error in the archive. This error was repaired in the supported versions on June 8, 2015.

Online reorganization of the archive database. The command compacts all archive tables (same as the Oracle command ALTER TABLE MOVE or the Sybase command REORGANIZE TABLE INDEX or the PostgreSQL command VACUUM - see the PG_ReorganizeSlice parameter).

Note: For Oracle, PostgreSQL, and Sybase 8.0 (and above) platforms only.

Online reorganization of the archive table of an object with a specified HOBJ or with a name matching the specified mask. If the parameter tablespace is also defined, the given archive table will be moved to the specified tablespace. If time slices are on, all slices of one archive object will be reorganized/moved unless a slice number (slice) is specified.

Note 1: The parameter tablespace can be used on Oracle and PostgreSQL platforms only.
Note 2: The slice number, except for ordinary values, supports special values:

• value -1 means "all slices"

• value -2 means "slice for current time"

• value -3 means "previous time slice"

• value -4 means "all slices older than the current time slice"

• value -5 means "only those archive objects that do not have time slices" (if time slices are configured only for structured archives, then only simple ones will be reorganized)

REORGANIZE ON

Enables the reorganization of the archive database (same as running the process D2000 Archiv with the /DBCY parameter).

REORGANIZE OFF

Enables the reorganization of the archive database (same as running the process D2000 Archiv without the /DBCY parameter).

REORGANIZE ACTIVE

Enables the reorganization of the archive database in the active mode only (same as running the process D2000 Archiv with the /DBCA parameter).

REORGANIZE PASSIVE

Enables the reorganization of the archive database in the passive mode only (same as running the process D2000 Archiv with the /DBCP parameter).

REORGANIZE SHRINK

Enables the alternate mode of the reorganization of the archive database - only for Oracle 10g and above (same as running the process D2000 Archiv with the /DBCS parameter).
Note: To enable the original mode, use the REORGANIZE MOVE command.

REORGANIZE TableRowLimit rowLimit

Online change of the parameter ReorganizeTableRowLimit is used for the automatic reorganization of the archive database.

REORGANIZE TableTimeLimit timeLimit

Online change of the parameter ReorganizeTableTimeLimit is used for the automatic reorganization of the archive database.

SAVE_SLICES

The command saves the time-slice configuration to tables in the archive database (AS_yymmdd_hhmiss and AS_DI_yymmdd_hhmiss) due to the importance of this meta-information in the event of corruption.

The command allows the user to change the dynamic cache size to speed up the calculation of statistical historical values while the process D2000 Archiv is still running.

Note 1: The initial cache size can be specified by the parameter MaxCacheSize in the process D2000 Application Manager.
Note 2: The command SET_CACHE also changes the value of the parameter MaxCacheSize in the registry.

The SET_OPTION command controls the following configuration and start-up parameters of the process D2000 Archiv:

Note: For parameters that are stored in the Registry database, the SET_OPTION command will change the value of configuration parameters not only in the archive but also in the Registry database.

Shows dynamic information on the specified object (current value, last sent value, time of next calculation for periodically archived objects, time of periodic deleting, parameters, and content of cache) on the text console of the D2000 Archiv process.

Note: The command is mainly intended for D2000 system diagnostic purposes.

If the archive cache is enabled, the result is a list of top count historical values having the most values in the archive cache.
For every value, the following properties are displayed: HOBJ, name, number of items, and time interval of values in the archive cache.

Shows configuration information of the process D2000 Archiv and the archive database.
This information covers:

• start parameters of the process specified in the configuration of the archive process (if the archive process is run by the process  D2000 Server), or archive service (if the archive process is run by its own watchdog), or command-line parameters (if the archive process is run manually),

• parameters for the archive specified in the Windows registry,

• parameters stored directly in the archive database in the LOG_DATA table (see the parameter /CLD of arcsynchro utility),

• specific parameters of the database (currently only for the Oracle platform).

Note: By comparing information obtained by this TELL command, it is possible to find out whether the redundant archives are configured identically or if any parameter was omitted during the migration of the archive, database, etc.

Shows various information about the D2000 Archiv process and the archive database.

Creates a file path+filename with statistical information, i.e., the number of values ​​for individual historical values over the last n hours, or over the time interval <from, to>.
The format of the "from","to" parameter is "dd-mm-yyyy hh:mi:ss.mss", the date part is mandatory.
The path+filename file will be created by the D2000 Archiv process, so its naming is OS-dependent (e.g., D:\stat.txt on Windows, /tmp/stat.txt on Linux).

Createa a file path+filename with statistical information about TimescaleDB compressed chunks. For each historical object, the original data size and the data size after compression are listed.
Note: The listing does not show the size of the data in uncompressed chunks.

The command redirects the standard output to a new output.

Example:
D2000 on OpenVMS platform: STDOUT "_TNA2:" (output is redirected to the terminal _TNA2:)
D2000 on Windows platform: STDOUT C:\output.txt (output is redirected to the file output.txt)
Note: If a D2000 process is running on the Windows platform as a service, the console output is disabled. Therefore, if this functionality is required, it is necessary for a D2000 process to be started by the D2000 Server without /X parameter.

Deactivates a feature of the process D2000 - import of external data.

STOP [NOQUEUE]

Stops the process D2000 Archiv. All unsaved values from the request queue are to be automatically stored on the disk, and during the next start of the process, the values will be read from the disk. The current values of historical values are to be stored in the table SAVED_LAST_ROWS to quicken the next start of the process.
If the NOQUEUE parameter is used, the unsaved values from the request queue will not be stored in the file (it speeds up stopping the process with a large number of unprocessed values).

TIMESTAT START
TIMESTAT RESTART
TIMESTAT SHOW
TIMESTAT SHOWLONG
TIMESTAT SHOWSTART
TIMESTAT STOP

Starts (START), stops (STOP), restarts (RESTART), shows (SHOW), shows and restarts (SHOWSTART), or shows the time statistics of reading task(s) in long time format, including the days (SHOWLONG). After starting the statistics, the database reading task(s) will start measuring the time spent in various parts of the reading procedure. These values can be used for tuning by system specialists. Time statistics are displayed per reading task, and if ReadThreadsCount > 1, also totals for all read tasks are shown.
Note: When time statistics are on, reading from the archive may be several per cent slower due to time measuring.

PostgreSQL platform: The command is used to compress the data of existing depository databases. See the Depository Data Compression chapter for more information.

The Id parameter specifies the number of a depository database whose data is to be compressed. The SEGMENT seg parameter, where seg is the number of the depository database segment (between 0 and TrezorCountSegments), allows you to compress a specific depository segment if depository segment creation is enabled.
Note: The compression of a depository is possible if it is mounted for writing (see MOUNT_TREZOR command with WRITE parameter).

PostgreSQL platform: The command is used to decompress the data of existing depository databases. See the Depository Data Compression chapter for more information.

The Id parameter specifies the number of a depository database whose data is to be decompressed. The SEGMENT seg parameter, where seg is the number of the depository database segment (between 0 and TrezorCountSegments), allows you to compress a specific depository segment if depository segment creation is enabled.
Note: The decompression of a depository is possible if it is mounted for writing (see MOUNT_TREZOR command with WRITE parameter).