SQL administration API portal: Arguments by privilege groups

Privilege groups identify what SQL administration API commands a user can run. Some function arguments are in multiple privilege groups. Privilege groups are granted to users so that they can run the commands that they need for their jobs. By default, only user informix or the DBSA can run SQL administration API commands.

Use the grant admin argument to grant privileges and the revoke admin argument to revoke privileges.

ADMIN: The user can run all SQL administration API functions.
BAR privilege group: The user can run backup and restore functions.
FILE privilege group: The user can manage the message log and display file information.
GRANT privilege group: The user has the privilege to grant and revoke privileges.
HA privilege group: The user can run high-availability functions.
MISC privilege group: The user can administer the database server.
MONITOR privilege group: The user can run all SQL administration API functions that only display information.
OPERATOR: The user can run all SQL administration API functions except functions in the GRANT privilege group.
REPLICATION privilege group: The user can run Enterprise Replication cdr utility functions.
SQL privilege group: The user can run functions that are related to SQL statements for managing databases.
SQLTRACE privilege group: The user can run SQL tracing functions.
STORAGE privilege group: The user can run space-related functions.
TENANT privilege group: The user can run tenant database functions.
WAREHOUSE: The user can run Informix® Warehouse Accelerator administration tools. See Permissions for administering Informix Warehouse Accelerator.

BAR privilege group

The BAR privilege group includes SQL administration API function arguments to back up your databases.

Table 1. admin() and task() Function Arguments for backup and restore
Argument	Version
archive fake argument: Perform an unrecorded backup (SQL administration API)	11.50.xC1
ontape archive argument: Backup the data on your database (SQL administration API)	11.70.xC2
onbar argument: Backup the storage spaces (SQL administration API)	11.70.xC2
onsmsync argument: Synchronize with the storage manager catalog (SQL administration API)	11.70.xC2

FILE privilege group

The FILE privilege group includes SQL administration API function arguments to manage message logs and display file information.

Table 2. admin() and task() Function Arguments for Message Log Commands
Argument	Version
file status argument: Display the status of a message log file (SQL administration API)	11.10.xC3
message log rotate argument: Rotate the message log file (SQL administration API)	11.10.xC3
message log delete argument: Delete a message log file (SQL administration API)	11.10.xC3
message log truncate argument: Delete the contents of a message log file (SQL administration API)	11.10.xC3
print file info argument: Display directory or file information (SQL administration API)	11.70.xC2

GRANT privilege group

The GRANT privilege group includes SQL administration API function arguments to grant or revoke privileges for running SQL administration API commands to other users.

Table 3. admin() and task() Function Arguments for granting and revoking privileges
Argument	Version
grant admin argument: Grant privileges to run SQL administration API commands	12.10.xC1
revoke admin argument: Revoke privileges to run SQL administration API commands	12.10.xC1

HA privilege group

The HA privilege group includes SQL administration API function arguments to manage high-availability clusters.

Table 4. admin() and task() Function Arguments for high-availability cluster Commands
Argument	Version
ha make primary argument: Change the mode of a secondary server (SQL administration API)	11.50.xC1
ha rss argument: Create an RS secondary server (SQL administration API)	11.50.xC1
ha rss add argument: Add an RS secondary server to a primary server (SQL administration API)	11.50.xC1
ha rss change argument: Change the password of an RS secondary server (SQL administration API)	11.50.xC1
ha rss delete argument: Delete an RS secondary server (SQL administration API)	11.50.xC1
ha sds clear argument: Stop shared-disk replication (SQL administration API)	11.50.xC1
ha sds primary argument: Convert an SD secondary server to a primary server (SQL administration API)	11.50.xC1
ha sds set argument: Create a shared-disk primary server (SQL administration API)	11.50.xC1
ha set idxauto argument: Replicate indexes to secondary servers (SQL administration API)	11.50.xC1
ha set ipl argument: Log index builds on the primary server (SQL administration API)	11.50.xC1
ha set primary argument: Define an HDR primary server (SQL administration API)	11.50.xC1
ha set secondary argument: Define an HDR secondary server (SQL administration API)	11.50.xC1
ha set standard argument: Convert an HDR server into a standard server (SQL administration API)	11.50.xC1
ha set timeout argument: Change SD secondary server timeout (SQL administration API)	11.50.xC1
onmode and d arguments: Set data-replication types (SQL administration API)	11.50.xC1

