Home
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.
Wire listener
The wire listener is a mid-tier gateway server that enables communication between MongoDB, REST API, and MQTT clients and the Informix® database server.
Wire listener command line options
You can use command line options to control the wire listener.
Running multiple wire listeners
You can run multiple wire listeners.

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, REST API, and MQTT clients and the Informix® database server.
    - Configuring the wire listener for the first time
      You must configure the wire listener by specifying an authorized user and customizing the wire listener configuration file.
    - The wire listener configuration file
      The settings that control the wire listener and the connection between the client and database server are set in the wire listener configuration file.
    - Wire listener command line options
      You can use command line options to control the wire listener.
      - Starting the wire listener
        You can start the wire listener for the MongoDB API, the REST API, or the MQTT protocol, by using the start command.
      - Running multiple wire listeners
        You can run multiple wire listeners.
      - Stopping the wire listener
        You can stop the wire listener by using the stop command.
      - Wire listener logging
        The wire listener can output trace, debug, informational messages, warnings, and error information to a log.
    - User authentication with the wire listener
      You can authenticate users through the wire listener with MongoDB authentication or with the database server, through a pluggable authentication module (PAM).
    - Encryption for wire listener communications
      You can use Secure Sockets Layer (SSL) protocol to encrypt communication for the wire listener.
    - High availability support in the wire listener
      The wire listener provides high availability support.
  - 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 and commands
    The Informix® support for MongoDB application programming interfaces and commands are described here.
  - REST API
    The REST API provides a method for accessing JSON collections in Informix® and provides driverless access to your data.
  - MQTT protocol
    The MQTT protocol provides a method for loading JSON data in Informix®.
  - 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.

Running multiple wire listeners

You can run multiple wire listeners.

About this task

By running multiple wire listeners, you can use a combination of the APIs that are supported by the wire listener: MongoDB, REST, and MQTT. Create a configuration file for each listener type that you want to run. For example, you can create a configuration file for the MongoDB API and a configuration file for the REST API or the MQTT protocol. You can start all wire listeners with the same start command by providing multiple -config arguments.

Procedure

Create the individual configuration files in the $INFORMIXDIR/etc directory. You can use the $INFORMIXDIR/etc/jsonListener-example.properties file as a template.
Customize each configuration file and assign a unique name.
Important: The url parameter must be specified, either in each individual configuration file or in the file that is referenced by the include parameter.
1. Specify the include parameter to reference an additional configuration file. The path can be relative or absolute. If you have multiple configuration files, you can avoid duplicating parameter settings in the multiple configuration files by specifying a subset of shared parameters in a single configuration file, and the unique parameters in the individual configuration files.
Start the wire listeners.

Example: Running multiple wire listeners that share parameter settings

In this example, the same url, authentication.enable, and security.sql.passthrough parameters are used to run two wire listeners:

Create a configuration file named shared.properties that includes the following parameters:

url=jdbc:informix-sqli://localhost:9090/sysmaster:
INFORMIXSERVER=ol_informix1210;
authentication.enable=true
security.sql.passthrough=true

Create a configuration file for use with the MongoDB API that is named mongo.properties, with the parameter include=shared.properties set:
```
include=shared.properties
listener.type=mongo
listener.port=27017
```
Create a configuration file for use with the REST API that is named rest.properties, with the parameter include=shared.properties set:
```
include=shared.properties
listener.type=rest
listener.port=8080
```
From the command line, run the start command. Include separate -config arguments for each wire listener API type.
```
java -jar $INFORMIXDIR/bin/jsonListener.jar
-config json.properties
-config rest.properties -start
```