Product Documentation

c-treeACE V10.0 Update Guide

Previous Topic

Next Topic

Command-Line Utilities Refresher Course

To help you understand the comprehensive set of utilities provided with the FairCom product, this section provides listing of these utilities. If you are new to FairCom, this is a starting place for unlocking the power of this environment. If you have been using FairCom for a while, this section provides a refresher course.

In this section, the command-line utilities are in alphabetical order. The intended purpose (administration, data integrity, etc.) is shown under Purpose. When a GUI version is available, the name of that tool is indicated in GUI Version.

Many of these utilities have recently been enhanced or fixed; the details of those updates are listed in the next sections.

ctadmn - c-treeACE Server Administrator Utility

Manage users, groups, and files; monitor users logged on to the server; and disconnect a user from the server.

Purpose: Administration, Security

GUI Version: c-treeACE Security Administrator; c-treeACE Monitor

ctclntrn - Clean Transaction Mark Utility

“Cleans” the high-water transactions marks within a c-treeACE index.

Purpose: Maintenance

ctcmdset - Create Encrypted Password File

Create an encrypted password file from a text file.

Purpose: Administration, Security

ctcmpcif - IFIL-based Compact Utility

Reads the IFIL structure from the data file and calls CompactIFileXtd() and RebuildIFileXtd() to compact and rebuild it and its associated indexes.

Purpose: Administration, Maintenance

ctcv43 - Convert V4.3 Data File to c-tree Plus Format

Convert an older c-tree V4.3 data file to the current c-treeACE format.

Purpose: Administration, Conversion, Migration, Version Upgrade

ctcv67 - Extended File Conversion Utility

Convert data and index files from Standard to Extended c-treeACE format; adding huge file support, changing segment support, and compacting the output file

Purpose: Administration, Conversion, Migration, Version Upgrade

ctdidx - Create Flat Key File

Create a flat key file containing each key value at full, uncompressed length followed by the associated long integer, 4-byte, record position.

Purpose: Administration, Conversion, Migration, Version Upgrade

ctdmpidx - Index Dump Utility

View index header details, nodes, and key values.

Purpose: Diagnostics

ctdump - Dynamic Dump Utility

Back up data files controlled by c-treeACE Server.

Purpose: Administration, Recovery

ctencrypt - Utility to Change Master Password

New! Change the master password for specified c-treeACE data, index, and transaction log files.

Purpose: Administration, Security

ctfchk - File Checksum Utility

Calculate the checksum on all active records in a fixed-length data file, which can be used to compare the record contents of two fixed-length data files.

Purpose: Diagnostics

ctfdmp - Roll Forward Dump System Recovery Utility

Restore data to a given time following a ctrdmp restore.

Purpose: Administration, Recovery

ctfileid - Update File IDs

Update the file IDs of the file header so different applications and/or client nodes can refer to the same file with different names (e.g., to accommodate different drive or path mappings).

Purpose: Administration, Data Integrity, Maintenance

ctflat - Create c-treeACE Plus File from a Flat File

Create a fixed-length data file with a specified record length from an existing flat file.

Purpose: Administration, Migration

ctflvrfy - Index Verify Utility

Calls the ctVERIFY() and chkidx() functions to verify and optionally inspect an index file.

Purpose: Diagnostics

cthghtrn - Display High-Water Mark for Transactions

Shows the high-water transaction marks within an index file (used when the transaction mark number gets too large).

Purpose: Diagnostics

ctidmp - Examine Dump Files Utility

List all or part of a dynamic dump file.

Purpose: Diagnostics

ctin43 - Create Flat Key File

Create a flat key file from a c-tree V4.3 index file by dumping keys for designated index member to a flat file (index must first be converted from V4.1F-V4.3C using ctin43 and then ctindx).

Purpose: Administration, Conversion, Migration, Version Upgrade

ctindx - Create Index File from Flat Key File

Create an index file from a flat key file, such as the flat key file produced by ctin43.

Purpose: Administration, Conversion, Migration, Version Upgrade

ctinfo - Incremental ISAM Utility

Retrieves IFIL and DODA structures and XCREblk extended header information (if available) from a c-treeACE file.

Purpose: Diagnostics

ctldmp - Transaction Log Dump

Perform a partial dump of the transaction logs to assist the developer in problem resolution.

Purpose: Diagnostics

ctmark - Simulated Data Generation Test

Use a parameter file that contains 128-byte fixed-length records keyed by unique number, name, and department code (the names vary in length, with a typical amount of leading character redundancy; the department codes are highly repetitive).

Purpose: Sample Programs

ctmove - Move Files without Stopping c-treeACE Server

Move files without stopping c-treeACE Server to minimize downtime during file recovery.

Purpose: Administration, Maintenance, Recovery

ctmtap - Low-Level Multi-Threaded Test

A multi-threaded version of ctmark that demonstrates FairCom’s Multi-thread API by running a trial of database operations.

Purpose: Sample Programs

ctmtlk - Lock Operation Test Utility

Ensure proper locking with the multi-threaded stand-alone model.

Not built by default; source available at ..sdk\Xtras\ctree.samples\isam

Purpose: Diagnostics

ctquiet - Quiesce c-treeACE Utility

Temporarily suspend operation of the server for specific files/actions.

Purpose: Administration, Maintenance

ctrbldif - IFIL-based Rebuild Utility

Reads the IFIL structure from the header and calls RebuildIFileXtd() to rebuild the file and its indexes.

Purpose: Administration, Data Integrity, Maintenance

ctrdmp - Rollback Dump Recovery Utility

