IBM Informix SQL Administration API Arguments

The following admin() and task() function arguments are sorted by functional category. The version numbers indicate in which version of Informix each argument was introduced. The admin() and task() functions take the same arguments, but return different values. The examples shown on this card use the task() function. The examples do not show syntax details. Many arguments can take additional alternative or optional arguments. Arguments in italics are variables. See the IBM Informix Administrators Reference for alphabetized topics about the underlined arguments.

Check partition consistency task(check partition,partition_number) Force a checkpoint task(checkpoint,block) Print partition information task(print partition,partition_number) Skip a dbspace task(set dataskip on,dbspace) Start the B-tree scanner task(onmode,C,start,number)

11.1

Change the password of an RS secondary server task(ha rss change,secondary_server,password) Delete an RS secondary server task(ha rss delete,secondary_server) Create a shared-disk primary server task(ha sds set,primary_server) Change the SD secondary server timeout task(ha set timeout,seconds) Convert an SD secondary server to a primary server task(ha sds primary,secondary_server) Stop shared-disk replication task(ha sds clear,primary_server) 11.5

Free unused memory segments task(onmode,F) Set low memory management task(scheduler lmm enable,LMM START THRESHOLD,size, LMM STOP THRESHOLD,size,LMM IDLE TIME,time); Stop low memory management task(scheduler lmm disable) 11.5 Unlock resident memory task(onmode,n) 11.5 11.1 11.1

11.1

11.1

11.5 11.1

11.1

11.1

Backup Management Database Management

Create a backup of database data task(ontape archive directory level level,location,block_size) Back up the storage spaces task(onbar backup whole system level level) Retain backup generations task(onsmsync,-g number_of_generations) 11.7 Create a database task(create database with log, database) Delete a database task(drop database, database) 11.7

Message Log Management

11.5 Delete message log contents task(message log truncate, path) Delete message log file task(file delete,path) 11.5 Display status of message log task(file status,path) 11.5 Rotate the message log task(message log rotate,path,version) 11.5 11.7 11.7 11.7

Listen Thread Control (SOCTCP or TLITCP)

Start a listen thread dynamically task(start listen,server_name) Stop a listen thread dynamically task(stop listen,server_name)

11.7

11.7

11.7

11.7

Enterprise Replication Management Compression Management

Compress fragment data task(fragment compress,partition_number) Compress table data and optimize storage task(table compress repack shrink,table,database,owner) Estimate the compression of a table task(table estimate_compression,table,database,owner) Uncompress table data task(table uncompress,table,database,owner) 11.5 Administer enterprise replication task(cdr command,options) 11.5

Stop and restart a listen thread dynamically task(restart listen,server_name)

Mirroring Management
Add a mirror chunk task(add mirror,spacename,path,offset,mirror_path, mirror_offset) Start mirroring a storage space task(start mirroring,space) Stop mirroring a storage space task(stop mirroring,space) 11.1

11.5

High Availability Cluster Management

Archive to set up a secondary server task(archive fake) Convert a secondary server to a primary server task(ha make primary,database_server) Log index builds on the primary server task(ha set ipl on) Replicate indexes to secondary servers task(ha set idxauto on) Create an HDR primary server task(ha set primary,secondary_server) Create an HDR secondary server task(ha set secondary,primary_server) Convert an HDR server into a standard server task(ha set standard) Set data-replication type to primary task(onmode,d,primary,database_server) 11.5

Log Management
Add a new logical log task(add log,dbspace,size,count,after_current_flag) Change the database logging mode task(alter logmode,database,u) Change the physical log task(alter plog,dbspace,size) Drop a logical log task(drop log,log_number) Switch to the next logical log task(onmode,l) 11.1

11.5

11.1

11.5

11.1

11.5

11.1

11.5

11.1

Configuration Parameter Updating

Set a configuration parameter for a session task(set onconfig memory,parameter,value) Set a configuration parameter in the onconfig file task(set onconfig permanent,parameter,value) Set LRU tuning status task(onmode,wm,AUTO_LRU_TUNING=value min=value, max=value) 11.5

11.5

11.1

Parallel Database Query (PDQ) Management

Set maximum number of decision-support queries task(onmode,Q,queries) Set maximum number of decision-support scans task(onmode,S,scans) Set PDQ priority task(onmode,D,max_priority) Temporarily change memory for parallel queries task(onmode,M,size) 11.1

11.5

11.1

11.5

11.1

11.5

Memory Management
Add a buffer pool 11.1 Task(add bufferpool,page_size,buffers,lrus,max_dirty,min_dirty) Add shared memory task(add memory,size) Add a shared-memory segment task(onmode,a,size) Force residency of shared memory task(onmode,r) 11.1

11.1

11.1

11.5

11.1

Data, Partition, and Extent Management

Change index page compression to high task(set index compression,partition_number,high) Check data consistency task(check data,partition_number) Check extent consistency task(check extents,dbspace_number) 11.5

11.5

Create a remote standalone secondary server Task(ha rss,primary_server) 11.1 Add an RS secondary server to a primary server task(ha rss add,secondary_server) 11.1

11.5

11.1

Server Mode Switching

Switch the database server to administration mode task(onmode,j) Switch the database server to multi-user mode task(onmode,m) 11.1

11.5

11.1

11.1

11.5

11.1

Space Management
Add a new chunk task(add chunk,space,path,size,offset) Change chunk status to online or offline task(alter chunk online,space,path,offset) 11.1

