End Journal (ENDJRN)
Where allowed to run: All environments (*ALL) Threadsafe: Yes |
Parameters Examples Error messages |
The End Journal (ENDJRN) command is used to end the journaling of changes for an object or list of objects. The object types which are supported through this interface are Data Areas (*DTAARA), Data Queues (*DTAQ), Stream Files (*STMF), Directories (*DIR), and Symbolic Links (*SYMLNK). Only objects of type *STMF, *DIR, or *SYMLNK that are in the "root" (/), QOpenSys, and user-defined file systems are supported.
All objects of the types supported by this command that are currently being journaled to a specific journal may also have journaling stopped.
For other ways to end journaling see the following commands:
- Access Paths - End Journal Access Path (ENDJRNAP)
- Physical Files - End Journal Physical File (ENDJRNPF)
- Libraries - End Journal Library (ENDJRNLIB)
- Other Objects - End Journal Object (ENDJRNOBJ)
Restrictions:
- If OBJ(*ALL) is specified, a journal name must be specified (JRN parameter).
- If a journal name and a list of object names are specified, all objects must be currently journaled to the indicated journal.
- The specified journal must be a local journal.
- At least one of parameter OBJ or OBJFID must be specified.
Top |
Parameters
Keyword | Description | Choices | Notes |
---|---|---|---|
OBJ | Objects | Single values: *ALL Other values (up to 300 repetitions): Element list |
Optional |
Element 1: Name | Path name, * | ||
Element 2: Include or omit | *INCLUDE, *OMIT | ||
OBJFID | File identifier | Values (up to 300 repetitions): Hexadecimal value | Optional |
SUBTREE | Directory subtree | *NONE, *ALL | Optional |
PATTERN | Name pattern | Values (up to 20 repetitions): Element list | Optional |
Element 1: Pattern | Character value, * | ||
Element 2: Include or omit | *INCLUDE, *OMIT | ||
JRN | Journal | Path name, *OBJ | Optional |
LOGLVL | Logging level | *ERRORS, *ALL | Optional |
Top |
Objects (OBJ)
Specifies a maximum of 300 object path names for which changes will no longer be journaled. Only objects whose path name identifies an object of type *STMF, *DIR, *SYMLNK, *DTAARA or *DTAQ are supported.
Single values
- *ALL
- All objects of the supported type that are currently being journaled to the indicated journal are to stop having their changes journaled. If *ALL is specified parameter OBJFID must not be specified.
Element 1: Name
- 'object-path-name'
- Specify the path name of the object for which changes are no longer journaled.
A pattern can be specified in the last part of the path name. An asterisk (*) matches any number of characters and a question mark (?) matches a single character. If the path name is qualified or contains a pattern, it must be enclosed in apostrophes. Symbolic links within the path name will not be followed. If the path name begins with the tilde character, then the path is assumed to be relative to the appropriate home directory.
Additional information about path name patterns is in the Integrated file system topic collection in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
Note: This parameter is Unicode-enabled. See "Unicode support in CL" in the CL topic collection in the Programming category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/ for additional information.
Element 2: Include or omit
The second element specifies whether names that match the pattern should be included or omitted from the operation. Note that in determining whether a name matches a pattern, relative name patterns are always treated as relative to current working directory.
- *INCLUDE
- The objects that match the object name pattern are to stop having their changes journaled unless overridden by an *OMIT specification.
- *OMIT
- The objects that match the object name pattern are not to be included with the objects that are to stop having their changes journaled. This overrides an *INCLUDE specification and is intended to be used to omit a subset of a previously selected path.
Top |
File identifier (OBJFID)
Specifies a maximum of 300 file identifiers (FID) for which changes are no longer journaled. FIDs are a unique identifier associated with integrated file system related objects. This field is input in hexadecimal format. Only objects whose FID identifies an object of type *STMF, *DIR, or *SYMLNK that is in the "root" (/), QOpenSys, or user-defined file systems, or objects of type *DTAARA or *DTAQ are supported.
- file-identifier
- Objects identified with the FID are no longer journaled.
Top |
Directory subtree (SUBTREE)
Specifies whether the objects in directory subtrees are to stop having their changes journaled.
Note: This parameter is ignored unless object-path-name is a directory (*DIR) object.
Note: This parameter is ignored if the OBJFID parameter is specified.
- *NONE
- Only the objects that match the selection criteria are processed. The objects within selected directories are not implicitly processed.
- *ALL
- All objects that meet the selection criteria are processed in addition to the entire subtree of each directory that matches the selection criteria. The subtree includes all subdirectories and the objects within those subdirectories.
Once the command has begun processing a specific directory subtree, the objects which will be found and processed may be affected by operations that update the organization of objects within the specified directory tree. This includes, but is not limited to, the following:
- Adding, removing, or renaming object links
- Mounting or unmounting file systems
- Updating the effective root directory for the process calling the command
- Updating the contents of a symbolic link
In order to process the directory subtree, the system code may increase the process-scoped maximum number of file descriptors that can be opened during processing. This is done so that the command is not likely to fail due to a lack of descriptors. This process-scoped maximum value is not reset when the command completes.
Top |
Name pattern (PATTERN)
Specifies a maximum of 20 patterns to be used to include or omit objects for the end journal operation.
Only the last part of the path name will be considered for the name pattern match. Path name delimiters are not allowed in the name pattern. An asterisk (*) matches any number of characters and a question mark (?) matches a single character. If the path name is qualified or contains a pattern, it must be enclosed in apostrophes. Symbolic links within the path name will not be followed.
If this parameter is not specified, the default will be to match all patterns.
Additional information about path name patterns is in the Integrated file system topic collection in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/.
Note: This parameter is Unicode-enabled. See "Unicode support in CL" in the CL topic collection in the Programming category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/ for additional information.
Note: This parameter is ignored if the OBJFID parameter is specified.
Element 1: Name pattern
- '*'
- All objects that match the input OBJ parameter are to be included into the end journal operation or omitted from the end journal operation.
- name-pattern
- Specify the pattern to either include or omit objects for the end journal operation. Only the last part of the path name will be considered for the name pattern match. Path name delimiters are not allowed in the name pattern.
Element 2: Include or omit
The second element specifies whether names that match the pattern should be included or omitted from the operation. Note that in determining whether a name matches a pattern, relative name patterns are always treated as relative to the current working directory.
- *INCLUDE
- The objects that match the object name pattern are to stop having their changes journaled unless overridden by an *OMIT specification.
- *OMIT
- The objects that match the object name pattern are not to be included with the objects that are to stop having their changes journaled. This overrides an *INCLUDE specification and is intended to be used to omit a subset of a previously selected pattern.
Top |
Journal (JRN)
Specifies the journal to which changes are currently being journaled.
Note: This parameter is Unicode-enabled. See "Unicode support in CL" in the CL topic collection in the Programming category in the IBM i Information Center at http://www.ibm.com/systems/i/infocenter/ for additional information.
- *OBJ
- The journal is determined by the system from the specified object path name or object file identifier.
- journal-path-name
- Specify the path name of the journal to which changes are currently being journaled.
Top |
Logging level (LOGLVL)
Specifies the error logging level used. This parameter is used to determine which messages will be sent.
- *ERRORS
- All diagnostic and escape messages are sent but the command will not send successful completion messages for each object. At the completion of this command, one completion message will be sent.
- *ALL
- The command sends all the messages that would be sent with *ERRORS and it will also send the successful completion message for each object.
Top |
Examples
Example 1: End All Non-Database Journaling
ENDJRN OBJ(*ALL) JRN('/qsys.lib/mylib.lib/myjrn.jrn')
This command stops the journaling of all changes to all objects of type *DIR, *STMF, *SYMLNK, *DTAARA and *DTAQ to journal /qsys.lib/mylib.lib/myjrn.jrn.
Example 2: End Journaling with Omit of Directory
ENDJRN OBJ(('/mypath' *INCLUDE) ('/mypath/myobject' *OMIT))
This command stops the journaling of all changes to all first-level objects in directory /mypath except object /mypath/myobject. Object /mypath/myobject will continue to be journaled.
Example 3: End Journaling with Pattern Selection
ENDJRN OBJ(('/mypath' *INCLUDE) ('/mypath/mysubdir' *OMIT)) SUBTREE(*ALL) PATTERN(('*.txt' *INCLUDE))
This command stops the journaling of all changes to all objects in directory /mypath of type *DIR, *STMF, and *SYMLNK that match pattern '*.txt'. Any objects within directory /mypath/mysubdir will continue to be journaled.
Example 4: End Journaling using File Identifiers
ENDJRN OBJFID(00000000000000007E09BDB000000009 00000000000000009E09BDB00000000A)
This command stops the journaling of all changes to the objects of type *DIR, *STMF, *SYMLNK, *DTAARA or *DTAQ represented by the specified file identifiers.
Example 5: End Journaling on a set of Data Areas
ENDJRN OBJ(('/qsys.lib/mylib.lib/mydata*.dtaara')) JRN('/qsys.lib/mylib.lib/myjrn.jrn')
This command stops the journaling of all changes to the objects of type *DTAARA in library MYLIB that begin with the characters 'MYDATA'.
Top |
Error messages
*ESCAPE Messages
- CPFA0D4
- File system error occurred. Error number &1.
- CPF700B
- &1 of &2 objects have ended journaling.
- CPF705A
- Operation failed due to remote journal.
- CPF9801
- Object &2 in library &3 not found.
- CPF9802
- Not authorized to object &2 in &3.
- CPF9803
- Cannot allocate object &2 in library &3.
- CPF9810
- Library &1 not found.
- CPF9820
- Not authorized to use library &1.
- CPF9825
- Not authorized to device &1.
- CPF9830
- Cannot assign library &1.
- CPF9873
- ASP status is preventing access to object.
- CPF9875
- Resources exceeded on ASP &1. Press HELP.
Top |