Guided Tour
Categorical guide to FairCom documentation
This section is a guided tour through FairCom documentation. It helps you find information by product, programming language, and the type of user, such as developer or administrator. You can use this topical guide when a search does not take you where you want to go.
Get started in 5 minutes
Product | Description |
|---|---|
FairCom DB is the FairCom database server optimized for easy development, low total cost of ownership, and high performance. FairCom DB provides multiple APIs for working with data, including JSON, ISAM, and record buffer APIs. It also provides multiple database engines that you can embed in your software. It also can replicate data to other FairCom products and notify external systems of data change events. | |
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, EtherNet/IP, OPC UA, ThingWorx, SQL, REST, 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 is a full-featured MQTT 3 and MQTT 5 compliant MQTT broker for mission-critical messaging. Its embedded database and transform engines allow it to change and persist message payloads. You can use database queries to access historical and current data stored in messages. It is also an essential part of FairCom DB Notify , used by FairCom DB and FairCom RTG to deliver JSON data change messages to external systems. | |
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. |
The General information section provides information that applies to all products.
Section | Description |
|---|---|
Quick and advanced installation guides. | |
Complete list of FairCom error codes. |
FairCom Edgeprovides system integrators with the following features that can be licensed individually or as a bundle with a product.
Category | Features | ||||||
|---|---|---|---|---|---|---|---|
JSON APIs |
| ||||||
Browser-based web applications |
| ||||||
Automatic protocol bridging with transforms | |||||||
Easy, fast, no-maintenance JSON database engine with SQL | |||||||
Full-featured, MQTT 3 & 5 broker for mission-critical messaging | |||||||
| |||||||
| |||||||
|
IT developers can integrate with FairCom products using JSON APIs, SQL, and MQTT messages:
Developers write applications, web services, and scripts to query data using FairCom's JSON APIs. They also use MQTT to subscribe to topics and receive messages published to those topics.
Cloud engineers use MQTT cloud services, such as AWS IoT Core and Azure IoT Hub, to subscribe to topics and receive messages published to those topics.
Data engineers query data and create ETL jobs using standard SQL, ODBC, and JDBC drivers.
Tip
MQTT messages are a great way to push information to another system. MQTT messages can include telemetry data, critical alerts, status updates, notifications, and commands.
All FairCom products include the FairCom database engine. Developers can manage database data through various APIs. Different APIs are optimized for different languages and use cases:
Use the JSON DB API for easy, fast development in all languages using JSON queries and JSON data.
Use SQL for joins, ad hoc queries, and analytics.
Use the CTDB record buffer API for easy, fast data processing.
Use the ISAM record buffer API to control every aspect of data processing at unmatched speed.
API summary
FairCom’s JSON DB APIis optimized for client-server, 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, and WSS.
Section | Description |
|---|---|
jsonActionAPI for managing all database activities. | |
jsonActionAPI for managing data integration and transformation | |
jsonActionAPI for connecting to the server and performing administrative tasks. | |
Guide for creating and managing database replication. |
Section | Description |
|---|---|
Tutorials for using FairCom's interactive SQL command line utility (iSQL). | |
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. | |
FairCom DBSQL language reference guide. | |
Guide for using the full-text search. | |
Guide for using Java and C# to implement SQL stored procedures and triggers. | |
Tutorials for using FairCom's JDBC driver in Java. | |
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). | |
Tutorials for using FairCom's Windows and Linux ODBC driver with FairCom DBSQL. | |
Explanation for configuring and troubleshooting ODBC for FairCom DBSQL. | |
Advanced FairCom SQL features, options, and utilities. | |
Complete list of SQL error codes. |
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 |
|---|---|
Guide for using the JSON DB API. | |
Reference guide to use the JSON DB API. | |
Core JSON API pattern that is used in FairCom APIs. | |
Complete list of FairCom error codes. |
SQL for Java
Section | Description |
|---|---|
Tutorials for using FairCom's JDBC driver in Java. | |
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). | |
Tutorial for using Java to implement SQL stored procedures and triggers in . | |
Guide for using Java and C# to implement SQL stored procedures and triggers. | |
Language elements that are common to many FairCom DBSQL statements. | |
Guide for using the full-text search. | |
Tutorials for using FairCom's interactive SQL command line utility (iSQL). | |
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. | |
Advanced FairCom SQL features, options, and utilities. | |
Complete list of SQL error codes. |
Record Buffer 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 |
|---|---|
Tutorials for working with record buffers using the JTDB API. | |
Reference guide for using the c-tree Database in Java — this API is called JTDB. | |
Tutorials for using the JPA and Hibernate to build Java applications using FairCom's JDTB API. | |
Guide for using the full-text search. | |
Answers to common problems. | |
Complete list of FairCom error codes. |
JSON APIs for Python
FairCom's JSON DB APIis optimized for easy development of microservices and n-tier applications.
Section | Description |
|---|---|
Guide for using the JSON DB API. | |
Reference guide to use the JSON DB API. | |
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 |
|---|---|
Tutorials for using SQL with FairCom DB. | |
Guide for using SQL with FairCom DB. | |
Language elements that are common to many FairCom DBSQL statements. | |
Guide for using the full-text search. | |
Tutorials for using FairCom's interactive SQL command line utility (iSQL). | |
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. | |
Explanation for configuring and troubleshooting ODBC for FairCom DBSQL. | |
Advanced FairCom SQL features, options, and utilities. | |
Complete list of SQL error codes. |
JSON APIs for C#
FairCom's JSON DB APIis optimized for easy management of all data processing for microservices and n-tier applications.
Section | Description |
|---|---|
Guide for using the JSON DB API. | |
Reference guide to use the JSON DB API. | |
Core JSON API pattern that is used in FairCom APIs. | |
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 |
|---|---|
Tutorials for using FairCom's Windows and Linux ODBC driver with FairCom DB. | |
Guide for using SQL with FairCom DB. | |
Language elements that are common to many FairCom DBSQL statements. | |
Guide for using the full text search. | |
Tutorial for using the C# to implement SQL stored procedures in FairCom DB. | |
Guide for using Java and C# to implement SQL stored procedures and triggers. | |
Tutorials for using FairCom's interactive SQL command line utility (iSQL). | |
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. | |
Explanation for configuring and troubleshooting ODBC for FairCom DBSQL. | |
Advanced FairCom SQL features, options, and utilities. | |
Complete list of SQL error codes. |
Record Buffer 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 |
|---|---|
Tutorials for working with record buffers using the JTDB API. | |
Guide for using the c-treeDB API in C#. | |
Guide for using the full text search. | |
Complete list of FairCom error codes. |
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.
Record Buffer APIs for C
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 |
|---|---|
Tutorials for working with record buffers. | |
Developer guide to building high-speed C applications using FairCom DB. | |
Guide for the c-treeDB C API. | |
Guide for using the full-text search. | |
Guide for automating timestamps, aggregation, and purging. | |
Guide for intercepting and interacting with database change events. | |
Guide for detecting and managing conflict resolution, data transformation, data filtering, and replicating to another database. | |
Introduction and tutorial on accessing the FairCom DBat the lowest possible level. | |
Guide for creating a new Microsoft Visual Studio C project using the CTDB API. | |
Complete list of FairCom error codes. |
SQL for C
Section | Description |
|---|---|
Guidelines for FairCom DBDirect SQL developers. | |
Language elements that are common to many FairCom DBSQL statements. | |
Guide for using the full text search. | |
Tutorials for using FairCom's interactive SQL command line utility (iSQL). | |
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. | |
Tutorials for using FairCom's Windows and Linux ODBC driver with FairCom DB. | |
Guide for using an ODBC driver to connect to FairCom DB. | |
Explanation for configuring and troubleshooting ODBC for FairCom DBSQL. | |
Advanced FairCom SQL features, options, and utilities. | |
Complete list of SQL error codes. |
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.
Record Buffer APIs for C++
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 |
|---|---|
Tutorials for working with record buffers. | |
Guide for using the c-treeDB C++ API. | |
Guide for building C++ applications using FairCom's ISAM and low-level APIs. | |
Guide for using the full-text search. | |
Developer guide for embedding SQL in C and C++. | |
Guide for C++ programmers to automate FairCom's data replication engine. | |
Guide for creating a new Microsoft Visual Studio C++ project using the c-treeDB server. | |
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 |
|---|---|
Developer guide for embedding SQL in C and C++. | |
Language elements that are common to many FairCom DBSQL statements. | |
Guide for using the full text search. | |
Tutorials for using FairCom's interactive SQL command line utility (iSQL). | |
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. | |
Tutorials for using FairCom's Windows and Linux ODBC driver with FairCom DB. | |
Guide for using an ODBC driver to connect to FairCom DB. | |
Explanation for configuring and troubleshooting ODBC for FairCom DBSQL. | |
Advanced FairCom SQL features, options, and utilities. | |
Complete list of SQL error codes. |
SQL for PHP
Section | Description |
|---|---|
Tutorials for using PHP PDO with FairCom DB. | |
Tutorials for using PHP SQL with FairCom DB. | |
Guide for using FairCom SQL with PHP applications using ODBC and PDO. | |
Complete list of SQL error codes. |
Section | Description |
|---|---|
Tutorial for using the c-tree Database API in Visual Basic.NET. | |
Reference guide for using the c-tree Database API in .NET. | |
Guide for using the full text search. | |
Complete list of FairCom error codes. |
FairCom RTG is a modernization solution for COBOL and BTRIEVE applications. See Database developer guides that expose COBOL and BTRIEVE data through JSON, SQL, and ISAM APIs.
Section | Description |
|---|---|
Solution guide to modernizing COBOL using FairCom RTG. | |
Solution guide to modernizing BTRIEVE using FairCom RTG. | |
Quick and advanced installation guides. | |
Complete list of FairCom error codes. | |
Guide for administering FairCom DB. | |
Highlights of the V3 release of FairCom RTG. | |
New features in the V3 release of FairCom RTG. | |
Release notes for the V3 release of FairCom RTG. |
The System administrator guides are useful for administrators who install, configure, manage, tune, and troubleshoot FairCom products.
Section | Description |
|---|---|
Quick and advanced installation guides. | |
Complete list of FairCom error codes. | |
Guide for administering FairCom DB. | |
A complete list of all FairCom CLI tools for backing up, recovering, managing users, troubleshooting, and so forth. | |
A list of all browser-based and GUI applications for administering FairCom DB. | |
Explanation for configuring and troubleshooting ODBC for FairCom DBSQL. | |
Advanced FairCom SQL features, options, and utilities. |
Section | Description |
|---|---|
Guide for implementing high availability on Linux servers. | |
Guide for implementing high availability on Windows servers. | |
Guide for using replication in order to achieve high availability and scalability. |
Section | Description |
|---|---|
Guide for implementing replication in FairCom DB. | |
Guide for using a GUI tool for managing data replication in FairCom DB. | |
Guide for the replication SDK, which allows C developers to extend data replication to manage conflict resolution, transform data, filter updates, and redirect updates. |
Section | Description |
|---|---|
Overall guide to upgrading FairCom products. | |
Highlights to the V12 release of FairCom DB. | |
New features in the V12 release of FairCom DB. | |
Release notes for the V12 release of FairCom DB. | |
Update guide for c-treeACE V11.5. | |
Release notes for c-treeACE V11.5. | |
Update guide for c-treeACE V11.0. | |
Release notes for c-treeACE V11.0. | |
Update guide for c-treeACE V10.3. | |
Release notes for c-treeACE V10.3. | |
Update guide for c-treeACE V10.0. | |
Release notes for c-treeACE V10.0. | |
Update guide for FairCom RTGV2. | |
Release notes for FairCom RTGV2. |
Version | Description |
|---|---|
New features and updates introduced in FairCom DB v12. | |
Correction implemented in FairCom DB v12. | |
New features and updates introduced in c-treeACE v11.5. | |
Corrections implemented in FairCom DB v11.5. | |
New features and updates introduced in FairCom DB v11.0. | |
Corrections implemented in FairCom DB v11.0. |