Restore dumps created with ctdump; also performs data roll backs.

Purpose: Administration, Recovery

ctredirect - IFIL Update Utility for Redirected Filenames

Allows a file to be repositioned into another location following autorecovery, dynamic dump restore, or replication.

Purpose: Administration, Maintenance, Recovery

ctsbld - Superfile Rebuild Pre-Pass

Verifies the deleted space in the data file and recreates, in place, any companion index files.

Purpose: Administration, Maintenance, Superfile Integrity

ctsbldm - Rebuild Superfile Index Members

Rebuild superfile index members without having to process the entire superfile (assuming the data file is not corrupt, contains an IFIL describing all the indexes, and the superfile is intact except for the indexes in question).

Purpose: Administration, Maintenance, Superfile Integrity

ctscmp - Superfile Compact Utility

Compact and rebuild a superfile and all of its members (provided the IFIL resources are present in the superfile data members).

Purpose: Administration, Maintenance, Superfile Integrity

ctsfex - Superfile Data Export Utility

Export data from a superfile to another superfile or to individual files identical to the superfile members.

Purpose: Administration, Maintenance, Superfile Integrity

ctsfil - Superfile Contents Utility

List members of the superfile, indicating if each member is an index file, fixed-length data file, or variable-length data file.

Purpose: Administration, Maintenance, Superfile Integrity

ctsqlbigint - c-treeACE SQL Big Integer Fix Utility

Detect and correct BIGINT issues on HIGH LOW machines should they occur.

Area: SQL

Purpose: Diagnostics, Administration, Data Integrity, SQL Tools

ctsqlcdb - c-treeACE SQL Database Maintenance Utility

Create, add, or drop a c-treeACE SQL database from the server.

Area: SQL

Purpose: Administration, Maintenance, SQL Tools

ctsqlimp - c-treeACE SQL Import Utility

“Register” (link) existing files to a c-treeACE SQL database without modifying the table structure so the files remain accessible from the original application.

Area: SQL

Purpose: Administration, Conversion, Migration, SQL Tools

ctsqlmdd - c-treeACE SQL Move Database Utility

Move a database from one system to another, including path changes to be reflected in the session and database dictionaries.

Area: SQL

Purpose: Administration, SQL Tools

ctsqlutl - c-treeACE SQL Table Maintenance Utility

Perform maintenance on databases, including renaming tables and columns.

Area: SQL

Purpose: Administration, Maintenance, SQL Tools

ctstat - Statistics Utility

Display statistics collected by the server for real-time monitoring of critical operations.

Purpose: Monitoring, Diagnostics

GUI: c-treeACE Monitor, c-treeACE Gauges

ctstress - Perform Record Operations

Perform various database operations for use as a test.

Not built by default; source at ..\Xtras\ctree.samples\special\utils

Purpose: Sample Programs

ctsysm - Server Status Log Monitoring Utility

Monitor c-treeACE Server status log entries.

Purpose: Administration, Monitoring

cttctx - Performance Test Utility

Simulate high load conditions as a client benchmark test of operations for profiling performance and verifying application performance.

GUI: c‑treeLoadTest

Purpose: Performance, Sample Programs

cttpca - TPC-A Benchmark Test Program

A benchmark utility that implements Transaction Processing Performance Council Benchmark A test (TPC-A) to emulate an update-intensive database environment.

GUI: c-treeACE TPCA Test

Purpose: Sample Programs

cttrap - Communications Trap Playback Utility

A multi-threaded client application that “plays back” a TRAP_COMM log file.

Purpose: Diagnostics

cttrnmod - Change Transaction Mode Utility

Display or change the transaction status of a data file and its associated index files.

Purpose: Diagnostics

ctunf1 - File Reformatting Utility

Reformat a file in place provided the new alignment restriction does not cause the data record contents to become misaligned.

Purpose: Administration, Conversion

ctunf2 - UNIFRMAT File Reformatting Utility

Convert UNIFRMAT files to HIGH_LOW.

Purpose: Administration, Conversion, Migration

ctupdpad - Update Pad Resource Utility

Change the padding and delimiter characters in the padding resource.

Purpose: Administration, Maintenance

ctvfyidx - Index Verify Utility

Verify the integrity of an index.

Purpose: Diagnostics

ctvlqa - Variable-length Quality Assurance Utility

A torture and performance test that generates random data to build generic records based on the file structure layout from ctixmg.

Purpose: Data Integrity, Sample Programs

dbdump - Data Unload Utility

Write data from a c-treeACE SQL file to an output file.

Area: SQL

Purpose: Administration, Recovery

dbload - Data Load Utility

Load records from an input data file into database tables.

Area: SQL

Purpose: Administration, Recovery, SQL Tools

dbschema - Schema Export Utility

Recreate specified database elements and data.

Area: SQL

Purpose: Administration, Recovery, SQL Tools

fkverify - SQL Foreign Key Constraints

Check an existing database for the foreign key constraint issues.

Area: SQL

Purpose: Diagnostics, SQL Tools

ISQL - Interactive SQL Utility

A standard command-processing interface to the SQL database engine.

Area: SQL

Purpose: Administration, SQL Tools

GUI: c-treeACE Query Builder; c-treeACE SQL Explorer

mtmake - Build Library Utility

Generate a customized makefile for a specific environment, based on selected menu options, to build libraries for ISAM, low-level, and c-treeDB APIs.

Purpose: Developer Support

sa_admin - User and Group Administration Tool

A command-line version of the system administrator program, which can be used in script files to ease initial setup.

Purpose: Administration

GUI: c-treeACE Security Administrator

TOCIndex