SQL administration API portal: Arguments by functional category

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

Category list

To use this section, you first determine the appropriate category from the following list, then follow the link to the SQL administration API function arguments for that category.

Backup arguments

Use the following SQL administration API function arguments to backup your databases.

Table 1. admin() and task() Function Arguments for Databases
Argument When Added to OneDB
ontape archive argument: Backup the data on your database (SQL administration API) Version 11.70.xC2
onbar argument: Backup the storage spaces (SQL administration API) Version 11.70.xC2
onsmsync argument: Synchronize with the storage manager catalog (SQL administration API) Version 11.70.xC2

Compression arguments

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

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

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

Configuration parameter arguments

Use the following SQL administration API function arguments to update configuration parameters.

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

Database arguments

Use the following SQL administration API function arguments to create and drop databases.

Table 4. admin() and task() Function Arguments for Databases
Argument When Added to OneDB
create database argument: Create a database (SQL administration API) Version 11.70.xC2
drop database argument: Drop a database (SQL administration API) Version 11.70.xC2

Data, partition, and extent arguments

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

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

Enterprise replication arguments

Use the following SQL administration API function arguments to manage Enterprise Replication.

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

High availability arguments

Use the following SQL administration API function arguments to manage high-availability replication (HDR).

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

Listen thread arguments

Use the following 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 When Added to OneDB
restart listen argument: Stop and start a listen thread dynamically (SQL administration API) Version 11.50.xC6
start listen argument: Start a listen thread dynamically (SQL administration API) Version 11.50.xC6
stop listen argument: Stop a listen thread dynamically (SQL administration API) Version 11.50.xC6

Log arguments

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

Table 9. admin() and task() Function Arguments for Log Commands
Argument When Added to OneDB
add log argument: Add a new logical log (SQL administration API) Version 11.10.xC1
alter logmode argument: Change the database logging mode (SQL administration API) Version 11.10.xC1
alter plog argument: Change the physical log (SQL administration API) Version 11.10.xC1
drop log argument: Drop a logical log (SQL administration API) Version 11.10.xC1
onmode and l arguments: Switch to the next logical log (SQL administration API) Version 11.10.xC1

Message log arguments

Use the following SQL administration API function arguments to manage message logs.

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

Memory arguments

Use the following SQL administration API function arguments to manage memory.

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

Mirror arguments

Use the following SQL administration API function arguments to manage mirroring.

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

Parallel database query (PDQ) arguments

Use the following SQL administration API function arguments to manage PDQ.

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

Server mode arguments

Use the following SQL administration API function arguments to change the server mode.

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

Space arguments

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

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

Storage provisioning arguments

Also use the following SQL administration API function arguments to manage chunks, blobspaces, dbspaces, and sbspaces.

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

SQL statement cache arguments

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

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

SQL tracing arguments

Use the following SQL administration API function arguments to manage SQL tracing.

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

Miscellaneous arguments

Use the following SQL administration API function arguments to manage miscellaneous processes.

Table 19. admin() and task() Function Arguments for Miscellaneous Commands
Argument When Added to OneDB
onmode and e arguments: Change usage of the SQL statement cache (SQL administration API) Version 11.10.xC1
onmode and p arguments: Add or remove virtual processors (SQL administration API) Version 11.10.xC1
onmode and Y arguments: Change query plan measurements for a session (SQL administration API) Version 11.10.xC1
onmode and z arguments: Terminate a user session (SQL administration API) Version 11.10.xC1
onmode and Z arguments: Terminate a distributed transaction (SQL administration API) Version 11.10.xC1
print error argument: Print an error message (SQL administration API) Version 11.10.xC1
print file info argument: Display directory or file information (SQL administration API) Version 11.70.xC2
reset sysadmin argument: Move the sysadmin database (SQL administration API) Version 11.10.xC1
scheduler argument: Stop or start the scheduler (SQL administration API) Version 11.10.xC1