MISC privilege group

The MISC privilege group includes SQL administration function arguments to administer the database server:

onstat
Configuration parameters
Data, partitions, and extents
Listen threads
Message log
Memory
PDQ
Server mode
SQL statement cache
Other administrative tasks

onstat

SQL administration API function arguments to monitor the database server by running onstat commands.

Table 5. admin() and task() Function Arguments for onstat Commands
Argument	Version
onstat argument: Monitor the database server (SQL administration API)	12.10.xC1

Configuration parameters

SQL administration API function arguments to update configuration parameters.

Table 6. admin() and task() Function Arguments for Configuration Parameter Commands
Argument	Version
export config argument: Export configuration parameter values (SQL administration API)	12.10xC1
import config argument: Import configuration parameter values (SQL administration API)	12.10xC1
modify config arguments: Modify configuration parameters (SQL administration API)	12.10xC1
onmode and wf arguments: Permanently update a configuration parameter (SQL administration API)	11.10.xC1
onmode and wm arguments: Temporarily update a configuration parameter (SQL administration API)	11.10.xC1
onmode, wm, and AUTO_LRU_TUNING arguments: Change LRU tuning status (SQL administration API)	11.10.xC1
reset config argument: Revert configuration parameter value (SQL administration API)	12.10xC1
reset config all argument: Revert all dynamically updatable configuration parameter values (SQL administration API)	12.10xC1
set onconfig memory argument: Temporarily change a configuration parameter (SQL administration API)	11.50.xC3
set onconfig permanent argument: Permanently change a configuration parameter (SQL administration API)	11.50.xC3

Data, partitions, and extents

SQL administration API function arguments to manage data, partitions, and extents.

Table 7. admin() and task() Function Arguments for Data, Partition, and Extent Commands
Argument	Version
check data argument: Check data consistency (SQL administration API)	11.10.xC1
check extents argument: Check extent consistency (SQL administration API)	11.10.xC1
check partition argument: Check partition consistency (SQL administration API)	11.10.xC1
checkpoint argument: Force a checkpoint (SQL administration API)	11.10.xC1
create dbaccessdemo argument: Create the demonstration database (SQL administration API)	12.10.xC1
onmode and C arguments: Control the B-tree scanner (SQL administration API)	11.10.xC1
onmode and c arguments: Force a checkpoint (SQL administration API)	11.10.xC1
print partition argument: Print partition information (SQL administration API)	11.10.xC1
set dataskip argument: Start or stop skipping a dbspace (SQL administration API)	11.10.xC1
set index compression argument: Change index page compression (SQL administration API)	11.50.xC2

Listen threads

SQL administration API function arguments to control listen threads for a SOCTCP or TLITCP network protocol without interrupting existing connections.

Table 8. admin() and task() Function Arguments for Listen Thread Commands
Argument	Version
restart listen argument: Stop and start a listen thread dynamically (SQL administration API)	11.50.xC6
start listen argument: Start a listen thread dynamically (SQL administration API)	11.50.xC6
stop listen argument: Stop a listen thread dynamically (SQL administration API)	11.50.xC6

Message log

SQL administration API function arguments to manage message logs.

Table 9. admin() and task() Function Arguments for Message Log Commands
Argument	Version
file status argument: Display the status of a message log file (SQL administration API)	11.10.xC3
message log rotate argument: Rotate the message log file (SQL administration API)	11.10.xC3
message log delete argument: Delete a message log file (SQL administration API)	11.10.xC3
message log truncate argument: Delete the contents of a message log file (SQL administration API)	11.10.xC3

Memory

SQL administration API function arguments to manage memory.

Table 10. admin() and task() Function Arguments for Memory Commands
Argument	Version
add bufferpool argument: Add a buffer pool (SQL administration API)	11.10.xC1
add memory argument: Increase shared memory (SQL administration API)	11.10.xC1
onmode and a arguments: Add a shared-memory segment (SQL administration API)	11.10.xC1
onmode and F arguments: Free unused memory segments (SQL administration API)	11.10.xC1
onmode and n arguments: Unlock resident memory (SQL administration API)	11.10.xC1
onmode and r arguments: Force residency of shared memory (SQL administration API)	11.10.xC1
scheduler lmm enable argument: Specify automatic low memory management settings (SQL administration API)	11.70.xC3 11.50xC9
scheduler lmm disable argument: Stop automatic low memory management (SQL administration API)	11.70.xC3 11.50xC9

