The flags argument values

The time series SQL functions that insert data have a flags argument to determine how elements are inserted.

The value of the flags argument is the sum of the flag values that you want to use.
Table 1. The values of the flags argument
Flag Value Meaning Restrictions
TSOPEN_RDWRITE 0 (Default) Indicates that the time series can be read and written to.  
TSOPEN_READ_HIDDEN 1 Indicates that hidden elements are treated as if they are not hidden. Cannot be used in combination with the following flag values:
  • TSOPEN_WRITE_AND_HIDE
  • TSOPEN_WRITE_AND_REVEAL
  • TSOPEN_WRITE_HIDDEN
TSOPEN_WRITE_HIDDEN 2 Allows hidden elements to be written to without first revealing them. The element remains hidden afterward. Cannot be used in combination with the following flag values:
  • TSOPEN_WRITE_AND_HIDE
  • TSOPEN_WRITE_AND_REVEAL
  • TSOPEN_READ_HIDDEN
TSOPEN_WRITE_AND_HIDE 4 Marks as hidden any elements that are written to a time series. Cannot be used in combination with the following flag values:
  • TSOPEN_WRITE_HIDDEN
  • TSOPEN_WRITE_AND_REVEAL
  • TSOPEN_READ_HIDDEN
TSWRITE_AND_REVEAL 8 Reveals any hidden element that is written to.  
TSOPEN_NO_NULLS 32 Prevents elements that were never allocated (TS_NULL_NOTALLOCATED) from being returned as NULL. By default, if an element is not allocated, it is returned as NULL. If this flag is set, an element that has each column set to NULL is returned instead.  
TS_PUTELEM_NO_DUPS 64 Prevents duplicate elements. By default, the function adds elements with the PutElem function If this flag is set, the function uses the PutElemNoDups function. Can be used only in the following functions:
  • BulkLoad
  • PutTimeSeries
  • PutSet
TSOPEN_REDUCED_LOG 256 Reduces how many log records are generated when you insert data. By default, every element that you insert generates two log records: one for the inserted element and one for the page header update. If this flag is set, page header updates are logged per transaction instead of per element, which improves performance. Can be used only in the following functions:
  • BulkLoad
  • InsElem
  • PutElem
  • PutElemNoDups
  • PutNthElem
  • PutTimeSeries

Functions that include this flag must be run within a transaction. The transaction can include other functions that use this flag. The transaction cannot include functions that do not use this flag or other SQL statements. The elements that are inserted are not visible by dirty reads until after the transaction commits.


Copyright© 2018 HCL Technologies Limited