Track access time task task(set sbspace accesstime on,sbspace)

11.1

Create a temporary dbspace from the storage pool 11.7 task(create tempdbspace from storagepool,tempdbspace,size) Return space from an empty dbspace to the storage pool task(drop dbspace to storagepool,dbspace) 11.7

SQL Statement Cache Management

Enable the SQL statement cache task(onmode,e,enable) Reset statement cache attributes task(onmode,W ,STMT_CACHE_HITS,hits) 11.1

11.1

Return space from an empty temp. dbspace to the storage pool task(drop tempdbspace to storagepool,dbspace) Create an sbspace from the storage pool task(create sbspace from storagepool,sbspace,size)

11.7

Create a blobspace 11.1 task(create with_check blobspace,blobspace,path,size,offset, page_size) Create a chunk task(create chunk,space,path,size,offset) Create a dbspace task(create dbspace,dbspace,path,size,offset,page_size, first_extsize,next_extsize) Create an sbspace task(create sbspace,sbspace,path,size,offset) 11.1

11.1

11.7

SQL Tracing management

Set tracing for a database task(set sql tracing database add,database) 11.5

Create a temporary sbspace from the storage pool 11.7 task(create tempsbspace from storagepool,tempsbspace,size) Return space from an empty sbspace to the storage pool task(drop sbspace to storagepool,sbspace) Return space from an empty temp. sbspace to the storage pool task(drop tempsbspace to storagepool,sbspace) 11.7

11.1

11.7

Set tracing globally 11.1 task(set sql tracing on,number_traces,trace_size,level,mode) Set tracing on globally for a user session task(set sql user tracing on,session) Set tracing for a session task(set sql tracing session,on) Set tracing on for a user task(set sql tracing user add,user) 11.1

11.7

Create an subspace that tracks access time 11.7 task(create subspace with accesstime,sbspace,path,size,offset) Create an subspace with transaction logging task(create subspace with log,sbspace,path,size,offset) Create a temporary dbspace task(create tempdbspace,tempdbspace,path,size,offset, page_size,first_extsize,next_extsize) Create a temporary sbspace task (create tempsbspace,tempsbspace,path,size,offset); Drop a blobspace task(drop blobspace,blobspace) Drop a chunk task(drop chunk,space,path,offset) Drop a dbspace task(drop dbspace,dbspace) Drop an sbspace task(drop sbspace,sbspace) Drop a temporary dbspace task(drop tempdbspace,tempdbspace) Log an sbspace task(set sbspace logging on,sbspace) Mark a disabled dbspace as down task(onmode,O) Release unreferenced smart large objects task(clean sbspace,sbspace) Rename a storage space task(rename space,space,new_name) Set the average size of smart large objects task(set sbspace avg_lo_size,sbspace,size) 11.7

Add a storage pool entry 11.7 task(storagepool add,path,begin_offset,total_size,chunk_size, priority) Modify a storage pool entry 11.7 task(storagepool modify,entry_id,new_total_size,new_chunk_size, new_priority) Delete one storage pool entry task(storagepool delete,entry_id) Delete all storage pool entries task(storagepool purge all) 11.7

11.1

11.5

11.1

Storage Provisioning
11.7 Expand a space task(modify space expand,space,size) Modify the create size or extend size of a space task(modify space sp_sizes,space,new_create_size, New_extend_size) Create a blobspace from the storage pool task(create blobspace from storagepool,blobspace,size) Return space from an empty blobspace to the storage pool task(drop blobspace to storagepool,blobspace) Create a chunk from the storage pool task(create chunk from storagepool,space,size) Return space from an empty chunk to the storage pool task(drop chunk to storagepool,space,path,offset) Extend the size of a chunk task(modify chunk extend,chunk,extend_amount) Mark a chunk as not extendable task(modify chunk extendable off,chunk Mark a chunk as extendable task(modify chunk extendable,chunk) Create a dbspace from the storage pool task(create dbspace from storagepool,dbspace,size) 11.7

11.7

Quick Reference:
SQL Administration API
11.1

11.1

11.7

Miscellaneous Process Management

Add virtual processors task(onmode,p,number,vpclass)

11.1

IBM Informix
11.1

11.7

11.1

Enable query plan measurements for a session task(onmode,Y,session,1) Display directory or file information task(print file info,filepath) Move the sysadmin database task(reset sysadmin,dbspace) Print an error message task(print error,number) Start the scheduler task(scheduler start) Terminate a distributed transaction task(onmode,Z,address) Terminate a user session task(onmode,z,session)

Version 11.70.xC4 SC27-3813-01

For an online version of this information with links to full argument descriptions, see the SQL Administration API Portal: http://publib.boulder.ibm.com/infocenter/idshelp/v117/topic/ com.ibm.adref.doc/ids_sapi_095.htm Send comments about this card or suggestions for additional quick reference topics to docinf@us.ibm.com, with QRC in the subject of the email. Assess the usability and consumability of IBM Informix database servers by taking this survey: http://www.ibm.com/software/data/info/consumability-survey Copyright IBM Corporation 2010, 2012 IBM, the IBM logo, and Informix are trademarks of IBM Corp., registered in many jurisdictions worldwide.

11.7

11.7

11.1

11.7

11.1

11.1

11.7

11.1

11.1

11.7

11.1

11.1

11.7

11.1

11.1

11.7

11.1

11.1

11.7

11.1