Command Reference Guide
1. Introducing Ingres Commands
Commands and Utilities
Audience
Special Considerations
System-specific Text in this Guide
Path Notation in this Guide
UNIX Shells Used in this Guide
Query Language Used in this Guide
Syntax Conventions Used in this Guide
Where to Issue Commands
General Command Syntax
Standard Flags and Parameters
dbname
dbname
vnode_name
server_class
Dynamic Vnode Specification--Connect to Remote Node
protocol
port
attribute=value
Uppercase Flags
Schema Qualifier--Specify Ownership
Delimited Identifiers on the Command Line
Examples: Delimited Identifiers
2. Using Ingres Commands
abf Command--Invoke Applications-By-Forms
dbname
applname
accessdb Command--Authorize User Access
aducompile Command--Install Customized Collation Sequence
description_filename
language_filename
alterdb Command--Set Database Characteristics
dbname
arcclean Command--Purge Records from Replicator Shadow and Archive Tables
arclean Example
auditdb Command--Audit a Database
dbname
dbname
auditdb Examples
Windows:
UNIX:
VMS:
blobstor Command--Copy a BLOB from a File to a Database
vnode
vnode
dbname
imageFile
blobstor Examples
cacheutil Command--Show or Destroy Buffer Caches
catalogdb Command--List Databases That You Own
catalogdb Examples
cbf Command--Start Configuration-By-Forms
ckpdb Command--Checkpoint a Database
dbname
dbname
ckpdb Examples
compform Command--Compile a Form
dbname
dbname
form
filename
compform Example
convrep Command--Upgrade the Replicator Data Dictionary
vnode
dbname
convtouni Command--Convert Character Data to Unicode
dbname
dbname
tables
convtouni Examples
copyapp Command--Copy an Application to Another Database
dbname
dbname
applname
newdbname
intfilename
copyapp Example
copydb Command--Copy and Restore a Database
dbname
dbname
copydb Example on Windows
copydb Example on UNIX
copydb Example on VMS
copyform Command--Copy a Form to Another Database
dbname
dbname
form
filename
copyform Examples
copyrep Command--Copy a Report to a Text File
dbname
dbname
filename
reportname
copyrep Example
createdb Command--Create a Database
dbname
dbname
cdbname
createdb Examples
cscleanup Command--Deallocate Shared Memory
csreport Command--Display Shared Memory Information
csreport Output
csreport Example: Show Server Connect IDs
dclgen Command--Generate Structure Declarations
language
language
dbname
tablename
filename
structurename
dclgen Example
delobj Command--Delete Objects from Database
dbname
dbname
Object Specification for delobj Command--Specify Objects to Delete
objname
delobj Examples
dereplic Command--Remove Objects from Replicated Database
destroydb Command--Destroy a Database
dbname
dbname
destroydb Examples
eqc Command--Invoke Embedded QUEL Preprocessor for C
flags
flags
filename
eqc Examples
esqla Command--Invoke Embedded SQL Preprocessor for Ada
flags
filename
esqlb Command--Invoke Embedded SQL Preprocessor for BASIC
flags
filename
esqlc Command--Invoke Embedded SQL Preprocessor for C
filename
flags
esqlcbl Command--Invoke Embedded SQL Preprocessor for COBOL
flags
filename
esqlcc Command--Invoke Embedded SQL Preprocessor for C++
flags
filename
esqlf Command--Invoke Embedded SQL Preprocessor for Fortran
flags
filename
extenddb Command--Extend Database to New Location
extenddb Examples
fastload Command--Load Binary Files into Database
dbname
dbname
fastload Example
genxml Command--Export Tables Into XML Format
dbname
dbname
tablename
genxml Examples
iea Command--Start the Export Assistant
iea Example
iia Command--Start the Import Assistant
iichkemail--Verify Email Setup
iichkemail Example
iigcfid Command--Display Server ID
server_process
server_process
iigcfid Example
iigenres Command--Generate CONFIG.DAT File
host
host
rule_map
iigenres Example
iigetres Command--Get the Value of a Resource
name
iiinitres Command--Install Parameter into CONFIG.DAT
resource
iijdbcprop Command--Generate Sample JDBC Driver Properties File
iijdbcprop Examples
iilink Command--Install User-defined Data Type
iimkcluster Command--Convert Ingres Instance to Cluster Node
iimklog Command--Generate Transaction Log File
iimonitor Command--Administer DBMS, Recovery, and GCF Servers
server_id
server_id
iimonitor Utility Commands
Help Command
Show Server Command
Show Sessions Command
ssssssss
tt
Format Sessions Command
Set Server Command
Stop Server Command
iimonitor Commands That Perform Actions on Sessions
session_id
dmtstatrcpstats Command
delay
Quit Command
iimonitor Commands Specific to GCF Servers
attribute value
iinamu Command--Administer the Name Server
gateway
gateway
obj_name
iinamu Example: Show All Registered Servers
iinamu Example: Show All DBMS Servers for the Server Class Ingres
iinamu Example: Show Communications Server Registrations
iinamu Example: Add a DBMS Server to the Name Server Registry
iinamu Example: Delete a DBMS Server from the Name Server Registry
iinamu Example: Stop the Name Server
iinethost Command--Echo Full Network Name of Local Host
iiodbcadmin Command--Run ODBC Administrator
dsnName
dsnName
iiodbcadmin Examples
iiodbcinst Command--Create ODBC Configuration File
iiodbcinst Example
iipmhost Command--Echo Name of Host
outfile
iiremres Command--Remove Parameter from CONFIG.DAT
name
name
iiremres Example
iisetres Command--Set Configuration Parameter
name
name
value
iisetres Examples
iishowres Command--Display Memory Used by Locking and Logging
iisunode Command--Set Up Node in a Cluster
iisuodbc Command--Run iiodbcinst Utility
iiuncluster Command--Convert Cluster to Standalone Instance
iivalres Command--Validate Configuration Resource
name
name
value
rule_map
iivalres Example
iizic Command--Customize Time Zone Table Files
timezone_rule_file
iizck Command--Display Time Zone Table Files
iizck Example
imageapp Command--Build ABF or Vision Application Image
dbname
applname
infodb Command--Display Database Information
dbname
dbname
Infodb Command Output--Database Information Section
Infodb Command Output--Journal Information Section
Infodb Command Output--Dump Information Section
Infodb Command Output--Checkpoint History for Journal Section
Infodb Command Output--Checkpoint History for Dump Section
Infodb Command Output--Cluster Journal History Section
Infodb Command Output--Extent Directory Section
ingmenu Command--Start Ingres Menu
dbname
dbname
ingmenu Examples
ingnet Command--View and Define Ingres Net Node Definitions
ingstart Command--Start an Ingres Instance
ingstart Examples
ingstop Command--Stop an Ingres Instance
ingprenv Command--Display Environment Variable Value
ingprenv Example
ingsetenv Command--Set Ingres Environment Variable
value
value
ingsetenv Example
ingstatus Command--Show Server Status
ingunset Command--Delete Environment Variable
variable_name
ipm Command--Start the Interactive Performance Monitor
iquel Command--Start Interactive QUEL Terminal Monitor
SQL option flags
SQL option flags
dbname
iquel Example
isql Command--Start Interactive SQL Terminal Monitor
dbname
dbname
isql Examples
ivm Command--Start Ingres Visual Manager
lartool Command--Start Logging, Archiving, and Recovery Utility
lartool Example
lockstat Command--Display Locking Status
Lockstat Command Output
Lockstat Command Output--Locking System Summary
Lockstat Command Output--Locking System Statistics
Lockstat Command Output--Statistics by Lock Type
Lockstat Command Output--Locks by Lock List
Lockstat Command Output--Locks by Resource
Lockstat Command Output--DLM Locks
logstat Command--Display Logging Status
Logstat Command Output--Logging System Summary
Logstat Command Output--Current Log File Header
Logstat Command Output--List of Active Processes
Logstat Command Output--List of Active Databases
Logstat Command Output--List of Transactions
logstat Example: Determine Databases that Are Active
logstat Example: Determine Proximity to FORCE-ABORT-LIMIT
mkrawarea Command--Make a Raw Area File
mkrawlog Command--Make a Raw Log File
mkrc Command--Generate System Service Script
modifyfe Command--Modify Storage Structure of Catalog
dbname
product
movedb Command--Copy Data Locations to Another Machine
netutil Command--Start Network Management Utility
netutil Examples
optimizedb Command--Generate Statistics for the Query Optimizer
dbname
dbname
Optimizedb -z Flags
optimizedb Example: Generate Full Statistics for a Database
optimizedb Example: Generate Statistics for Certain Columns
optimizedb Example: Generate Statistics for Certain Columns and Values, in Verbose Mode
optimizedb Example: Allow Unique Values from Each Column in a Table
printform Command--Print a Form to a File
dbname
dbname
form
filename
printform Example
qbf Command--Start Query-By-Forms
dbname
dbname
querytarget
qbf Examples
quel Command--Start the Line-based QUEL Terminal Monitor
line-mode flags
line-mode flags
dbname
quel Examples
query Command--Invoke QBF Query Execution
query Examples
rbf Command--Start Report-By-Forms
dbname
dbname
rbf Examples
rcpconfig Command--Control Logging and Locking System
rcpstat Command--Display Logging System Status
reconcil Command--Assist in Recovering Lost Data
target_db_number
target_db_number
reconcil Example: Perform Disaster Recovery
relocatedb Command--Move a Location to a New Location
dbname
dbname
relocatedb Example: Relocate Checkpoint Files
relocatedb Example: Relocate Journal Files
relocatedb Example: Relocate Dump Files
relocatedb Example: Relocate the Work Area
relocatedb Example: Copy Database to a New Database
repcat Command--Create and Load Replicator Catalogs
dbname
dbname
repcat Examples
repcfg Command--Configure Replicator
dbname
dbname
obj_type
action
object
repcfg Examples
repdbcfg Command--Configure Multiple Mobile Databases
user_name
user_name
db_no
dbname
cdds_no
target_type
repdbcfg Examples
repinst Command--Create or Remove Replicator Servers and Windows Services
num_servers
num_servers
repinst Examples
repmgr Command--Start Replicator Manager
repmgr Example
repmod Command--Modify Replicator System Tables Storage Structure
report Command--Run a Report on a Table
dbname
dbname
report_target
report Examples
repstat Command--Display Replicator Transaction Statistics
rmcmdgen Command--Generate VDBA Remote Command Catalogs
rmcmdrmv Command--Remove VDBA Remote Command Catalogs
rmcmdstp Command--Stop the Remote Command Process
rollforwarddb Command--Recover a Database
dbname
dbname
rollforwarddb Examples
rpserver Command--Start Replicator Server
n
rsstatd Command--Display Replicator Server Statistics
sql Command--Start the Line-based SQL Terminal Monitor
line-mode flags
line-mode flags
dbname
sql Examples
Terminal Monitor Command Summary
sreport Command--Store Report Definition in a Database
dbname
dbname
filename
sreport Example
starview Command--Start StarView
vnode
vnode
starview Example
statdump Command--Print Statistics in iistats and iihistogram Catalogs
SQL option flags
SQL option flags
dbname
statdump Examples
syscheck Command--Display and Verify System Resources
sysmod Command--Modify System Catalogs to Current Storage Structure
dbname
tablename
tables Command--Start the Tables Program
dbname
dbname
tables Example
unextenddb Command--Unextend a Database Location
unloaddb Command--Create Command Files for Unloading and Reloading a Database
dbname
dbname
unloaddb Example: Unload and Reload a Database
unloaddb Example: Unload a Database, Specifying Source and Destination Directories
unloaddb Example: Unload a Database from the $HOME Directory
upgradedb Command--Upgrade a Database
dbname
upgradefe Command--Install and Upgrade Tool Catalog Definitions
dbname
dbname
product
upgradefe Examples
usermod Command--Modify Tables to Currently Defined Storage Structure
dbname
tablename
vcbf Command--Start Configuration Manager
vcda Command--Start the Visual Configuration Differences Analyzer
snapshotfile1
snapshotfile2
vdba Command--Start Visual DBA
windowdesc
windowdesc
nodename
/server_class
vnode
objecttype objectidentifier
vdba Examples
vdbamon Command--Start Visual Performance Monitor
server_class
vdbasql Command--Start Visual SQL
server_class
vdda Command--Start the Visual Database Objects Analyzer
verifydb Command--Clean Up Databases
verifydb Examples
vifred Command--Start the Visual Forms Editor
dbname
dbname
vifred Examples
vision Command--Start Vision
dbname
applname
vmsinstal Command--Install Ingres on OpenVMS
xmlimport Command--Import XML Data into Ingres
dbname
dbname
xmlfile
xmlimport Example
Ingres 10.2
xmlimport Example