pdplgrgst (Register and delete plug-ins)
Function
- Registers plug-ins with HiRDB.
Specifies the plug-in definition and the PIC files for the plug-in to be registered.
Executing the pdplgrgst command registers plug-in-related definition information, as well as abstract data type definitions or index-type definitions, in a dictionary.
Each execution of the pdplgrgst command registers one plug-in.
- Deletes a plug-in from HiRDB.
The command deletes the following items:
- Definition information about plug-ins that are registered in a data dictionary
- Functions, abstract data types, and index data types that are supplied by a plug-in
- Upgrades plug-in versions.
Updates the definition information, functions, abstract data type definitions, and index data type definitions of previously registered plug-ins.
Executor
Users with DBA privileges can execute this command.
Format
pdplgrgst [-{d|a} [-u]
plug-in-definition-filename PIC-filename
Options
Specify this option when deleting a plug-in or upgrading a plug-in to a new version. The default is to register a plug-in with HiRDB.
- -d
- This option deletes a plug-in.
- -a
- This option upgrades a plug-in to a new version.
Specifies that the plug-in's owner is to be set to the executor of the pdplgrgst command (to the authorization identifier specified in PDUSER in the client environment definitions) rather than to MASTER.
When specifying a plug-in owner other than MASTER, note the following:
- The pdplgrgst command executor's schema must already be defined.
- If the plug-in provides both abstract data and index types, be sure to specify the same owner.
- Only a plug-in owner can delete or upgrade his/her plug-in. To delete or upgrade a plug-in, specify the -u option in the pdplgrgst command.
- If you change the plug-in owner during upgrading, the functions may become invalid. In such cases, use ALTER ROUTINE to re-create the SQL objects for the functions.
- If you delete a plug-in owner's schema, his/her plug-in is also deleted. In this case, do the following:
- Delete the pdplugin operand from the system common definitions.
- Execute the pdplgset -d command on all server machines to set up the plug-in.
Command arguments
- plug-in-definition-filename
Specifies the file name of a plug-in definition file.
Specify a file name in the command input current directory or a file name including its absolute path.
Specifies the file name of a PIC file.
Specifies a file name in the command input current directory or a file name including its absolute path.
Rules
- The pdplgrgst command can be executed only when HiRDB is running.
- Execute the pdplgrgst command on an appropriate server machine.
- To execute the pdplgrgst command, you must have already set PDHOST, PDNAMEPORT, and PDUSER in the client environment definition. For PDUSER, specify the authorization identifier and password of a user with DBA privileges.
Notes
- The results of execution of the pdplgrgst command can be checked by reviewing the return code generated from the command execution process. A command execution return code of 0 indicates normal termination; 8 indicates an abnormal termination.
- When executing the pdplgrgst command, be sure to execute it in all the HiRDB utilization environments to complete the plug-in setup process.
- To use a plug-in that was registered in the HiRDB system using the pdplgrgst command, code the name of the plug-in used in system common definitions, and then restart the HiRDB system.
- When a plug-in is being registered, no other operations can be performed on the schema associated with the plug-in.
- If the pdplgrgst command terminates abnormally during plug-in registration, a part of the type definition process may terminate prematurely. If this happens, delete the plug-in by executing the pdplgrgst command with the -d option and re-register the plug-in.
- When deleting a plug-in, delete the following items before executing the pdplgrgst command:
- Any tables that used this plug-in
- Any indexes that used this plug-in
- Any functions, procedures, and abstract data types that used the abstract data types, index types, and functions supplied by this plug-in
- When deleting a data-type plug-in, if the index-data-type plug-in that supplies the indexing function of the data type is also registered, delete the index-data-type plug-in first. For details, refer to the respective plug-in manuals.
- After deleting a plug-in, perform the following processing:
- Delete coding of the system common definition pdplugin
- Uninstall the plug-in (pdplgset -d) when deleting a file comprising the plug-in
- When upgrading a plug-in to a new version, perform the following tasks before using the pdplgrgst command:
- Back up the master directory RDAREA, the data dictionary RDAREA, the data directory RDAREA, and the data dictionary LOB RDAREA
- Set up the new plug-in
- A plug-in cannot be reset to a version older than the plug-in version registered.
- When upgrading both a data-type plug-in and an index-type plug-in that supply the indexing function for that data type, upgrade the data-type plug-in first.
- If the HiRDB/Single Server structure is changed to a HiRDB/Parallel Server structure by using the database structure modification utility (pdmod), plug-in-supplying functions may become invalidated depending on the specific plug-in registered. If this happens, re-execute the pdplgrgst command by specifying the -a option.