PROUTIL utility syntax

PROUTIL performs various database operations. The qualifier you enter specifies the operation, and determines the required parameters you supply.

Syntax

proutil -help db-name -C qualifier 
     [ [-userid username[-password passwrd]]|
       [ -U username -P passwrd ]
     ]
     [-Passphrase]

Parameters

-help
Displays syntax for utility and specified subcommands. If the syntax displayed ends with ellipses, type the command shown followed by -help to view subcommand syntax.
db-name
Specifies the database you are using.
-C
Specifies a particular utility or function when you use PROUTIL.
qualifier
Specifies the qualifier that you want to use. You can supply the qualifiers described in #rfi1401805055736__proutil-utility-qualifiers_JC99M1076274.
-userid username[-password passwd]| -U username -P passwd

A pair of username and password parameters are used together to support a common user authentication model to specify the user ID and password when connecting to an OpenEdge RDBMS. OpenEdge authenticates the user ID and password against the user accounts defined by the authentication system configured for the user's security domain.

Use username and password parameters to identify an authenticated database administrator.

If you do not specify a user ID and password for a database connection, OpenEdge assigns the OS process's user-id as the default user-id.

Note: You can also generate an encrypted password using the genpassword utility. For more information, see the encrypted password procedure in the Password (-P) connection parameter section of the OpenEdge Deployment: Startup Command and Parameter Reference. For more information on authentication systems and security domains, see OpenEdge Getting Started: Identity Management.
-Passphrase

For encryption-enabled databases only, specifies to prompt for a passphrase to authenticate the key store. Utilities that open the database must at a minimum authenticate as the key store user. Utilities that modify encryption policies (such as ENABLEENCRYPTION, DISABLEENCRYPTION, EPOLICY, TABLEMOVE, or INDEXMOVE) must authenticate as the key store admin. See Transparent Data Encryption for more information on encryption and key store authentication.

CAUTION: If your database is enabled for transparent data encryption and configured for manual start, you must specify -Passphrase every time the database is opened.
Note: PROUTIL and its qualifiers support the use of internationalization startup parameters such as -cpinternal codepage and -cpstream codepage. See Database Startup Parameters for a description of each database-related internationalization startup parameter.

The table below lists all of the PROUTIL qualifiers. See the appropriate section for each of the qualifiers for more detailed information.

Table 1. PROUTIL utility qualifiers
Qualifier Description
2PHASE BEGIN Enables two-phase commit.
2PHASE COMMIT Determines whether the coordinator database committed a transaction.
2PHASE END Disables two-phase commit.
2PHASE MODIFY Changes the nickname or priority of a database for two-phase commit.
2PHASE RECOVER Commits or aborts limbo transactions for a database.
AUDITARCHIVE Archives audit data from a database to a binary file.
AUDITLOAD Loads audit data from a binary file into a database.
AUDITRECONFIG Reconstruct audit data and index areas.
BIGROW Specifies the number of BI clusters available to a database.
BULKLOAD Loads data files into a database.
BUSY Determines whether the database is currently in use.
CHANALYS Displays information about free chain blocks.
CODEPAGE- COMPILER Compiles a conversion map file from text format to binary format.
CONV112 Converts an OpenEdge Release 11 database to an OpenEdge Release 12 database.
CONVCHAR Converts a database's character sector identifies a database's character set (for undefined databases).
CONVFILE Converts a text file from one character set to any other character set.
DATAMOVE Moves table or sequence data from a multi-tenant source database to a multi-tenant target database for a tenant or group.
DBANALYS Displays statistical information about index, record, and free chain blocks.
DBAUTHKEY Sets an authorization key for a database.
DBIPCS Displays status information for shared-memory segments attached by all OpenEdge databases on the system.
DBRESTRICT Enables or disables write access for processes other than a specified utility.
DEALLOCATE Deallocate a multi-tenant table from a database enabled for multi-tenancy
DESCRIBE Describes the enabled features of a database.
DISABLEAUDITING Disables auditing for a database.
DISABLEB2 Removes an area from Alternate Buffer Pool processing.
DISABLEENCRYPTION Disables transparent data encryption for a database.
DISABLEJTA Disables database participation in distributed JTA transactions.
DISABLEKEYEVENTS Disables the storage of key events for a database.
DISABLEMULTITENANCY Disables the support of multi-tenant tables.
DISABLEREADONLYPARTITIONS Disables the ability to change a partition to a read-only state in a table-partitioned database.
DISABLETABLEPARTITIONING Disables the support of table-partitioning tables.
DISPTOSSCREATELIMITS Display the block toss and create limits for all tables and LOBS in a specified area.
DUMP Performs a binary dump, which is generally faster that an ASCII dump.
DUMPSPECIFIED Performs a selective binary dump and allows you to dump by field value.
ENABLEAUDITING Enables auditing for a database.
ENABLEB2 Designates an area for Alternate Buffer Pool processing.
ENABLEENCRYPTION Enables transparent data encryption for a database.
ENABLEJTA Enables the database to participate in distributed JTA transactions.
ENABLEKEYEVENTS Enables the storage of key events for a database.
ENABLELARGEKEYS Enables large key support for a database migrated to this release.
ENABLEMULTITENANCY Enables support of multi-tenant tables.
ENABLEREADONLYPARTITIONS Enables a table-partitioned database with the ability to change a partition to a read-only state.
ENABLESTOREDPROC Enables stored procedures and triggers for 64-bit databases created prior to this release.
ENABLETABLEPARTITIONING Enables support of table-partitioning tables.
EPOLICY INFO Displays the valid ciphers for the database master key and object-level encryption and their command line cipher number.
EPOLICY MANAGE Manages encryption policies for a specified database object, or the autostart or key store status.
EPOLICY SCAN Reports on the encryption policies for the specified database object, or the autostart or key store status.
EPOLICY VIEW

