Welcome
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 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.
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.
Developers Kit
The Developers Kit (DBDK) guides contain information about the tools you can use to develop and package modules, which extend the functionality of HCL Informix® databases.
DBDK InfoShelf
The Developers Kit InfoShelf is designed to help you work with BladeSmith.
Developers Kit Tutorial
The Tutorial is a set of exercises that demonstrate how to create extensions to HCL Informix® and package them as modules by using DBDK. Support for DataBlade Developers Kit (DBDK) is removed starting Informix Server 14.10.xC6.
Glossary
This section contains additional reference information
Generating code

HCL Informix® V15.0.0 documentation
Welcome to the documentation for HCL Informix® 15.0.0 and related client tools and products.
Product overview
HCL Informix® is a fast and scalable database server that manages traditional relational, object-relational, and dimensional databases. Its small footprint and self-managing capabilities are suited to embedded data-management solutions.
Installing
These topics describe how to install HCL Informix® database servers, client products, and modules.
Administering
In addition to administering the database server, you can tune performance, replicate data, and archive data.
Migrating and upgrading
You can upgrade to the 15.0.0 release of HCL Informix® or migrate from other database servers to Informix. Upgrading is an in-place migration method that uses your existing hardware and operating system software. Some changes to the Informix database server can affect upgrading from a previous release.
Client APIs and tools
You can use the HCL Informix® implementation of client APIs to develop applications for Informix database servers.
Embedding Informix®
When you embed HCL Informix®, you can use enterprise-class high-availability and high performance with embeddability features such as easy programmability, a small disk and memory footprint, and silent deployment.
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 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 modules
  These topics describe how to use built-in database extensions and separately installed modules.
- 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.
  - Programmer's Guide
    The HCL® Informix® DataBlade® API Programmer's Guide describes information about the , the C-language application programming interface (API) provided with HCL Informix.
  - Function Reference
    The IBM® Informix® DataBlade® API Function Reference describes the functions and the subset of functions that the supports.
  - Developers Kit
    The Developers Kit (DBDK) guides contain information about the tools you can use to develop and package modules, which extend the functionality of HCL Informix® databases.
    - Module Development Overview
      The HCL Informix® module overview serves as an overview of the HCL Informix module development process.
    - Developers Kit User's Guide
      The HCL Informix® Developers Kit User's Guide describes how to use tools to develop and package modules.
    - DBDK InfoShelf
      The Developers Kit InfoShelf is designed to help you work with BladeSmith.
      - Example descriptions
        This section describes the example modules provided with the Developers Kit.
      - Developers Kit Tutorial
        The Tutorial is a set of exercises that demonstrate how to create extensions to HCL Informix® and package them as modules by using DBDK. Support for DataBlade Developers Kit (DBDK) is removed starting Informix Server 14.10.xC6.
        Tutorial exercise 1: Creating a simple user-defined routine
        This exercise demonstrates how to use the tools of the -- BladeSmith and the DBDK Visual C++ Add-In--to create a module with a user-defined routine and to debug it.
        Tutorial exercise 2: Creating distinct data types and casts
        This exercise demonstrates how to create distinct data types and the casts that convert them. This exercise consists of 14 steps. It takes approximately one hour to complete.
        Tutorial exercise 3: Creating row data types
        This exercise demonstrates how to create row data types and user-defined routines that operate on them. This exercise consists of 11 steps. It takes approximately one hour to complete.
        Tutorial exercise 4: Creating opaque data types
        This exercise demonstrates how to create opaque data types, their support routines, and user-defined routines that operate on them. This exercise has 11 steps. It takes approximately one hour to complete.
        Tutorial exercise 5: Using interfaces
        This exercise demonstrates how to use interfaces to define how one module depends on another. This exercise has 16 steps. It takes approximately one hour to complete
        Tutorial exercise 6: Using smart large objects
        This exercise demonstrates how to create a module that handles smart large objects. This exercise has nine steps. It takes approximately one hour to complete.
        Glossary
        This section contains additional reference information
        BladeSmith
        BladeManager
        Makefiles
        SQL scripts
        Registration
        Special stack requirements
        MI_FPARAM argument
        boolean
        double precision
        Buffered log
        cast support function
        SQL error code
        Behavior of routines
        ESQL/C conversion function
        implicit type conversion
        mi_lvarchar data type
        Text input and output functions
        Binary send and receive functions
        Binary file import and export functions
        Text file import and export functions
        Contains large objects routines
        Type compare functions
        MI_LO_HANDLE data type
        Cost of a routine
        Generating code
        Assign() functions
        Client implementation
        fixed size
        Internal structure
        Server Implementation
        Support routines
        Routine calling options
        Related routines
        Statement local variables
        Locale
        BladePack
        Opaque data types
        Row data types
        Server compatibility
        Building a module
        Inheritance
        Distinct data types
        Casts
        Explicit cast
        mi_db_error_raise() function
        New object prefix
        mi_fp_setreturnisnull() function
        An sbspace
        Smart large objects
        Custom SQL file
        Objects dependent on SQL
        Impedance
        Pythagorean formula
        Wrapper function
        EXECUTE FUNCTION SYSBldTstSBSpace(" "); statement
        Registration failure with an sbspace test
        Object grant privileges
        Assigning a database server and test database to a project
        Debug module
        Unit test files
        Installing the DBDK Visual C++ Add-In
        IfxQuery tool
        mi_integer data type
        Routine name
        Routine signature
        mercury.txt file
        udr.c routine
        CTempAssign.c routine
        CTempCast.c routine
        DecToTemp.c routine
        FTempAssign.c routine
        FTempCast.c routine
        IntToTempCast.c routine
        rowcircle.txt file with information for creating tables and rows
        Pnt.c source code file
        Circ.c source code file
        circle.txt file with information for creating tables and rows
        interface.txt file with information for creating a table with a circle column
        Poem.c generated source file
        poem.txt file with information for creating a table with a poem column
  - J/Foundation Developer's Guide
    The HCL® J/Foundation Developer's Guide describes how to write user-defined routines (UDRs) in the Java™ programming language for Informix®.
  - R-Tree Index User's Guide
    The HCL® Informix® R-Tree Index User's Guide describes the HCL Informix R-tree secondary access method and how to access and use its components.
  - User-Defined Routines and Data Types Developer's Guide
    The HCL® Informix® User-Defined Routines and Data Types Developer's Guide describes how to define new data types and enable user-defined routines (UDRs) to extend HCL Informix.
  - Virtual-Table Interface Guide
    The IBM® Informix® Virtual-Table Interface Programmer's Guide explains how to create a primary access method with the Virtual-Table Interface (VTI) so that users have a single SQL interface to HCL Informix tables and to data that does not conform to the storage scheme of HCL Informix.
  - Virtual-Index Interface Guide
    The IBM® Informix® Virtual-Index Interface Programmer's Guide explains how to create a secondary access method with the Virtual-Index Interface (VII) to extend the built-in indexing schemes of HCL Informix typically with a module.
