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.
- Compression arguments
- Configuration parameter arguments
- Data, partition, and extent arguments
- Database arguments
- Enterprise replication arguments
- High availability arguments
- Listen thread arguments
- Log arguments
- Message log arguments
- Memory arguments
- Mirror arguments
- Parallel database query (PDQ) arguments
- Server mode arguments
- Space arguments
- Storage provisioning arguments
- SQL tracing arguments
- Miscellaneous arguments
Backup arguments
Use the following SQL administration API function arguments to backup your 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.
| 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.
Database arguments
Use the following SQL administration API function arguments to create and drop 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.
| 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.
| 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).
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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
Storage provisioning arguments
Also use the following SQL administration API function arguments to manage chunks, blobspaces, dbspaces, and sbspaces.
SQL statement cache arguments
Use the following SQL administration API function arguments to manage the SQL statement cache.
| 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.
| 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.
| 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 |