PDQ

SQL administration API function arguments to manage PDQ.

Table 11. admin() and task() Function Arguments for PDQ Commands
Argument	Version
onmode and D arguments: Set PDQ priority (SQL administration API)	11.10.xC1
onmode and M arguments: Temporarily change decision-support memory (SQL administration API)	11.10.xC1
onmode and Q arguments: Set maximum number for decision-support queries (SQL administration API)	11.10.xC1
onmode and S arguments: Set maximum number of decision-support scans (SQL administration API)	11.10.xC1

Server mode

SQL administration API function arguments to change the server mode.

Table 12. admin() and task() Function Arguments for Server Mode Commands
Argument	Version
onmode and j arguments: Switch the database server to administration mode (SQL administration API)	11.10.xC1
onmode and m arguments: Switch to multi-user mode (SQL administration API)	11.10.xC1

SQL statement cache

SQL administration API function arguments to manage the SQL statement cache.

Table 13. admin() and task() Function Arguments for SQL Statement Cache Commands
Argument	Version
onmode and e arguments: Change usage of the SQL statement cache (SQL administration API)	11.10.xC1
onmode and W arguments: Reset statement cache attributes (SQL administration API)	11.10.xC1

Other administrative tasks

SQL administration API function arguments to manage other administrative tasks.

Table 14. admin() and task() Function Arguments for other administrative task Commands
Argument	Version
alter logmode argument: Change the database logging mode (SQL administration API)	11.10.xC1
create dbaccessdemo argument: Create the demonstration database (SQL administration API)	12.10.xC1
onmode and e arguments: Change usage of the SQL statement cache (SQL administration API)	11.10.xC1
onmode and l arguments: Switch to the next logical log (SQL administration API)	11.10.xC1
onmode and p arguments: Add or remove virtual processors (SQL administration API)	11.10.xC1
onmode and Y arguments: Change query plan measurements for a session (SQL administration API)	11.10.xC1
onmode and z arguments: Terminate a user session (SQL administration API)	11.10.xC1
onmode and Z arguments: Terminate a distributed transaction (SQL administration API)	11.10.xC1
print error argument: Print an error message (SQL administration API)	11.10.xC1
reset sysadmin argument: Move the sysadmin database (SQL administration API)	11.10.xC1
scheduler argument: Stop or start the scheduler (SQL administration API)	11.10.xC1

MONITOR privilege group

The MONITOR privilege group includes SQL administration function arguments to monitor the message log, Enterprise Replication, and compression estimates.

Table 15. admin() and task() Function Arguments for monitoring the message log, Enterprise Replication, or compression estimates
Argument	Version
cdr error, cdr finderr, cdr list repair, cdr list replicate, cdr list replicateset, cdr list server, cdr list template, cdr stats recv, and cdr stats rqm arguments cdr argument: Administer Enterprise Replication (SQL administration API)	12.10.xC1
file status argument: Display the status of a message log file (SQL administration API)	11.10.xC3
index estimate_compression argument: Estimate index compression (SQL administration API)	12.10.xC1
print error argument: Print an error message (SQL administration API)	11.10.xC1
onstat argument: Monitor the database server (SQL administration API)	12.10.xC1
table estimate_compression and fragment estimate_compression arguments table or fragment arguments: Compress data and optimize storage (SQL administration API)	11.50.xC4

REPLICATION privilege group

The REPLICATION privilege group includes SQL administration API function arguments to manage Enterprise Replication.

Table 16. admin() and task() Function Arguments for Enterprise Replication Commands
Argument	Version
cdr argument: Administer Enterprise Replication (SQL administration API)	11.50.xC3

SQL privilege group

The SQL privilege group includes SQL administration API function arguments to create and drop databases and view error messages.

Table 17. admin() and task() Function arguments for databases and error messages
Argument	Version
create database argument: Create a database (SQL administration API)	11.70.xC2
create dbaccessdemo argument: Create the demonstration database (SQL administration API)	12.10.xC1
drop database argument: Drop a database (SQL administration API)	11.70.xC2
print error argument: Print an error message (SQL administration API)	11.10.xC1

SQLTRACE privilege group

The SQLTRACE privilege group includes SQL administration API function arguments to manage SQL tracing.

