Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
HCL OneDB™ extensions and DataBlade® modulesThese topics describe how to use built-in database extensions and separately installed DataBlade® modules.
TimeSeries Data User's GuideThe HCL OneDB™ TimeSeries Data User's Guide contains information to assist you in using the TimeSeries extension with HCL OneDB™.
Time series API routinesThe time series application programming interface routines allow application programmers to directly access a time series datum.
The ts_get_metadata() function

The ts_get_metadata() function

The ts_get_metadata() function returns the user-defined metadata and its type ID from the specified time series.

Syntax

mi_lvarchar *
ts_get_metadata(ts_timeseries *ts, 
                MI_TYPEID     **metadata_typeid)

ts: The time series to retrieve the metadata from.
metadata_typeid: The return parameter to hold the type ID of the user-defined metadata.

Description

The equivalent SQL function is GetMetaData.

Returns

The user-defined metadata contained in the specified time series. If the time series does not contain any user-defined metadata, then NULL is returned and the metadata_typeid pointer is set to NULL. This return value must be cast to the real user-defined type to be useful. The value returned can be freed by the caller with mi_var_free().