Welcome
JSON compatibility
You can use the popular JSON-oriented query language created by MongoDB to interact with data stored in HCL Informix®.
HCL Informix® JSON compatibility
The Informix JSON Compatibility Guide describes how applications that use the popular JSON-oriented query language created by MongoDB can interact with data stored in HCL Informix®.
Informix® REST API
The Informix® REST API allows application developers to access data in their Informix database server through simple HTTP requests. Applications can query, insert, load, update, and delete data in relational tables, in JSON collections, or in TimeSeries tables all through simple, JSON-based REST requests.
Getting started with REST
These topics provide information on how to get started with the Informix® REST API, including configuration, authentication, and security options.
Starting the REST API
This topic provides a brief tutorial to help you get started with the Informix® REST API.

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.
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®.
- HCL Informix® JSON compatibility
  The Informix JSON Compatibility Guide describes how applications that use the popular JSON-oriented query language created by MongoDB can interact with data stored in HCL Informix®.
  - About the Informix® JSON compatibility
    You can combine relational and JSON data into a single query by using the Informix® JSON compatibility features.
  - Wire listener
    The wire listener is a mid-tier gateway server that enables communication between MongoDB clients and the Informix® database server.
  - JSON data sharding
    You can shard data with HCL Informix®. Documents from a collection or rows from a table can be sharded across a cluster of database servers, reducing the number of documents or rows and the size of the index for the database of each server. When you shard data across database servers, you also distribute performance across hardware. As your database grows in size, you can scale up by adding more shard servers to your shard cluster.
  - MongoDB API
    The Informix® support for MongoDB application programming interfaces and commands are described here.
  - Informix® REST API
    The Informix® REST API allows application developers to access data in their Informix database server through simple HTTP requests. Applications can query, insert, load, update, and delete data in relational tables, in JSON collections, or in TimeSeries tables all through simple, JSON-based REST requests.
    - About the Informix® REST API
      The REST API provides driverless access to your Informix® data.
    - Getting started with REST
      These topics provide information on how to get started with the Informix® REST API, including configuration, authentication, and security options.
      - Starting the REST API
        This topic provides a brief tutorial to help you get started with the Informix® REST API.
      - The REST configuration file
        The Informix® REST API is configured through a yaml file. This configuration file contains, among other things, settings for the connection between the REST API and the database server.
      - Authentication with REST
        HTTP clients authenticate to the Informix® REST API through HTTP Basic Authentication using a user and password known to the Informix database server.
      - Securing the REST API
        This topic covers important options for securing your Informix® REST API.
      - Logging in the REST API server
        This topic discusses logging options in the Informix® REST API server.
    - REST API syntax
      A subset of the HTTP methods is supported by the REST API. These methods are DELETE, GET, POST, and PUT.
    - Running SQL passthrough queries through REST
      You can run any SQL statement and retrieve results back using SQL passthrough queries with the REST listener.
    - Running join queries through REST
    - Troubleshooting the REST API server
      Several troubleshooting techniques, tools, and resources are available for resolving problems that you encounter with the Informix® REST API.
  - Manage time series through the wire listener
    You can create and manage time series through the wire listener. You interact with time series data through a virtual table.
  - Troubleshooting Informix® JSON compatibility
    Several troubleshooting techniques, tools, and resources are available for resolving problems that you encounter with Informix® JSON compatibility.
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.

Starting the REST API

This topic provides a brief tutorial to help you get started with the Informix® REST API.

To start the Informix® REST API:

Create a REST configuration file. You can refer to the example properties file in the Informix® APIs package.
The REST configuration file must contain a db.servers property which defines one or more Informix® for the REST API to connect to. All other configuration properties are optional.
Sample configuration file
```
# REST port number
port: 8080

# List of database servers that the REST API can connect to db.servers:
  - 
    alias: server1
    host: host1.mycompany.com
    port: 9088
  -
    alias: server2
    host: host2.mycompany.com
    port: 9088
              
# Optional, but recommended, properties to enable HTTPS
tls.enable: true
tls.keystore.type: pkcs12
tls.keystore.file: rest-keystore.pkcs12
tls.keystore.password: myPassword

# Optional, but recommended, property to enable anti-CSRF tokens
security.csrf.token.enable: true
```
Important: The db.servers property is required. This specifies the alias, host, and port number for the databases servers that HTTP clients will be able to access through the REST API.

Important: In addition to db.servers, it is recommended that you configure the TLS (HTTPS) and anti-CSRF configuration properties in order to secure your REST API when running it in a production environment. See the Securing the REST API topic for more information on how to properly secure your REST API server.
Start the REST server using the following Java™ command:
```
java -jar db-rest.jar -config rest-config.yaml
```
where rest-config.yaml is the name of your REST configuration file.
Important: The REST server requires Java 11 or higher.
By default, the REST server will write its logging information to a file named db-rest.log.