Views the encryption policies for the specified database object, or the autostart or key store status.

HOLDER Determines whether the database is currently in use in single-user mode, multi-user mode, or by a utility.
IDXACTIVATE Activates an inactive index.
IDXANALYS Displays information on index blocks.
IDXBUILD Consolidates index records to use disk space as efficiently as possible; activates deactivated indexes in the database. Repairs corrupted indexes in the database.
IDXCHECK Checks database indexes to determine whether an index is corrupt, and if it is, diagnoses the problem.
IDXCOMPACT Performs index compaction online and increases space utilization of the index block to a specified compacting percentage.
IDXDEACTIVATE Deactivates an active index or indexes for databases enabled for multi-tenancy or table partitioning.
IDXFIX Checks database records and indexes to determine whether an index is corrupt or a record has a missing or incorrect index; you can scan the database, the indexes, or both. IDXFIX will also repair corrupted indexes.
IDXMOVE Moves an index from one application data area to another while the database remains online.
INCREASETO Increase certain server startup parameters when the database is online.
IOSTATS Provides current statistics for active databases. The statistics include buffered, unbuffered, and logical I/O database operations. The statistics are cumulative from database startup.
LOAD Performs a binary load.
MTIDXBUILD Rebuild an index for a tenant or group of a multi-tenant database.
MVSCH Moves schema after a database conversion.
PARTITIONMANAGE ALTER Changes the state of partitions in a table-partitioned database.
PARTITIONMANAGE COPY Copies data into a partitioned table of a table-partitioned database from a temporary source.
PARTITIONMANAGE MERGE Merges partitions of a table-partitioned database.
PARTITIONMANAGE RENAME Renames a partition of a table-partitioned database.
PARTITIONMANAGE SPLIT Splits partitions of a table-partitioned database.
PARTITIONMANAGE TRUNCATE Truncates partitions of a table-partitioned database.
PARTITIONMANAGE VIEW Displays information about partitions of a table-partitioned database.
RCODEKEY Inserts the authorization key into existing CRC-based r-code.
SETAREACREATELIMIT Sets the create limit for the specified area.
SETAREATOSSLIMIT Sets the toss limit for the specified area.
SETBLOBCREATELIMIT Sets the create limit for the specified BLOB object. This command is deprecated and replaced by SETLOBCREATELIMIT
SETBLOBTOSSLIMIT Sets the toss limit for the specified BLOB object. This command is deprecated and replaced by SETLOBTOSSLIMIT
SETLOBCREATELIMIT Sets the create limit for the specified LOB object.
SETLOBTOSSLIMIT Sets the toss limit for the specified LOB object.
SETTABLECREATELIMIT Sets the create limit for the specified table.
SETTABLETOSSLIMIT Sets the toss limit for the specified table.
TABANALYS Displays information about the degree of fragmentation for each table in a database.
TABLEMOVE Moves a table and optionally its associated indexes from one storage area to another while the database remains online.
TPIDXBUILD Rebuild indexes of a partition in a table-partitioned database.
TRUNCATE AREA Truncates application data storage areas in the specified database; use this qualifier before you remove storage areas and extents.
TRUNCATE BI Performs three functions: Uses the information in the before-image (BI) files to bring the database up to date, waits to verify that the information has been successfully written to the disk, then truncates the before-image file to its original length. Sets the BI cluster size using the Before-image Filename (-bi) parameter. Sets the BI block size using the Before-image Block Size (-biblocksize) parameter.
UPDATESCHEMA Loads the specified database with the most recent meta-schema.
UPDATEVST Loads the specified database with the most recent virtual system tables.
VIEWB2 Lists the assignment of areas and objects with respect to Alternate Buffer Pool processing
WBREAK- COMPILER Compiles the word-break table.
WORD-RULES Compiles a word-rules file.