Start here

Abstract

FairCom documentation home page

Welcome to the FairCom online documentation for developers. Start here for an overview of FairCom product features, capabilities, and developer tools.

Product overview

FairCom Edge includes FairCom MQ and FairCom DB

FairCom RTG includes FairCom DB

Product	Description
FairCom DB	FairCom DB is the FairCom database engine optimized for easy development, exceptionally low total cost of ownership, and high performance. FairCom DBprovides multiple APIs for working with data including JSON, ISAM, and record buffer APIs.
FairCom Edge	FairCom Edge is a low-code integration platform optimized for no-code integration of industrial IoT data. No programming is needed to automatically bridge across protocols including MQTT, Modbus, OPC UA, ThingWorx, SQL, and JSON. FairCom Edgealso converts binary and tabular data to and from JSON. It reshapes and enriches JSON and delivers data to and from the edge to the cloud.
FairCom MQ	FairCom MQ is a full-featured MQTT broker for mission-critical messaging. It supports MQTT 3 and 5. Additional features can be purchased individually, such as automatically transforming messages or using database queries to access data stored in messages.
ACE APIs	ACE APIs are part of FairCom’s Advanced Core Engineering (ACE) software development kit. These APIs are optimized for C and also work for C++, Java, and C#. They provide unprecedented control of the database engine allowing engineers to develop high-performance solutions such as inserting millions of records per second on mid-level hardware, that cannot be achieved by any other data technology.
FairCom RTG	FairCom RTG is a modernization solution for COBOL and Btrieve applications. It breathes new life into legacy applications by transparently swapping out the applications' built-in record management system with FairCom’s modern database engine for increased reliability, high availability, concurrent users, performance, durability, and automatic data backups. Without changing existing programs, it enables any modern system and programming language to read and write legacy data simultaneously with legacy applications.

General information

The General information section provides information that applies to all products.

Section	Description
Install FairCom products	Quick and advanced installation guides.
Error codes	Complete list of FairCom error codes.

Edge solutions

IoT system integrators

FairCom Edgeprovides system integrators with the following features that can be licensed individually or as a bundle with a product.Products

OT and control engineers

IT Edge developers

Developers

All FairCom products include the FairCom database engine. Developers can manage database data through various APIs, such as SQL, jsonAction, and ISAM APIs. Different APIs are optimized for different languages and use cases.

Each programming language in this section supports one or more of the following APIs:

JSON DB API
The JSON DB APIis optimized for easy and fast development. It uses JSON for data, queries, database objects, API calls, and so forth. It runs over all major Internet protocols including HTTP, HTTPS, WS, WSS, MQTT, MQTTS
SQL
FairCom SQL is optimized for all programmers who want to use standard ANSI SQL to query and manage data.
ISAM API
FairCom's ISAM API is optimized for C programmers who want to control all aspects of the FairCom database engine.

API type	APIs
FairCom APIs	ACE APIs, CLI, JSON APIs, JSON, jsonAction, JSON Schema, SQL
FairCom JSON APIs	JSON Admin API, JSON DB API, JSON Edge API, JSON MQ API, REST
FairCom ACE APIs	CTDB, ISAM, Low-level ACE API, Record Buffer APIs

JSON developers

FairCom’s JSON DB APIis optimized for microservices and low-code development. It uses JSON to make database development easy and fast for all programming languages. Everything is represented as JSON: data, queries, database objects, API calls, and so forth. It supports all major Internet protocols including HTTP, HTTPS, WS, WSS, MQTT, and MQTTS.

Section	Description
JSON DB API	jsonActionAPI for managing all database activities.
FairCom Edge API	jsonActionAPI for managing data integration and transformation
JSON Admin API	jsonActionAPI for connecting to the server and performing administrative tasks.
JSON replication API	Guide for creating and managing database replication.

SQL developers