Data warehousing
In addition to designing and implementing Informix® dimensional databases, you can use tools to create data warehouse applications and optimize your data warehouse queries.
Designing databases
The first step in creating a relational database is to construct a data model, which is a precise, complete definition of the data you want to store. After you prepare your data model, you must implement it as a database and tables. To implement your data model, you first select a data type for each column and then you create a database and tables and populate the tables with data. You can also implement fragmentation strategies and control access to your data.
JSON compatibility
You can use the popular JSON-oriented query language created by MongoDB to interact with data stored in HCL Informix®.
Security
You can secure your Informix® database server and the data that is stored in your Informix databases. You can encrypt data, secure connections, control user privileges and access, and audit data security.
SQL programming
You can use the HCL Informix® implementation of the SQL language to develop applications for Informix database servers.
Troubleshooting HCL Informix®
Several troubleshooting techniques, tools, and resources are available for resolving problems that you encounter in your HCL Informix® database server environment.

Generating code

About this task

To generate a module in BladeSmith and open the project file in Visual C++:

Procedure

Choose Generate > .
With the node at the beginning of the file tree selected, click Generate .
After BladeSmith finishes generating code, click MSDev to start Microsoft™ Visual C++ and open the Project.dsw workspace file.

Results

BladeSmith generates the following files for your module:

Table 1. Files generated by BladeSmith
Files	Description
Makefiles	The Project.dsw file is the makefile for Windows™ and the ProjectU.mak file is the makefile for UNIX™. These files are generated in the project\src directory. See the HCL® Informix® DataBlade® Developers Kit User's Guide for instructions on compiling on UNIX™.
Source code files	On Windows™, you access these source code files through the Project.dsw file. Source code files are generated in the project\src\c directory.
Unit test files	These files contain SQL statements to test your module routines during debugging on Windows™. Unit test files are generated in the project\src\tests directory.
SQL scripts	These files are saved in the project\scripts directory.
Functional test files	These files contain SQL statements to test your module routines on UNIX™ after you finish debugging. Functional test files are generated in the project\functest directory.
Installation files	These files are used by BladePack when you package your module. Installation files are generated in the project\install directory.

For more information about the Generate DataBlade command, see the HCL® Informix® DataBlade® Developers Kit User's Guide.