Table 18. admin() and task() Function Arguments for SQL Tracing Commands
Argument	Version
set sql tracing argument: Set global SQL tracing (SQL administration API)	11.10.xC1
set sql tracing database argument: Change database tracing (SQL administration API)	11.50.xC3
set sql tracing session argument: Control tracing for a session (SQL administration API)	11.50.xC3
set sql tracing user argument: Control tracing for users (SQL administration API)	11.10.xC1
set sql user tracing argument: Set global SQL tracing for a user session (SQL administration API)	11.50.xC3

STORAGE privilege group

The STORAGE privilege group includes SQL administration API function arguments for managing the following aspects of storage:

Storage space encryption argument
Automatic table storage location arguments
Compression
Logical and physical logs
Mirroring
Storage spaces
Storage provisioning

Storage space encryption argument

SQL administration API function argument to change the master encryption key for storage space encryption.

Table 19. admin() and task() Function Arguments for storage space encryption command
Argument	Version
master_key reset argument: Change the storage space encryption key (SQL administration API)	12.10.xC8

Automatic table storage location arguments

SQL administration API function arguments to manage the list of dbspaces that store automatically allocated fragments.

Table 20. admin() and task() Function Arguments for table storage commands
Argument	Version
autolocate database add argument: Add a dbspace to the dbspace list (SQL administration API)	12.10.xC3
autolocate database anywhere argument: Add all dbspaces to the dbspace list (SQL administration API)	12.10.xC3
autolocate database argument: Specify dbspaces for automatic location and fragmentation (SQL administration API)	12.10.xC3
autolocate database off argument: Disable automatic fragmentation for a database (SQL administration API)	12.10.xC3
autolocate database remove argument: Remove a dbspace from the dbspace list (SQL administration API)	12.10.xC3

Compression

SQL administration API function arguments to manage the compression of data and to optimize storage.

Table 21. admin() and task() Function Arguments for Compression Commands
Argument	Version
index compress repack shrink arguments: Optimize the storage of B-tree indexes (SQL administration API)	12.10.xC1
index estimate_compression argument: Estimate index compression (SQL administration API)	12.10.xC1
table or fragment arguments: Compress data and optimize storage (SQL administration API)	11.50.xC4
purge compression dictionary arguments: Remove compression dictionaries (SQL administration API)	11.50.xC4

For an overview of compression and storage optimization commands, see Table and fragment compress and uncompress operations (SQL administration API).

Logical and physical logs

SQL administration API function arguments to manage logical and physical logs.

Table 22. admin() and task() Function Arguments for Log Commands
Argument	Version
add log argument: Add a new logical log (SQL administration API)	11.10.xC1
alter logmode argument: Change the database logging mode (SQL administration API)	11.10.xC1
alter plog argument: Change the physical log (SQL administration API)	11.10.xC1
drop log argument: Drop a logical log (SQL administration API)	11.10.xC1

Mirroring

SQL administration API function arguments to manage mirroring.

Table 23. admin() and task() Function Arguments for Mirror Commands
Argument	Version
add mirror argument: Add a mirror chunk (SQL administration API)	11.10.xC1
start mirroring argument: Starts storage space mirroring (SQL administration API)	11.10.xC1
stop mirroring argument: Stops storage space mirroring (SQL administration API)	11.10.xC1

Storage spaces

SQL administration API function arguments to manage chunks, blobspaces, dbspaces, and sbspaces.

