Home
Extending Informix®
Beyond standard relational database objects, HCL Informix® can be extended to handle specialized data types, access methods, routines, and other objects. Informix includes many built-in extensions that are fully integrated in the database server. Informix 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 Informix.
Informix® extensions and DataBlade® modules
These topics describe how to use built-in database extensions and separately installed DataBlade® modules.
TimeSeries Data User's Guide
The Informix® TimeSeries Data User's Guide contains information to assist you in using the TimeSeries extension with HCL Informix.
Create and manage a time series through SQL
Before you can load time series data into the database, you must configure database objects specific to your time series. You can manage data storage and remove data as necessary. You can run SQL statements to create and manage time series.
Load data into a time series
You can use several methods to load data into the time series. Some methods require you to create the time series instance before you load data.
Informix® TimeSeries Plug-in for Data Studio
You can load time-based data into existing time series instances by creating load jobs in the Informix® TimeSeries Plug-in for Data Studio.
Command-line loader application
You run the command-line loader application as an argument to the eclipse command. The command-line loader application uses the parameter files from a load job that you create with the Informix® TimeSeries Plug-in for Data Studio.

Extending Informix®
Beyond standard relational database objects, HCL Informix® can be extended to handle specialized data types, access methods, routines, and other objects. Informix includes many built-in extensions that are fully integrated in the database server. Informix 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 Informix.
- Informix® extensions and DataBlade® modules
  These topics describe how to use built-in database extensions and separately installed DataBlade® modules.
  - Database Extensions User's Guide
    The Informix® Database Extensions User's Guide explains how to use the database extensions that come with HCL Informix: Large Object Locator, MQ messaging, binary data types, basic text search, node data type, and SQL packages.
  - Performing XML Publishing
    The Informix® XML User's Guide includes information about using built-in functions for XML publishing with Informix.
  - Spatiotemporal Search for Moving Objects User's Guide
    The describes how to program applications to search data from moving objects in HCL Informix® databases using the spatiotemporal search extension.
  - TimeSeries Data User's Guide
    The Informix® TimeSeries Data User's Guide contains information to assist you in using the TimeSeries extension with HCL Informix.
    - Informix® TimeSeries solution
      Database administrators and applications developers use the Informix® TimeSeries solution to store and analyze time series data.
    - Data types and system tables
      Specialized data types and system tables handle time series data.
    - Create and manage a time series through SQL
      Before you can load time series data into the database, you must configure database objects specific to your time series. You can manage data storage and remove data as necessary. You can run SQL statements to create and manage time series.
      - Example for regular data: Create and load a regular time series
        This example shows how to create a TimeSeries data type, create a time series table, create a regular time series by running the TSCreate function, and load data into the time series through the Informix® TimeSeries Plug-in for Data Studio.
      - Example for hertz data: Create and load a hertz time series
        This example shows how to create, load, and query a time series that stores hertz data.
      - Example for compressible data: Create and load a compressed time series
        This example shows how to create, load, and query a time series that stores compressed numeric data.
      - Example for JSON data: Create and load a time series with JSON documents
        These examples show how to create, load, and query a time series that stores JSON data.
      - Defining a calendar
        A time series definition must include a calendar. A calendar includes a calendar pattern, which can be defined separately or within the calendar definition.You can create a calendar or choose a predefined calendar.
      - Create a time series column
      - Creating containers
        Containers are created automatically when they are needed, in the same dbspaces in which the table is stored. If you want to store your time series data in other dbspaces, you can create containers. You can move containers between container pools. You must create containers if you want to replicate time series data with Enterprise Replication or create rolling window containers.
      - Create a time series
        You can use several methods to create an instance of a time series, depending on whether there is existing data to load and, if so, the format of that data.
      - Load data into a time series
        You can use several methods to load data into the time series. Some methods require you to create the time series instance before you load data.
        Informix® TimeSeries Plug-in for Data Studio
        You can load time-based data into existing time series instances by creating load jobs in the Informix® TimeSeries Plug-in for Data Studio.
        Creating a load job to load data from a file
        Use the Informix® TimeSeries Plug-in for Data Studio to create a load job that loads time-based data from a file into existing time series instances.
        Create a load job to load data from a database
        Use the Informix® TimeSeries Plug-in for Data Studio to create a load job that loads time-based data from a database into existing time series instances.
        Running a load job from the command line
        After you create a load job in the Informix® TimeSeries Plug-in for Data Studio, you can run the load job from the command line with the command-line loader application. The command-line loader application is useful if you want to load data without using the Data Studio or Eclipse user interface. The command-line loader requires a minimal Eclipse platform.
        Command-line loader application
        You run the command-line loader application as an argument to the eclipse command. The command-line loader application uses the parameter files from a load job that you create with the Informix® TimeSeries Plug-in for Data Studio.
        Writing a loader program
        You can write a program to load time series data by using time series SQL routines.
        Methods for loading JSON data
        The method that you use to loading JSON data depends on whether your data is entirely in JSON documents and the source of the data.
        Loading data from a file into a virtual table
        Data that you insert into a virtual table is written to the underlying base table. Therefore, you can use the virtual table to load your data that is in a relational format in a file into a TimeSeries column. Often it is easier to format your raw data to load a virtual table than to load a TimeSeries column directly, especially if you must perform incremental loading.
        Load data with the BulkLoad function
        You can load data into an existing time series with the BulkLoad function. This SQL function takes an existing time series and a file name as arguments. The file name is for a file on the client that contains row type data to be loaded into the time series.
        Load small amounts of data with SQL functions
        You can load individual elements or sets of elements by using time series SQL functions.
      - Performance tips for time series
        You can improve the performance of loading and querying time series data with the following guidelines.
      - Delete time series data
        You can delete time series data to remove incorrect data or to remove old data.
      - Manage packed data
        You can insert, delete, and select packed data.
    - Virtual tables for time series data
      A virtual table provides a relational view of your time series data.
    - Pattern matching searches
      You can search time series data for matches to a particular pattern of values. For example, after you identify a pattern of abnormal electricity usage that indicates an outage, you can search for matches to that pattern to find other outages. Pattern matching searches find matches to a pattern that you supply. Pattern matching searches do not discover patterns in time series data.
    - Advanced analytics
      Advanced analytics functions provide specialized methods of analyzing time series data for patterns or abnormalities.
    - Calendar pattern routines
      You can use calendar pattern routines to manipulate calendar patterns.
    - Calendar routines
      You can use calendar routines to manipulate calendars.
    - Time series SQL routines
    - Time series Java™ class library
      You can use the time series Java™ class library to create and manage a time series from within Java applications or applets.
    - Time series API routines
      The time series application programming interface routines allow application programmers to directly access a time series datum.
    - Appendixes
  - Web DataBlade Module
    Use the Web DataBlade® module to create web applications that incorporate data that is retrieved dynamically from the HCL Informix® database.