Section	Description
iSQL quick start	Tutorials for using FairCom's interactive SQL command line utility (iSQL).
iSQL CLI	Guide for automating database operations using FairCom's iSQL command line utility and for importing and exporting data using variable-length and fixed-length flat files — such as CSV.
SQL reference	FairCom DBSQL language reference guide.
Full text search	Guide for using the full-text search.
SQL stored procedures	Guide for using Java and C# to implement SQL stored procedures and triggers.
JDBC quick start	Tutorials for using FairCom's JDBC driver in Java.
JDBC developer guide	Guide for using the JDBC driver with FairCom DBSQL in order to use SQL in Java applications (ideal for client-server applications that run in the same data center as the database).
ODBC quick start	Tutorials for using FairCom's Windows and Linux ODBC driver with FairCom DBSQL.
ODBC configuration	Explanation for configuring and troubleshooting ODBC for FairCom DBSQL.
SQL operations	Advanced FairCom SQL features, options, and utilities.
SQL error codes	Complete list of SQL error codes.

Java developers

Java developers should first try FairCom’s JSON DB API, which is optimized for microservices and n-tier application development.

JSON APIs for Java

Section	Description
JSON DB concepts	Guide for using the JSON DB API.
JSON DB API	Reference guide to use the JSON DB API.
jsonAction API	Core JSON API pattern that is used in FairCom APIs.
Error codes	Complete list of FairCom error codes.

SQL for Java

Section	Description
JDBC quick start	Tutorials for using FairCom's JDBC driver in Java.
JDBC developer guide	Guide for using the JDBC driver with FairCom DBSQL in order to use SQL in Java applications (ideal for client-server applications that run in the same data center as the database).
Java stored procedures	Tutorial for using Java to implement SQL stored procedures and triggers in .
SQL stored procedures	Guide for using Java and C# to implement SQL stored procedures and triggers.
SQL reference	Language elements that are common to many FairCom DBSQL statements.
Full text search	Guide for using the full-text search.
iSQL quick start	Tutorials for using FairCom's interactive SQL command line utility (iSQL).
iSQL CLI	Guide for automating database operations using FairCom's iSQL command line utility and for importing and exporting data using variable-length and fixed-length flat files — such as CSV.
SQL operations	Advanced FairCom SQL features, options, and utilities.
SQL error codes	Complete list of SQL error codes.

Advanced engineering APIs for Java

FairCom provides advanced APIs that allow low-level control over all aspects of data processing. You can build solutions that are unrivaled in capability and performance because they allow your code to directly control all aspects of the FairCom DBengine. These APIs retrieve record buffers from disk or cache and directly load them into application memory. This approach is exceptionally fast and works best for applications that run on the same computer as the FairCom DBserver.

Section	Description
Java CTDB quick start	Tutorials for working with record buffers using the JTDB API.
Java CTDB API	Reference guide for using the c-tree Database in Java — this API is called JTDB.
JPA Hibernate Tutorial	Tutorials for using the JPA and Hibernate to build Java applications using FairCom's JDTB API.
Full text search	Guide for using the full-text search.
Troubleshooting tips	Answers to common problems.
Error codes	Complete list of FairCom error codes.

Python developers

JSON APIs for Python

FairCom's JSON DB APIis optimized for easy development of microservices and n-tier applications.

Section	Description
JSON DB concepts	Guide for using the JSON DB API.
JSON DB API	Reference guide to use the JSON DB API.
Error codes	Complete list of FairCom error codes.

SQL for Python

FairCom's SQL engine is ANSI-standard. It makes it easy and fast to modify and query data.

Section	Description
Python quick start	Tutorials for using SQL with FairCom DB.
SQLAlchemy API	Guide for using SQL with FairCom DB.
SQL reference	Language elements that are common to many FairCom DBSQL statements.
Full text search	Guide for using the full-text search.
iSQL quick start	Tutorials for using FairCom's interactive SQL command line utility (iSQL).
iSQL CLI	Guide for automating database operations using FairCom's iSQL command line utility and for importing and exporting data using variable-length and fixed-length flat files — such as CSV.
ODBC configuration	Explanation for configuring and troubleshooting ODBC for FairCom DBSQL.
SQL operations	Advanced FairCom SQL features, options, and utilities.
SQL error codes	Complete list of SQL error codes.

C# developers

JSON APIs for C#

FairCom's JSON DB APIis optimized for easy development of microservices and n-tier applications.

Section	Description
JSON DB concepts	Guide for using the JSON DB API.
JSON DB API	Reference guide to use the JSON DB API.
jsonAction API	Core JSON API pattern that is used in FairCom APIs.
Error codes	Complete list of FairCom error codes.

SQL for C#

