SQL administration API portal: Arguments by privilege groups

You can view a list of admin() and task() function arguments, which are sorted by privilege groups, with links to information about the arguments.

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.

BAR privilege group

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

FILE privilege group

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

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

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

Listen threads

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

Server mode

SQL administration API function arguments to change the server mode.

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

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.

STORAGE privilege group

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

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

Compression

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

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.

Mirroring

SQL administration API function arguments to manage mirroring.

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.


Copyright© 2019 HCL Technologies Limited