Syntax

Home | Previous Page | Next Page Administrative Utilities > The oncheck Utility >

Syntax

oncheck Options
 
>>-oncheck------------------------------------------------------>
 
>--+-+- -ce-+-------------------------------------------------------------------+-->
   | +- -pe-+                                                                   |
   | +- -cr-+                                                                   |
   | +- -pr-+                                                                   |
   | +- -cR-+                                                                   |
   | '- -pR-'                                                                   |
   +-+- -ci-+--+---+--database--+---------------------------------------+-------+
   | +- -cl-+  '-x-'            '-:--+--------+--table--+-------------+-'       |
   | +- -pk-+                        '-owner.-'         '-#index_name-'         |
   | +- -pK-+                                                                   |
   | +- -pl-+                                                                   |
   | '- -pL-'                                                                   |
   +-+- -cd-+--database--+-------------------------------------+----------------+
   | '- -cD-'            '-:--+--------+--table--+-----------+-'                |
   |                          '-owner.-'         '-,frag_dbs-'                  |
   +-+- -cc-+--+----------+-----------------------------------------------------+
   | '- -pc-'  '-database-'                                                     |
   +-+- -pB-+--database--+-------------------------------------+----------------+
   | +- -pt-+            '-:--+--------+--table--+-----------+-'                |
   | '- -pT-'                 '-owner.-'         '-,frag_dbs-'                  |
   +-+- -pd-+--+-database--+------------------------------------------------+-+-+
   | '- -pD-'  |           '-:--+--------+--table--+-----------+--+-------+-' | |
   |           |                '-owner.-'         '-,frag_dbs-'  '-rowid-'   | |
   |           '-tblspacenum--+-----------------+-----------------------------' |
   |                          '-logical pagenum-'                               |
   +- -pp--+-database--:--+--------+--table--+-----------+--rowid-+-------------+
   |       |              '-owner.-'         '-,frag_dbs-'        |             |
   |       '-tblspacenum--logical pagenum-------------------------'             |
   +- -pP--chunknum--logical pagenum--------------------------------------------+
   +-+- -cs-+--+---------+------------------------------------------------------+
   | '- -cS-'  '-sbspace-'                                                      |
   +-+- -ps-+--+---------------------------+------------------------------------+
   | '- -pS-'  '-sbspace--partnum--pagenum-'                                    |
   +- -u--option--+------------------+------------------------------------------+
   |              '-(--arg_string--)-'                                          |
   '-+- -cv-+--| -cv/-pv Options |----------------------------------------------'
     '- -pv-'
 
>--+-----+--+-----+--------------------------------------------><
   +- -n-+  '- -q-'
   '- -y-'
 
-cv/-pv Options:
 
|--+---+--db1--+---------+--:--+--------+--+--------+--db2------>
   +-b-+       '-@server-'     '-owner.-'  '-object-'
   +-c-+
   +-o-+
   +-t-+
   '-u-'
 
>--+---------+--:--+--------+--+--------+-----------------------|
   '-@server-'     '-owner.-'  '-object-'

