Skip to main content

Developer overview

Overview for using FairCom products as a developer

API summary

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.

List of APIs

Language specific information

Section

Description

Developers using JSON

For developers using JSON

Developers using SQL

For developers using SQL

Java developers

For developers using Java

Python developers

For developers using Python

C# developers

For developers using C#

C programmers

For programmers using C

C++ programmers

For programmers using C++

PHP developers

For developers using PHP

Visual Basic developers

For developers using Visual Basic

All FairCom products integrate the FairCom database engine, providing various APIs optimized for different programming languages and use cases: JSON DB API – Enables fast development using JSON queries and data across all languages. SQL – Ideal for joins, ad hoc queries, and analytics. CTDB Record Buffer API – Facilitates efficient data processing. ISAM Record Buffer API – Offers fine-tuned control over data processing for maximum speed. API Categories: FairCom APIs: ACE APIs, CLI, JSON APIs, jsonAction, JSON Schema, SQL JSON APIs: JSON Admin API, JSON DB API, JSON Hub API, JSON MQ API ACE APIs: Record Buffer APIs (CTDB, ISAM, Low-level ACE API) Language-Specific Support: FairCom provides tailored development options for JSON, SQL, Java, Python, C#, C, C++, PHP, and Visual Basic, ensuring compatibility across diverse programming environments.

Database Management: FairCom DB, SQL, ISAM, CTDB, JSON DB API, record buffer APIs & Integration: JSON Admin API, JSON Hub API, JSON MQ API, ACE APIs, CLI, jsonAction, JSON Schema Industrial IoT & Messaging: FairCom Edge, MQTT, Modbus, OPC UA, REST, ThingWorx Legacy Modernization: FairCom RTG, COBOL, Btrieve, record management, concurrent users Programming Languages: JSON, SQL, Java, Python, C#, C, C++, PHP, Visual Basic

Application Programming Interface (API) is a type of software interface that provides a service to other software. 

Advanced C Engineering APIs (ACE APIs) include FairCom's ISAM, CTDB, and Low-level ACE API.

Each of these APIs use the Record Buffer Method for processing data at high speed with high efficiency. ACE APIs are ideal for C and C++ because these languages are designed to work with record buffers. Higher-level languages, such as Java and C#, can also use these APIs with almost the same efficiency as C or C++.

Abbreviation for a command-line-interface. This is the interface that operates in a shell (also known as a DOS window, console window, or a command prompt).

JSON APIs are FairCom's family of APIs that use jsonAction to interact with a FairCom server. They are optimized for client server computing and ease of use in all programming languages. They provide maximum data flexibility.

The JSON Action Protocol (jsonAction) is like REST, jsonAction is a standard way of using JSON to execute actions on remote computers by sending a JSON Action request to a server and receiving back a JSON response. All information needed in a request and its response is included in the JSON. This allows jsonAction to work over any protocol including HTTP, HTTPS, WS, WSS, MQTT, MQTTS, etc.

jsonAction improves on REST by putting all request information in JSON. In contrast, REST spreads request information across a URL, query string, HTTP header, HTTP verb, and HTTP payload. Similarly, jsonAction puts all response information in JSON, whereas REST spreads response information across the HTTP header and HTTP payload. Lastly, REST only works over HTTP whereas, jsonAction works over any protocol including asynchronous protocols.

JSON Schema is a standard for validating JSON documents. It requires a schema to be defined in one JSON file and uses that file to validate the content of another JSON file.

A JSON database may use a JSON Schema to validate the structure of a JSON document before it stores it in its database. This ensures data is complete and valid so that it can be queried reliably.

JSON Schema is not to be confused with SQL Schema.

Structured Query Language (SQL) is a standardized programming language that is used to manage relational databases and perform various operations on the data in them.

FairCom's SQL engine is ANSI compliant and has almost all SQL features up through the SQL:2003 standard.

The JSON Admin API logs into and out of FairCom servers and manages sessions, services, etc. All its API actions are available in all FairCom products.

This API is part of FairCom's family of JSON APIs.

The JSON DB API uses JSON over HTTP to manage databases, tables, indexes, records, queries, cursors, and transactions. It is available in all FairCom products.

This API is part of FairCom's family of JSON APIs.

The JSON Hub API configures and manages data integrations and transformations between input and output connectors. All its API actions are available in FairCom Edge and some are available in FairCom MQ.

This API is part of FairCom's family of JSON APIs.

The JSON MQ API configures and manage FairCom's MQTT broker. It is available in FairCom Edge and FairCom MQ.

This API is part of FairCom's family of JSON APIs.

FairCom ACE APIs are Record Buffer APIs because they use the Record Buffer Method.

FairCom ACE APIs include ISAM, CTDB, and Low-level ACE API.

The c-tree Database API (CTDB API) is FairCom's database API in the ACE family of APIs. It provides high performance with less code than the FairCom's ISAM API. The CTDB API introduces database concepts that are compatible with SQL. It requires records to contain predefined field structures. FairCom's CTDB API provides full control over record processing. This allows developers to implement data processing algorithms that are tailored to precise application needs, and this allows an application to achieve unrivaled performance. FairCom's CTDB API works well in a variety of languages, such as C, C++, Java, C#, and Visual Basic.

FairCom ACE APIs include ISAM, CTDB, and Low-level ACE API.

Indexed Sequential Access Method (ISAM) is FairCom's primary ACE API. ISAM uses the Record Buffer Method, which gives the application full control over the contents of the entire record buffer to store structured or unstructured data.

FairCom's ISAM API provides full control over record processing. This allows developers to implement data processing algorithms that are tailored to precise application needs, and this allows an application to achieve unrivaled performance. FairCom's ISAM API works best in the C and C++ languages.

FairCom ACE APIs include ISAM, CTDB, and Low-level ACE API.

The Low-level ACE API is FairCom's lowest level API. It provides total control over every detail of index and table creation and management. It requires the most code and provides maximum control for maximum server-side performance. It works best in the C and C++ languages.

FairCom ACE APIs include ISAM, CTDB, and Low-level ACE API.