IBMInformix-API例程

IBMInformix-API例程

API 例程

本部分包含：

•

按任务类型列出的时间系列 API 例程

•

API 与 SQL 例程之间的对应

•

个别例程引用页面

下表显示按任务类型列出的时间系列接口例程。大写例程名称（如 TS_ELEM_NULL）表示宏。

任务类型 描述 例程名

ts_open()

ts_close()

打开和关闭时打开时间系列

间系列

关闭时间系列

返回与给定时间系列描述符关ts_get_ts()

联的时间系列的指针

创建和复制时创建时间系列

间系列

使用元数据创建时间系列

复制时间系列

ts_create()

ts_create_with_metadata()

ts_copy()

释放与使用 ts_copy() 或 ts_free()

ts_create() 创建的时间系列关联的所有内存

将一个时间系列的所有元素复ts_put_ts()

制到另一个时间系列

扫描时间系列 启动扫描

从扫描检索下一个元素

结束扫描

ts_begin_scan()

ts_net()

ts_end_scan()

查找从扫描检索的最后一个元ts_current_timestamp()

素的时间戳记

返回 ts_next() 所返回的最后ts_current_offset()（仅限一个元素的偏移量 规则时间系列）

使元素对于扫使元素不可视

描可视或不可使元素可视

视

ts_hide_elem()

ts_reveal_elem()

任务类型 描述 例程名

从时间系列选获取最接近给定时间戳记的元ts_closest_elem()

择个别元素 素

获取与给定时间戳记关联的元ts_elem()

素

获取指定位置上的元素

获取第一个元素

获取最后一个元素

ts_nth_elem())

ts_first_elem()

ts_last_elem()

查找给定时间戳记后的下一个ts_next_valid()

元素

查找给定时间戳记前的最后一ts_previous_valid()

个元素

查找给定时间戳记前或该时间ts_last_valid()

戳记上的最后一个元素

更新时间系列 插入元素

更新元素

删除元素

ts_ins_elem()

ts_upd_elem()

ts_del_elem()

将元素放在时间戳记指定的位ts_put_elem()

置

ts_put_elem_no_dups()

附加元素 ts_put_last_elem()（仅限规则时间系列）

将元素放在偏移量指定的位置 ts_put_nth_elem()（仅限规则时间系列）

修改元数据 更新元数据 ts_update_metadata()

ts_index()（仅限规则时间系列）

ts_time()（仅限规则时间系列）

在索引与时间将时间戳记转换为索引

戳记之间进行转换

将索引转换为时间戳记

变换元素 从值数组和空值数组创建元素 ts_make_elem()

ts_make_elem_rowdesc()

ts_make_elem_with_buf()

将 MI_ROW 值转换为元素 ts_row_to_elem()

任务类型 描述

将元素转换为 MI_ROW 值

例程名

ts_elem_to_row()

从 ts_make_elem() 或 ts_free_elem()

ts_row_to_elem() 创建的时间系列元素释放内存

从元素抽取列按名称从元素获取列

数据

按编号从元素获取列

ts_get_col_by_name()

ts_get_col_by_number()

将列从元素拉到

values 和 ts_get_all_cols()

nulls 数组

使用时间戳记比较两个时间戳记

创建并执行计从时间戳记获取字段

算

创建时间戳记

ts_datetime_cmp()

ts_get_stamp_fields()

ts_make_stamp()

计算两个时间戳记之间的时间ts_tstamp_difference()

间隔数

从时间戳记减去

N 个时间间隔 ts_tstamp_minus()

将

N 个时间间隔添加到时间戳ts_tstamp_plus()

记

获取元素数据查找列数

的信息

返回每个元素中包含的列数

ts_col_id()

ts_col_cnt()

获取按编号指定的列的类型信ts_colinfo_number()

息

获取按名称指定的列的类型信ts_colinfo_name()

息

确定是否隐藏元素

确定元素是否为 NULL

TS_ELEM_HIDDEN

TS_ELEM_NULL

获取时间系列获取与时间系列关联的日历的ts_get_calname()

的信息 名称

返回时间系列中的元素数

返回与时间系列关联的标志

获取容器的名称

确定时间系列是否在容器中

获取时间系列的原点

ts_nelems()

ts_get_flags()

ts_get_containername()

TS_IS_INCONTAINER

ts_get_origin()

任务类型 描述 例程名

获取与时间系列关联的元数据 ts_get_metadata()

确定时间系列是否为不规则 TS_IS_IRREGULAR