- Creating extensions
  You can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in Informix® databases.

Command-line loader application

You run the command-line loader application as an argument to the eclipse command. The command-line loader application uses the parameter files from a load job that you create with the Informix® TimeSeries Plug-in for Data Studio.

Syntax

./eclipse -application com.ibm.informix.timeseries.loader \
          -recordReader=RecordReader_file \
          -table=Table_file.tbl \
          -map=Map_file.fcmap \
          -connection=Connection_file.xml \
          -properties=LoadProps_file.tslp

RecordReader_file

The name of the file that contains the record reader definition, including the database connection information, if necessary. The file extension depends on from where the data is loaded:

.udrf = User-defined record format. The data is loaded from a file.

.drr = Database record reader. The data is loaded from a database.

Table_file

The name of the file that contains the table definition.

Map_file

The name of the file that contains the mapping definition.

Connection_file

The name of the file that contains the Informix® database connection profile.

LoadProps_file

The name of the file that contains the load properties.

Usage

Use the command-line loader application to load time series data into a TimeSeries column. The Eclipse Platform Runtime Binary, or a larger Eclipse program, the TimeSeries plug-in, and the load files that are generated by the TimeSeries plug-in are required.

You can load time series data in parallel by running multiple loader applications simultaneously.

As the data is loaded, statistics about the data are printed to the console. When the load job is complete, cumulative statistics are printed.

Example

The following command starts a load job that specifies the files that are named for loadjob1:

./eclipse -application com.ibm.informix.timeseries.loader \
          -recordReader=customer1.udrf \
          -table=loadjob1_table.tbl \
          -map=loadjob1_map.fcmap \
          -connection=loadjob1_conn.xml \
          -properties=loadjob1_prop.tslp