FairCom’s SQL engine is ANSI-standard. It makes it easy and fast to modify and query data.

Section	Description
ODBC quick start	Tutorials for using FairCom's Windows and Linux ODBC driver with FairCom DB.
ADO.NET API	Guide for using SQL with FairCom DB.
SQL reference	Language elements that are common to many FairCom DBSQL statements.
Full text search	Guide for using the full text search.
C# stored procedures	Tutorial for using the C# to implement SQL stored procedures in FairCom DB.
SQL stored procedures	Guide for using Java and C# to implement SQL stored procedures and triggers.
iSQL quick start	Tutorials for using FairCom's interactive SQL command line utility (iSQL).
iSQL CLI	Guide for automating database operations using FairCom's iSQL command line utility and for importing and exporting data using variable-length and fixed-length flat files — such as CSV.
ODBC configuration	Explanation for configuring and troubleshooting ODBC for FairCom DBSQL.
SQL operations	Advanced FairCom SQL features, options, and utilities.
SQL error codes	Complete list of SQL error codes.

Advanced engineering APIs for C#

FairCom provides advanced APIs that control all aspects of data processing. They allow you to build solutions that are unrivaled in capability and performance because they allow your code to directly control all aspects of the FairCom DBengine. These APIs retrieve record buffers from disk or cache and directly load them into application memory. This approach is exceptionally fast and works best for applications that run on the same computer as the FairCom DB server.

Section	Description
C# CTDB tutorial	Tutorials for working with record buffers using the JTDB API.
C# CTDB API	Guide for using the c-treeDB API in C#.
Full text search	Guide for using the full text search.
Error codes	Complete list of FairCom error codes.

C programmers

FairCom DB is an exceptional data management solution for C programmers. The APIs use record buffers, which is ideal for C applications and provides an unprecedented level of performance and control over all aspects of data management.

Advanced engineering APIs for C

Section	Description
Quick start	Tutorials for working with record buffers.
ISAM API	Developer guide to building high-speed C applications using FairCom DB.
CTDB API	Guide for the c-treeDB C API.
Full text search	Guide for using the full-text search.
Automation features	Guide for automating timestamps, aggregation, and purging.
Callback APIs	Guide for intercepting and interacting with database change events.
Data replication callback API	Guide for detecting and managing conflict resolution, data transformation, data filtering, and replicating to another database.
Low-level API tutorial	Introduction and tutorial on accessing the FairCom DBat the lowest possible level.
Microsoft Visual Studio tutorial	Guide for creating a new Microsoft Visual Studio C project using the CTDB API.
Error codes	Complete list of FairCom error codes.

SQL for C

Section	Description
Direct SQL	Guidelines for FairCom DBDirect SQL developers.
SQL reference	Language elements that are common to many FairCom DBSQL statements.
Full text search	Guide for using the full text search.
iSQL quick start	Tutorials for using FairCom's interactive SQL command line utility (iSQL).
iSQL CLI	Guide for automating database operations using FairCom's iSQL command line utility and for importing and exporting data using variable-length and fixed-length flat files — such as CSV.
ODBC quick start	Tutorials for using FairCom's Windows and Linux ODBC driver with FairCom DB.
ODBC developers guide	Guide for using an ODBC driver to connect to FairCom DB.
ODBC configuration	Explanation for configuring and troubleshooting ODBC for FairCom DBSQL.
SQL operations	Advanced FairCom SQL features, options, and utilities.
SQL error codes	Complete list of SQL error codes.

C++ programmers

FairCom DBis an excellent data management solution for C++ programmers. The APIs use record buffers, so they are ideal for C++ applications and provide an unprecedented level of performance and control over all aspects of data management.

Advanced engineering APIs for C++

Section	Description
CPP quick start	Tutorials for working with record buffers.
CPP API	Guide for using the c-treeDB C++ API.
ISAM API	Guide for building C++ applications using FairCom's ISAM and low-level APIs.
Full text search	Guide for using the full-text search.
Direct SQL	Developer guide for embedding SQL in C and C++.
C++ replication tutorial	Guide for C++ programmers to automate FairCom's data replication engine.
Microsoft Visual Studio tutorial	Guide for creating a new Microsoft Visual Studio C++ project using the c-treeDB server.
Error codes	Complete list of FairCom error codes.

SQL for C++