Skip to main content

Installed files and folders

Files installed during FairCom installation

FairCom folders

When you install the FairCom server, its root folder is placed in the folder of your choice. This <faircom> folder name includes the product name followed by the operating system and the exact version. The version corresponds to the underlying core engine that powers the FairCom server. It follows the pattern, Major, Minor, Patch, and Build.

The following folders are in the <faircom> folder.

FCfolders.png
Table 1. FairCom product root folder structure and contents

Folder

Description

/build_sdk

A software development kit for C programmers. It is only available in FairCom's professional package.

/config

Server startup configuration files. The following list shows which files configure which settings.

Ports and protocols

services.json

Database server

ctsrvr.cfg

Database replication

ctagent.json

ISAM Explorer application

ctIsamExplorer.cfg

Database Monitor application

ctMonitor.cfg

Data Explorer application

ctSQLExplorer.cfg

ThingWorx connector

ctthingworx.json

Timestamp configuration

cttimestamp.json

/data

Data, and index files.

/drivers

Tutorials and drivers for many programming languages.

Note

In addition to the driver tutorials, see Browser‑based graphical tools to graphically manage your database.

/server

FairCom software executables.

/tools

Command-line utilities for managing the server.

/tranlogs

Transaction log files.



The config folder contains configuration files that you modify to change the behavior of the FairCom server. These configuration files are referenced throughout this document.

configFolder.svg

The data folder contains log files and one folder for each database that you create. Your data and index files are in these database folders.

The image below shows two database folders:
  • ctreeSQL.dbs

  • testdata

By default, FairCom products ship with a single database named ctreeSQL. Use that name in any of the APIs that ask you to enter the name of your database.

edge_db_folders.png

The sql_server.log file contains JSON log entries for each SQL operation you perform. This is useful for troubleshooting SQL. You can turn on logging to this file by placing the SQL_DEBUG LOG_STMT_TIMES_FETCH command in the ctsrvr.cfg file.

FairCom system files (*.fcs) are also kept here. Most are transaction log files used to record that all data sent to the FairCom database engine is durably captured on disk.

The following FCS files contain useful troubleshooting information:
  • ctstatus.fcs contains a history of critical events, such as starts and stops of the FairCom server.

  • snapshot.fcs contains a snapshot of the FairCom server when it shuts down.

The directory structure for the drivers folder may differ depending on your platform.

This drivers folder contains tutorials, drivers, and connectors for the programming languages, APIs, and connectors that FairCom supports. The subfolders are organized by language and API. Inside each subfolder is a ReadMe file that walks you through running the tutorial, which takes only a few minutes.

The c-tree.drivers subfolder general purpose folder that contains the components needed by each programming language to run, link, and compile the code in the other drivers subfolders.

The server executable file (faircom.exe ) is in the server directory.

The other files and folders in this directory are to facilitate specific features and operations.

The tools folder contains command‑line utilities you can use to manage your database.

edge_tools_folder.png

The FairCom database server installation includes /config for startup, /tools for utilities, /drivers for language support, /data for database files (including logs and snapshots for troubleshooting), and /server for executables. The structure focuses on configuration, drivers, data, and executables, along with browser-based management tools.

installed product folderconfig folderdata folderdrivers folderserver foldertools folderFairCom installationFairCom serverFairCom product root folderServer startup configurationDatabase serverDatabase replicationISAM Explorer applicationDatabase Monitor applicationData Explorer applicationThingWorx connectorTimestamp configurationCommand-line utilitiesProgramming language driversData filesIndex filesTransaction log filesSoftware executablesSoftware development kit (SDK)Browser-based graphical toolsDatabase managementTroubleshooting SQLSQL operations loggingFairCom Database Engine