Administration Tools - oocheck

Printer-friendly version
Checks the consistency of the specified federated database or a portion of it.
oocheck
[-id oid | -db dbSysName [-cont contSysName]
| -ap apSysName | -jnl jnlFileName | -schema]
[-fd | -databases | -containers | -pages | -objects
| -relationships]
[-outfile filename [-exists ask | delete | quit]]
[-maxerrors value]
[-noindex]
[-noscopename]
[-lockwait seconds]
[-standalone]
[-notitle]
[-verbose]
[-help]
[bootFilePath]
Options
-id oid
Identifier of the object to be checked. You can specify:
n
The integer identifier of a database (for example, 78). This option also accepts the identifier specified in D-C-P-S format (for example, 78-0-0-0).
n
The object identifier in D-C-P-S format of a container (for example, 78-16-1-1), a logical page (for example, 78-16-43-0), or a basic object (for example, 78-16-43-5).
This option checks the specified object, the objects that contain it, and any objects it contains.
Omitting this option (and all its alternatives) allows the check to include all databases and their contents.
-db dbSysName
System name of a particular database to be checked. This option checks the specified database and its contents.
Omitting this option (and all its alternatives) allows the check to include all databases and their contents.
-cont contSysName
System name of a particular container to be checked. If you use this option, you must also use the -db option to specify the database that contains this container.
This option checks the specified database, the specified container, and the container’s contents.
Omitting this option allows the check to include all containers within the specified database.
-ap apSysName
(HA) System name of a particular autonomous partition to be checked. Specifying this option checks all databases with an image in the specified partition, and the contents of those databases.
Omitting this option (and all its alternatives) allows the check to include all databases and their contents.
-jnl jnlFileName
Filename of a particular journal file to be checked. Checking a journal file ensures that its contents can be read and interpreted by Objectivity/DB.
Specifying this option causes other options to be ignored (except for output-related options).
-schema
Checks just the schema of the specified federated database. Checking a schema ensures, among other things, that its physical storage is intact and that the definitions of all bidirectional relationships are complete.
Specifying this option causes other options to be ignored (except for output-related options).
-fd
Performs top-level checking only. Specifying this option checks the structures maintained by the federated database, such as the global catalog, federation-wide indexes, and so on.
Omitting this option (and all its alternatives) is equivalent to specifying -relationships.
-databases
Performs checking down to the database level. Specifying this option checks:
n
The structures maintained by databases, such as database-wide indexes, catalogs of containers, and so on.
n
The structures indicated by the -fd option.
Omitting this option (and all its alternatives) is equivalent to specifying -relationships.
-containers
Performs checking down to the container level. Specifying this option checks:
n
The structures maintained by containers, such as page maps, free lists, container-wide indexes, and so on.
n
The structures indicated by the -fd and -databases options.
Omitting this option (and all its alternatives) is equivalent to specifying -relationships.
-pages
Performs checking down to the page level. Specifying this option checks:
n
Logical pages (for space usage, consistency with page maps, and so on).
n
The structures indicated by the -fd, -databases, and -containers options.
Omitting this option (and all its alternatives) is equivalent to specifying -relationships.
-objects
Performs checking down to the basic-object level. Specifying this option checks:
n
Basic objects (for existence, accessibility, valid attribute types, consistency with the schema, and so on).
n
Persistent collections (for well-formedness, valid references, and so on).
n
The structures indicated by the -fd, -databases, -containers and -pages options.
Omitting this option (and all its alternatives) is equivalent to specifying -relationships.
-relationships
(Default) Performs checking down to the relationship (association) level. Specifying this option checks:
n
Relationships and reference attributes (for validity and accessibility).
n
The structures indicated by the -fd, -databases, -containers, -pages, and -objects options.
-outfile fileName
Name of the file (including any filename extension) in which to write the generated report as ASCII text. You can omit this option to send all output to stdout. The generated report contains Objectivity/DB error messages and descriptions of any found problems.
-exists ask | delete | quit
Action to take if the file specified with the -outfile option already exists.
ask Prompts whether to overwrite the existing file. If the answer is No, the program terminates. No is the default.
delete Deletes any existing file.
quit Terminates the program if the file currently exists.
The default value is ask.
-maxerrors value
Maximum number of errors to report before terminating. If you omit this option, all errors are reported.
-noindex
Omits indexes from the items being checked. (Checking indexes can be time-consuming.)
-noscopename
Does not verify the scope name of the items being checked.
-lockwait seconds
Number of seconds to wait to obtain a lock. If you omit this option, the default is 10 seconds.
-standalone
Nonconcurrent mode. Use this option if no lock server is running or to bypass a running lock server.
Warning: Corruption can occur if concurrent access to the federated database is attempted while any process is using this mode.
-notitle
Suppresses the copyright notice and program title banner. Useful when invoking the tool from another tool or product.
-verbose
Includes additional detail in the generated report.
-help
Prints the tool syntax and definition to the screen.
bootFilePath
Path to the boot file of the federated database to be checked. You can omit this argument if you set the OO_FD_BOOT environment variable to the correct path. (HA) You can specify the boot file of any autonomous partition.
Discussion
This tool checks user-created structures as well as Objectivity/DB internal structures in a federated database.
To check a portion of a federated database’s storage hierarchy, you can combine at most one option from each of the following groups:
n
Use the -id, -db, or -ap option to select one or more branches of the storage hierarchy for oocheck to traverse. Omitting these options selects all branches—that is, all databases and their contents.
n
Use the -fd, -databases, -containers, -pages, -objects, or -relationships option to indicate the depth of checking along the selected branch(es). Checking starts at the federated-database level and proceeds to the specified level. Omitting these options checks all levels, down to relationships.
In the following table, each valid combination of oocheck options is indicated by a check mark (3).
-fd
-databases
-containers
-pages
-objects
-relationships
-id basicObjectId
3
3
-id pageId
3
3
3
-id containerId
3
3
3
3
-id dbId or
-db dbSysName
3
3
3
3
3
-ap apSysName
3
3
3
3
3
(Default: all databases)
3
3
3
3
3
3
To check the federated database’s schema, you specify the -schema option. To check a particular journal file, you specify the -jnl option. You cannot combine -schema or -jnl with any of the options in the previous table.

Date: 
Tuesday, October 30, 2012
Product: 
Objectivity/DB
Version: 
10.2.1
10.2
10.1.4
10.1.2
9.4.1