Table 24. admin() and task() Function Arguments for Space Commands
Argument	Version
add chunk argument: Add a new chunk (SQL administration API)	11.10.xC1
alter chunk argument: Change chunk status to online or offline (SQL administration API)	11.10.xC1
clean sbspace argument: Release unreferenced smart large objects (SQL administration API)	11.10.xC1
create blobspace argument: Create a blobspace (SQL administration API)	11.10.xC1
create chunk argument: Create a chunk (SQL administration API)	11.10.xC1
create dbaccessdemo argument: Create the demonstration database (SQL administration API)	12.10.xC1
create dbspace argument: Create a dbspace (SQL administration API)	11.10.xC1
create sbspace argument: Create an sbspace (SQL administration API)	11.10.xC1
create sbspace with accesstime argument: Create an sbspace that tracks access time (SQL administration API)	11.70.xC4
create sbspace with log argument: Create an sbspace with transaction logging (SQL administration API)	11.70.xC4
create tempdbspace argument: Create a temporary dbspace (SQL administration API)	11.10.xC1
create tempsbspace argument: Create a temporary sbspace (SQL administration API)	11.70.xC4
drop blobspace argument: Drop a blobspace (SQL administration API)	11.10.xC1
drop chunk argument: Drop a chunk (SQL administration API)	11.10.xC1
drop dbspace argument: Drop a dbspace (SQL administration API)	11.10.xC1
drop sbspace argument: Drop an sbspace (SQL administration API)	11.10.xC1
drop tempdbspace argument: Drop a temporary dbspace (SQL administration API)	11.10.xC1
onmode and O arguments: Mark a disabled dbspace as down (SQL administration API)	11.10.xC1
print error argument: Print an error message (SQL administration API)	11.10.xC1
rename space argument: Rename a storage space (SQL administration API)	11.10.xC1
set chunk argument: Change the status of a chunk (SQL administration API)	11.10.xC1
set sbspace accesstime argument: Control access time tracking (SQL administration API)	11.10.xC1
set sbspace avg_lo_size argument: Set the average size of smart large objects (SQL administration API)	11.10.xC1
set sbspace logging argument: Change the logging of an sbspace (SQL administration API)	11.10.xC1

Storage provisioning

SQL administration API function arguments to manage chunks, blobspaces, dbspaces, and sbspaces from storage pools.

Table 25. admin() and task() Function Arguments for Storage Provisioning Space Commands
Argument	Version
create blobspace from storagepool argument: Create a blobspace from the storage pool (SQL administration API)	11.70.xC1
create chunk from storagepool argument: Create a chunk from the storage pool (SQL administration API)	11.70.xC1
create dbspace from storagepool argument: Create a dbspace from the storage pool (SQL administration API)	11.70.xC1
create plogspace: Create a plogspace (SQL administration API)	12.10.xC3
create sbspace from storagepool argument: Create an sbspace from the storage pool (SQL administration API)	11.70.xC1
create tempdbspace argument: Create a temporary dbspace (SQL administration API)	11.70.xC1
create tempsbspace from storagepool argument: Create a temporary sbspace from the storage pool (SQL administration API)	11.10.xC1
create tempdbspace from storagepool argument: Create a temporary dbspace from the storage pool (SQL administration API)	11.70.xC1
drop blobspace to storagepool argument: Return space from an empty blobspace to the storage pool (SQL administration API)	11.70.xC1
drop chunk to storagepool argument: Return space from an empty chunk to the storage pool (SQL administration API)	11.70.xC1
drop dbspace to storagepool argument: Return space from an empty dbspace to the storage pool (SQL administration API)	11.70.xC1
drop plogspace: Drop the plogspace (SQL administration API)	12.10.xC3
drop sbspace to storagepool argument: Return space from an empty sbspace to the storage pool (SQL administration API)	11.70.xC1
drop tempdbspace to storagepool argument: Return space from an empty temporary dbspace to the storage pool (SQL administration API)	11.70.xC1
drop tempsbspace to storagepool argument: Return space from an empty temporary sbspace to the storage pool (SQL administration API)	11.70.xC1
modify chunk extend argument: Extend the size of a chunk (SQL administration API)	11.70.xC1
modify chunk extendable off argument: Mark a chunk as not extendable (SQL administration API)	11.70.xC1
modify chunk extendable argument: Mark a chunk as extendable (SQL administration API)	11.70.xC1
modify space expand argument: Expand the size of a space (SQL administration API)	11.70.xC1
modify space sp_sizes argument: Modify sizes of an extendable storage space (SQL administration API)	11.70.xC1
storagepool add argument: Add a storage pool entry (SQL administration API)	11.70.xC1
storagepool modify argument: Modify a storage pool entry (SQL administration API)	11.70.xC1
storagepool delete argument: Delete one storage pool entry (SQL administration API)	11.70.xC1
storagepool purge argument: Delete storage pool entries (SQL administration API)	11.70.xC1

TENANT privilege group

The TENANT privilege group includes SQL administration API function arguments to manage tenant databases.

Table 26. admin() and task() Function Arguments for Tenant Database Commands
Argument	Version
tenant create argument: Create a tenant database (SQL Administration API)	12.10.xC4
tenant drop argument: Drop a tenant database (SQL Administration API)	12.10.xC4
tenant update argument: Modify tenant database properties (SQL Administration API)	12.10.xC4