Documentation

c-treeEDGE MicroServer

Next Topic

c-treeEDGE IoT Database Administrator's Guide

The c-treeEDGE IoT Database allows you to place the fast, transaction-controlled c-treeEDGE MicroServer on IoT gateways and edge devices where it is near your IoT data. Because it is located close to the sensors, instead of cloud-based, it provides autonomy in situations when communication with the cloud is slow or unavailable. In addition, you can store unfiltered sensor data with no bandwidth concerns. It allows you to put intelligence in your IoT projects for advanced, real-time decision processing.

This manual has two main purposes for the c-treeEDGE Server Administrator:

  1. To provide a quick, easy way to see what responsibilities you have, and
  2. To provide the information needed to manage c-treeEDGE MicroServer operation.

The c-treeEDGE MicroServer supports high-level database management, including:

  • client/server computing - Increases performance and provides the ability to maintain database integrity, especially in multi-user environments. The basic principle of client/server computing is: applications, or “clients”, interact with the server, which manages file operations and communicates with clients.
  • online transaction processing (OLTP) - The c-treeEDGE MicroServer can group a specified set of operations, called a “transaction,” and ensure either all of them are done or, if there is a problem, none will be done, e.g., either all of an invoice is processed, or none of it.
  • security controls - c-treeEDGE MicroServer access is controlled with user IDs, passwords, file permissions, and encryption. Users and files may be added to Administrator defined “groups”, e.g., shipping department, payroll department.
  • database maintenance and utilities - The c-treeEDGE MicroServer automatically saves necessary information for use in automatic or Administrator-specified backups and recovery from problems.
  • configuration flexibility - From basics such as which communication protocol the c-treeEDGE MicroServer uses and memory allocations to enforce for specific users, to a wide range of advanced controls.

The c-treeEDGE Server Administrator has the following areas of responsibility, each of which could be divided among several people:

1. Installation

Someone, not necessarily the Administrator, must physically load the c-treeEDGE MicroServer software onto the computing environment. Once completed, installation issues usually are no longer a concern unless the c-treeEDGE MicroServer needs to be re-installed, for example, to install a new version. See c-treeEDGE MicroServer Installation for details.

2. Operating the c-treeEDGE MicroServer

Starting and stopping the c-treeEDGE MicroServer: Any user can start the c-treeEDGE MicroServer by running the executable module, ctreedge (or ctsrvr for versions of c-treeEDGE that don’t offer SQL support), as any other program in the environment. See Operating the c-treeEDGE MicroServer for details.

3. Controlling access to the c-treeEDGE MicroServer

Begin by setting up valid User IDs and passwords (including your own). Establish rules of access to given database files. Establish groups where users and files can be associated and control access according to membership in those groups.

Use the graphical c-treeEDGE Monitor (c‑treeACEMonitor.jar) or the command-line version (ctadmn) to control access with user IDs, file passwords, file permissions, and Administrator-defined groups with specified access rights to particular files. Documentation about the graphical tools is available in the book titled Java-Based GUI Tools on the FairCom website. Details about the command-line tools is available on the FairCom website in the book titled Command-Line Tools.

ctpass is used by the Administrator or any other authorized user to change the password associated with their User ID.

ctfile is used by the Administrator or any user to change file security information on any file owned by the user. See Controlling c-treeEDGE MicroServer Access for details.

4. Maintaining Database Integrity

Schedule and conduct backups or dumps of system generated files for later use in recovering from problems or returning a database to its status at a prior time. See Maintaining Database Integrity for details regarding the tools discussed in this section.

Use the utility ctdump to schedule dynamic dumps that can be used at a later time to restore database files or to roll back to a state at a previous point in time.

ctrdmp works with information saved in a dynamic dump to either recover from a catastrophic system failure by restoring specified files to a consistent, well-defined state or to roll back specified files to their state at a specified time.

Use the utility ctfdmp to recover from a catastrophic failure using a previously saved dynamic dump or complete backup, which may be made using any standard backup utility. This allows you to restore backups then ‘roll forward’ to a given time using preserved log files.

(For programmers) Use the ctldmp utility to carry out a transaction log dump, which records partial log-related information, for use in application development.

5. Configuring the c-treeEDGE MicroServer

Understand how the c-treeEDGE MicroServer is currently configured and, optionally, change configuration settings (e.g., to set memory allocation limits, to select communication protocols, to activate a particular dump description script).

The c-treeEDGE MicroServer is started by any user authorized to start ctreedge (or ctsrvr). Routine starting of the c-treeEDGE MicroServer is not necessarily a major responsibility for the Administrator.

The User ID “ADMIN” (default password is “ADMIN”) and members of the ADMIN group are the only users who can access ctstop, the utility for stopping the c-treeEDGE MicroServer, so stopping the c-treeEDGE MicroServer is always a major Administrator responsibility.

6. Customize the c-treeEDGE MicroServer

No configuration file is required, but if the c-treeEDGE MicroServer is to be reconfigured to replace any default settings, a file named ctsrvr.cfg must be created for the server to load at startup. See Configuring the c-treeEDGE MicroServer for details.

Note: Utility names and methods of executing them may vary slightly in different environments, so see the individual sections in this manual for specifics. The utilities covered here are not the only ways to carry out Administrator duties and the utilities listed here are not necessarily the only ones available.

The basic topics covered here are for orientation only. c-treeEDGE MicroServer Installation and Operating the c-treeEDGE MicroServer, are considered required reading for c-treeEDGE Server Administrators. c-treeEDGE MicroServer Access Configuration, Maintaining Database Integrity, Configuration File Format, and Basic Keywords are recommended reading. The rest of c-treeEDGE Configuration Options is optional and intended for advanced users.

Some issues may require the assistance of others with specialized knowledge relevant to the operating environment (e.g., configuring memory access allotments, defining dynamic dumps).

In This Chapter

Server Quick Start

Advanced c-treeEDGE MicroServer Features

Client/Server Computing

TOCIndex