获取日历的信返回两个时间戳记之间的有效ts_cal_index()

息 时间间隔数

返回两个时间戳记之间的所有ts_cal_range()

有效时间点

返回从给定时间戳记开始的指ts_cal_range_index()

定时间戳记数

返回在给定时间戳记后给定时ts_cal_stamp()

间间隔数上的时间戳记

以下函数仅用于规则的时间系列：

•

ts_current_offset()

•

ts_index()

•

ts_nth_elem()

•

ts_put_last_elem()

•

ts_put_nth_elem()

•

ts_time()

某些 API 例程与 SQL 例程几乎相同。下表显示的是两者之间的映射。

API 例程

ts_cal_index()

ts_cal_range()

ts_cal_stamp()

ts_create()

SQL 例程

CalIndex

CalRange

CalStamp

TSCreate, TSCreateIrr

ts_create_with_metadata() TSCreate, TSCreateIrr

ts_del_elem()

ts_elem()

ts_first_elem()

ts_get_calname()

ts_get_containername()

DelElem

GetElem

GetFirstElem

GetCalendarName

GetContainerName

API 例程

ts_get_metadata()

ts_get_origin()

ts_hide_elem()

ts_index()

ts_ins_elem()

ts_last_elem()

ts_nelems()

ts_next_valid()

ts_nth_elem()

ts_previous_valid()

ts_put_elem()

ts_put_elem_no_dups()

ts_put_ts()

ts_reveal_elem()

ts_time()

ts_update_metadata()

ts_upd_elem()

SQL 例程

GetMetaData

GetOrigin

HideElem

GetIndex

InsElem

GetLastElem

GetNelems

GetNextValid

GetNthElem

GetPreviousValid

PutElem

PutElemNoDups

PutTimeSeries

RevealElem

GetStamp

UpdMetaData

UpdElem

•

ts_begin_scan() 函数

•

ts_cal_index() 函数

•

ts_cal_pattstartdate() 函数

•

ts_cal_range() 函数

•

ts_cal_range_index() 函数

•

ts_cal_stamp() 函数

•

ts_cal_startdate() 函数

•

ts_close() 函数

•

ts_closest_elem() 函数

•

ts_col_cnt() 函数

•

ts_col_id() 函数

•

ts_colinfo_name() 函数

•

ts_colinfo_number() 函数

•

ts_copy() 函数

•

ts_create() 函数

•

ts_create_with_metadata() 函数

•

ts_current_offset() 函数

•

ts_current_timestamp() 函数

•

ts_datetime_cmp() 函数

•

ts_del_elem() 函数

•

ts_elem() 函数

•

TS_ELEM_HIDDEN 宏

•

TS_ELEM_NULL 宏

•

ts_elem_to_row() 函数

•

ts_end_scan() 过程

•

ts_first_elem() 函数

•

ts_free() 过程

•

ts_free_elem() 过程

•

ts_get_all_cols() 过程

•

ts_get_calname() 函数

•

ts_get_col_by_name() 函数

•

ts_get_col_by_number() 函数

•

ts_get_containername() 函数

•

ts_get_flags() 函数

•

ts_get_metadata() 函数

•

ts_get_origin() 函数

•

ts_get_stamp_fields() 过程

•

ts_get_threshold() 函数

•

ts_get_ts() 函数

•

ts_get_typeid() 函数

•

ts_hide_elem() 函数

•

ts_index() 函数

•

ts_ins_elem() 函数

•

TS_IS_INCONTAINER 宏

•

TS_IS_IRREGULAR 宏

•

ts_last_elem() 函数

•

ts_last_valid() 函数

•

ts_make_elem() 函数

•

ts_make_elem_with_buf() 函数

•

ts_make_stamp() 函数

•

ts_nelems() 函数

•

ts_next() 函数

•

ts_next_valid() 函数

•

ts_nth_elem() 函数

•

ts_open() 函数

•

ts_previous_valid() 函数

•

ts_put_elem() 函数

•

ts_put_elem_no_dups() 函数

•

ts_put_last_elem() 函数

•

ts_put_nth_elem() 函数

•

ts_put_ts() 函数

•

ts_reveal_elem() 函数

•

ts_row_to_elem() 函数

•

ts_time() 函数

•

ts_tstamp_difference() 函数

•

ts_tstamp_minus() 函数

•

ts_tstamp_plus() 函数

•

ts_update_metadata() 函数

•

ts_upd_elem() 函数