Element	Purpose	Key Considerations
-cc	Checks system catalog tables for the specified database	References: See Check System Catalog Tables with -cc.
-cd	Reads all pages except simple large objects from the tblspace for the specified database, table, or fragment and checks each page for consistency Also checks tables that use a user-defined access method	Restrictions: Does not check simple or smart large objects. References: See Check Pages with -cd and -cD.
-cD	Same as -cd but also reads the header of each blobpage and checks it for consistency	Restrictions: Checks simple large objects but not smart large objects. References: See Check Pages with -cd and -cD .
-ce	Checks each chunk-free list and corresponding free space and each tblspace extent. Also checks smart-large-object extents and sbspace metadata	Additional Information: The oncheck process verifies that the extents on disk correspond to the current control information that describes them. References: See Check the Chunk Free List with -ce and -pe. For background information, see Next-Extent Allocation.
-ci	Checks the ordering of key values and the consistency of horizontal and vertical node links for all indexes associated with the specified table Also checks indexes that use a user-defined access method	References: See Check Index Node Links with -ci and -cI.
-cI	Same as -ci but also checks that the key value tied to a rowid in an index is the same as the key value in the row	References: See Check Index Node Links with -ci and -cI.
-cr	Checks each of the root dbspace reserved pages for several conditions	References: See Check Reserved Pages with -cr and -cR.
-cR	Checks the root dbspace reserved pages, physical-log pages, and logical-log pages	None.
-cs	Checks smart large object and sbspace metadata for an sbspace	References: See Check and Display Sbspaces with -cs, -cS, -ps, -pS.
-cS	Checks smart large object and sbspace metadata for an sbspace as well as extents	References: See Check and Display Sbspaces with -cs, -cS, -ps, -pS.
sbspace	Indicates optional sbspace name If not supplied, all sbspaces are checked.	None.
-n	Indicates that no index repair should be performed, even if errors are detected	Additional Information: Use with the index repair options (-ci, -cI, -pk, -pK, -pl, and -pL).
-pB	Displays statistics that describe the average fullness of blobspace blobpages in a specified table	Additional Information: These statistics provide a measure of storage efficiency for individual simple large objects in a database or table. If a table or fragment is not specified, statistics are displayed for the entire database. References: See Display Blobspace Statistics with -pB. For information about optimizing blobspace blobpage size, see the chapter on managing disk space in the IBM Informix Administrator's Guide.
-pc	Same as -cc but also displays the system catalog information as it checks the system catalog tables, including extent use for each table	None.
-pd	Displays rows in hexadecimal format	References: See Display Rows in Hexadecimal Format with -pd and -pD.
-pD	Displays rows in hexadecimal format and simple-large-object values stored in the tblspace or header information for smart large objects stored in an sbspace sbpage and simple large objects stored in a blobspace blobpage	References: See Display Rows in Hexadecimal Format with -pd and -pD.
-pe	Same as -ce but also displays the chunk and tblspace extent information as it checks the chunk free list, the corresponding free space, and each tblspace extent	None.
-pk	Same as -ci but also displays the key values for all indexes on the specified table as it checks them	References: See Display Index Information with -pk, -pK, -pl, -pL.
-pK	Same as -cI but also displays the key values and rowids as it checks them	References: See Display Index Information with -pk, -pK, -pl, -pL.
-pl	Same as -ci but also displays the key values. Only leaf-node index pages are checked	References: See Display Index Information with -pk, -pK, -pl, -pL.
-pL	Same as -cI but also displays the key values and rowids for leaf-node index pages only	References: See Display Index Information with -pk, -pK, -pl, -pL.
-pp	Displays contents of a logical page	References: See Display the Contents of a Logical Page with -pp and -pP.
-pP	Same as -pp but requires a chunk number and logical page number or internal rowid as input	References: See Display the Contents of a Logical Page with -pp and -pP.
-pr	Same as -cr but also displays the reserved-page information as it checks the reserved pages	References: See Display Reserved-Page Information with -pr and -pR.
-pR	Same as -cR but also displays the information for the reserved pages, physical-log pages, and logical-log pages	None.
-ps	Checks and displays smart-large-object and sbspace metadata for an sbspace	References: See Check and Display Sbspaces with -cs, -cS, -ps, -pS.
-pS	Checks and displays smart-large-object and sbspace metadata. Lists extents and header information for individual smart large objects	References: See Check and Display Sbspaces with -cs, -cS, -ps, -pS.
-pt	Displays tblspace information for a table or fragment	References: See Display Tblspaces for a Table or Fragment with -pt and -pT.
-pT	Same as -pt but also displays index-specific information and page-allocation information by page type (for dbspaces)	References: See Display Tblspaces for a Table or Fragment with -pt and -pT.
-q	Suppresses all checking and validation message	None.
-x	Places a shared lock on the table when you check and print an index	Additional information: Use with the -ci, -cI, -pk, -pK, -pl, or -pL options. References: See Turn On Locking with -x.
-y	Repairs indexes when errors are detected	None.
chunknum	Specifies a decimal value that you use to indicate a particular chunk	Restrictions: Value must be an unsigned integer greater than 0. Chunk must exist. Additional Information: Execute the -pe option to learn which chunk numbers are associated with specific dbspaces, blobspaces or sbspaces.
database	Specifies the name of a database that you want to check for consistency	References: Syntax must conform to the Identifier segment; see IBM Informix Guide to SQL: Syntax.
db1	Specifies the local database that contains a data type that you want to check	Additional Information: Optionally specify the local database server name using the format db1@server1.
db2	Specifies the remote database that contains a data type that you want to check	Additional Information: Optionally specify the remote database server name using the format db2@server2.
frag_dbs	Specifies the name of a dbspace that contains a fragment you want to check for consistency	Restrictions: Dbspace must exist and contain the fragment that you want to check for consistency. References: Syntax must conform to the Identifier segment; see IBM Informix Guide to SQL: Syntax.
index_name	Specifies the name of the index that you want to check for consistency	Restrictions: Index must exist on table and in database specified. References: Syntax must conform to the Identifier segment; see IBM Informix Guide to SQL: Syntax.
logical pagenum	Specifies an integer value that you use to indicate a particular page in a tblspace	Restrictions: Value must be an unsigned integer between 0 and 16,777,215, inclusive. Additional Information: Value can be expressed as an unsigned integer or hexadecimal that begins with 0x identifier.
object	Specifies the name of the DataBlade, cast, operator class, user-defined data type, or UDR that you want to check	Additional Information: If you do not specify an object name, the database server compares all objects of the same type with the same name and owner.
owner	Specifies the owner of a table	Restrictions: You must specify the current owner of the table. References: Syntax must conform to the Owner Name segment; see IBM Informix Guide to SQL: Syntax.
pagenum	Indicates the page number of the sbspace metadata portion to check and display	None.
partnum	Identifies the sbspace metadata partition to check and display	None.
rowid	Identifies the rowid of the row whose contents you want to display. The rowid is displayed as part of oncheck -pD output	Restrictions: Value must be an unsigned integer between 0 and 4,277,659,295, inclusive. Additional Information: Value can be expressed as an unsigned integer or hexadecimal that begins with 0x identifier.
sbspace	Specifies the name of the sbspace that you want to check for consistency	None.
server	Specifies the database server name	Additional Information: If you omit the database server name, oncheck uses the name that INFORMIXSERVER specifies.
table	Specifies the name of the table that you want to check for consistency	Additional Information: Table exists when you execute the utility. References: Syntax must conform to the Table Name segment; see IBM Informix Guide to SQL: Syntax.
tblspacenum	Identifies the tblspace whose contents you want to display	Restrictions: Value must be an unsigned integer between 0 and 208,666,624, inclusive. Additional Information: Value can be expressed as an unsigned integer or hexadecimal that begins with 0x identifier.