Jump to main content
Product Documentation
Customer Support
HCL OneDB 2.0.1
What's new in
HCL OneDB™
2.0.1
Getting Started
Installing
Administering
Migrating and upgrading
Data warehousing
Security
Client APIs and tools
SQL programming
JSON compatibility
Extending
HCL OneDB™
Designing databases
Embedding
HCL OneDB™
Release information
Troubleshooting
HCL OneDB™
OneDB PDF guides
Search
Home
Administering
In addition to administering the database server, you can tune performance, replicate data, and archive data.
System administration
These topics contain concepts, procedures, and reference information for database and database server administrators to use for managing and tuning
HCL OneDB™
database servers.
Administrator's Reference
The
HCL OneDB™ Administrator's Reference
includes comprehensive descriptions of
HCL OneDB™
configuration parameters, the system-monitoring interface (SMI) tables in the sysmaster database, the syntax of database server utilities such as
onmode
and
onstat
, logical-log records, disk structures, event alarms, and unnumbered error messages.
Administrative Utilities
Administering
In addition to administering the database server, you can tune performance, replicate data, and archive data.
System administration
These topics contain concepts, procedures, and reference information for database and database server administrators to use for managing and tuning
HCL OneDB™
database servers.
Administrator's Guide
The
HCL OneDB™ Administrator's Guide
provides the information required to administer
HCL OneDB™
.
Administrator's Reference
The
HCL OneDB™ Administrator's Reference
includes comprehensive descriptions of
HCL OneDB™
configuration parameters, the system-monitoring interface (SMI) tables in the sysmaster database, the syntax of database server utilities such as
onmode
and
onstat
, logical-log records, disk structures, event alarms, and unnumbered error messages.
Configuring and monitoring
HCL OneDB™
Administrative Utilities
Overview of Utilities
The
HCL OneDB™
database server utilities allow you to perform administrative tasks directly from the command line.
The finderr utility
Use the
finderr
utility to view additional information on
HCL OneDB™
error messages. On UNIX™ and Linux™ platforms, the information appears on the command line. On Windows™ platforms, the information appears in the Error Messages program.
The genoncfg Utility
Use the
genoncfg
utility to expedite the process of customizing the default
HCL OneDB™
configuration file (
onconfig.std
) to the host environment and your planned usage of a database server instance.
The oncheck Utility
Use the
oncheck
utility to check specified disk structures for inconsistencies, repair inconsistent index structures, and display information about disk structures.
The onclean utility
Use the
onclean
utility to force a shut down of the database server when normal shut down with the
onmode
utility fails or when you cannot restart the server. The
onclean
utility attempts to clean up shared memory, semaphores, and stops database server virtual processes.
The oncmsm utility
Use the
oncmsm
utility to start or shut down a Connection Manager, load a new configuration file into a Connection Manager to modify the Connection Manager's settings, or update the format of a configuration file.
The onconfig_diff utility
Use the
onconfig_diff
utility to compare two
onconfig
files.
The ondblog utility
Use the
ondblog
utility to change the logging mode for one or more databases.
The oninit utility
The
oninit
utility starts the database server.
The onkstash Utility
Use the
onkstash
to create a password stash file for an existing PKCS#12 keystore.
The onkstore Utility
The onlog utility
The
onlog
utility displays the contents of a logical-log file, either on disk or on backup.
The onmode utility
Use the
onmode
utility to change the database server operating mode and perform various other operations on shared memory, sessions, transactions, parameters, and segments.
The ON-Monitor Utility
The onparams Utility
Use the
onparams
utility to add or drop a logical-log file, change physical-log parameters, and add a new buffer pool.
The onpassword utility
Use the
onpassword
utility to encrypt and decrypt a password file. Connection Manager and Enterprise Replication utilities require a password file to connect to database servers over an untrusted network.
The ifxclone utility
You use the
ifxclone
utility to create a server clone from a snapshot of an existing database server.
The onspaces utility
Use the
onspaces
utility to manage the storage spaces in your database.
The onstat utility
The
onstat
utility reads shared-memory structures and provides statistics about the database server at the time that the command runs.
SQL Administration API
DB-Access User's Guide
This publication describes how to use the
DB-Access
utility to access, modify, and retrieve information from
HCL® OneDB®
database servers.
Performance Guide
The
HCL OneDB™ Performance Guide
describes how to configure and operate your
HCL OneDB™
database server to improve overall system throughput and to improve the performance of SQL queries.
OneDB Explore
OneDB Explore
is a modern web console for visualizing, monitoring, and managing your
OneDB
server instances. It is purpose built for ease-of-use, scaling out, and optimizing DevOps needs. It provides critical performance management capabilities, monitoring how key performance metrics are changing over time and tracking how efficiently
OneDB
is running your workload even when you’ve stepped away from your screen. Its monitoring system feeds directly into a customizable alerting system so you can be immediately alerted via email, Twilio, or PagerDuty whenever an issue occurs on one of your
OneDB
database server instances.
OneDB Explore
is designed to be scalable to efficiently manage and monitor as many OneDB database server instances as you need. Moreover, it's a tool that can be shared by the DBAs, the app developers, the ops engineers, and management and accessed from any desktop, laptop, or mobile device. OneDB Explore is the centralized hub for graphical monitoring, alerting, and administration of your
OneDB
database servers.
Backup and Restore Guide
The
HCL OneDB™ Backup and Restore Guide
describes how to use the
HCL® OneDB®
ON-Bar
utility to back up and restore database server data.
This will enable you to recover your databases after data is lost or becomes corrupted due to hardware or software failure or accident.
Enterprise Replication
The
HCL OneDB™
Enterprise Replication Guide
describes the concepts of data replication using
HCL® OneDB® Enterprise Replication
, including how to design your replication system, as well as administer and manage data replication throughout your enterprise.
Administrative Utilities
Overview of Utilities
The
HCL OneDB™
database server utilities allow you to perform administrative tasks directly from the command line.
The finderr utility
Use the
finderr
utility to view additional information on
HCL OneDB™
error messages. On UNIX™ and Linux™ platforms, the information appears on the command line. On Windows™ platforms, the information appears in the Error Messages program.
The genoncfg Utility
Use the
genoncfg
utility to expedite the process of customizing the default
HCL OneDB™
configuration file (
onconfig.std
) to the host environment and your planned usage of a database server instance.
The oncheck Utility
Use the
oncheck
utility to check specified disk structures for inconsistencies, repair inconsistent index structures, and display information about disk structures.
The onclean utility
Use the
onclean
utility to force a shut down of the database server when normal shut down with the
onmode
utility fails or when you cannot restart the server. The
onclean
utility attempts to clean up shared memory, semaphores, and stops database server virtual processes.
The oncmsm utility
Use the
oncmsm
utility to start or shut down a Connection Manager, load a new configuration file into a Connection Manager to modify the Connection Manager's settings, or update the format of a configuration file.
The onconfig_diff utility
Use the
onconfig_diff
utility to compare two
onconfig
files.
The ondblog utility
Use the
ondblog
utility to change the logging mode for one or more databases.
The oninit utility
The
oninit
utility starts the database server.
The onkstash Utility
Use the
onkstash
to create a password stash file for an existing PKCS#12 keystore.
The onkstore Utility
The onlog utility
The
onlog
utility displays the contents of a logical-log file, either on disk or on backup.
The onmode utility
Use the
onmode
utility to change the database server operating mode and perform various other operations on shared memory, sessions, transactions, parameters, and segments.
The ON-Monitor Utility
The onparams Utility
Use the
onparams
utility to add or drop a logical-log file, change physical-log parameters, and add a new buffer pool.
The onpassword utility
Use the
onpassword
utility to encrypt and decrypt a password file. Connection Manager and Enterprise Replication utilities require a password file to connect to database servers over an untrusted network.
The ifxclone utility
You use the
ifxclone
utility to create a server clone from a snapshot of an existing database server.
The onspaces utility
Use the
onspaces
utility to manage the storage spaces in your database.
The onstat utility
The
onstat
utility reads shared-memory structures and provides statistics about the database server at the time that the command runs.
Rate this topic
5 stars
4 stars
3 stars
2 stars
1 star
Comment on this topic.
By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at
https://hcltechsw.com/resources/us-government-contact
. Do not include any personal data in this Comment box.