ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/dspdbr.htm

451 lines
16 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Display Data Base Relations (DSPDBR)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="DSPDBR.Top_Of_Page"></a>
<h2>Display Data Base Relations (DSPDBR)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#DSPDBR.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPDBR.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPDBR.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPDBR"></a>
<p>The Display Database Relations (DSPDBR) command provides relational information about database files. It identifies the physical and logical files dependent on a specific file, files that use a specific record format, or the file members that are dependent on a specific file member. The information can be displayed, printed, or placed in a database output file. This command does not apply to device files.
</p>
<p>If the information is put in a database output file, the record format that is used is named QWHDRDBR. The fields in record format QWHDRDBR are the same as the fields in the IBM-supplied format QWHDRDBR in file QADSPDBR in the library QSYS. The following information is contained in the database output file:
</p>
<ul>
<li>For each file specified in the command, the database record contains:
<ul>
<li>The name of the specified file, its library name, and the file type of the specified file
</li>
<li>The name of the record format used for the file, if a name is specified for RCDFMT
</li>
<li>The information retrieval date(s) for the file information; the latest date contains the most accurate information, if changes have been made to the files
</li>
</ul>
</li>
<li>One of the following is also included in the record:
<ul>
<li>The names of all the files that are dependent on the specified file for access path sharing or data sharing; the names of the libraries containing the files and the type of sharing are also included
</li>
<li>The names of all the file members that are dependent on the specified member, their library names, and the type of sharing
</li>
<li>The names of all the files that are dependent on the specified record format, and their library names
</li>
</ul>
</li>
</ul>
<p><b>Restrictions:</b>
</p>
<ol>
<li>To show each file specified, the user must have object operational authority for the file. Also, of the libraries specified by the library qualifier, only the libraries for which the user has *USE authority are searched for the files.
</li>
<li>To create an OUTFILE, the user must have *USE authority to the Create Physical File (CRTPF) command and *ADD authority to the library. To use an existing OUTFILE, the user must have operational (*OPR) and *ADD authority to the file.
</li>
<li>The user must have object management and delete authority also, if *REPLACE is specified.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPDBR.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPDBR.FILE"><b>FILE</b></a></td>
<td valign="top">File</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: File</td>
<td valign="top"><i>Generic name, name</i>, *ALL</td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB, *USRLIBL, *ALLUSR, *ALL</td>
</tr><tr>
<td valign="top"><a href="#DSPDBR.OUTPUT"><b>OUTPUT</b></a></td>
<td valign="top">Output</td>
<td valign="top"><b><u>*</u></b>, *PRINT, *OUTFILE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPDBR.OUTFILE"><b>OUTFILE</b></a></td>
<td valign="top">File to receive output</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: File to receive output</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#DSPDBR.OUTMBR"><b>OUTMBR</b></a></td>
<td valign="top">Output member options</td>
<td valign="top"><i>Element list</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Element 1: Member to receive output</td>
<td valign="top">
<i>Name</i>, <b><u>*FIRST</u></b></td>
</tr>
<tr>
<td valign="top">Element 2: Replace or add records</td>
<td valign="top">
<b><u>*REPLACE</u></b>, *ADD</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDBR.MBR"><b>MBR</b></a></td>
<td valign="top">Member</td>
<td valign="top"><i>Name</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#DSPDBR.RCDFMT"><b>RCDFMT</b></a></td>
<td valign="top">Record format</td>
<td valign="top"><i>Generic name, name</i>, *NONE, *ALL</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPDBR.FILE"></a>
<h3>File (FILE)</h3>
<p>Specifies the name and library of the files about which relational information is shown, printed, or placed in an output file.
</p>
<p>This is a required parameter.
</p>
<p>The possible values for file names are:
</p>
<dl>
<dt><b><i>file-name</i></b></dt>
<dd>Specify the full name of a file. Information is shown for this file only.
</dd>
<dt><b><i>generic*-file-name</i></b></dt>
<dd>Specify a generic file name. Information is provided for all database files whose names begin with the specified characters.
</dd>
<dt><b>*ALL</b></dt>
<dd>Information is provided for all files in the library or libraries.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
</dd>
</dl>
<dl>
<dt><b>*USRLIBL</b></dt>
<dd>If a current library entry exists in the library list for the current thread, the current library and the libraries in the user portion of the library list are searched. If there is no current library entry, only the libraries in the user portion of the library list are searched.
</dd>
</dl>
<dl>
<dt><b>*ALLUSR</b></dt>
<dd>All user libraries are searched. All libraries with names that do not begin with the letter Q are searched except for the following:
<p>
<pre>
#CGULIB #DSULIB #SEULIB
#COBLIB #RPGLIB
#DFULIB #SDALIB
</pre>
</p>
<p>Although the following Qxxx libraries are provided by IBM, they typically contain user data that changes frequently. Therefore, these libraries are considered user libraries and are also searched:
</p>
<p>
<pre>
QDSNX QRCLxxxxx QUSRIJS QUSRVxRxMx
QGPL QSRVAGT QUSRINFSKR
QGPL38 QSYS2 QUSRNOTES
QMGTC QSYS2xxxxx QUSROND
QMGTC2 QS36F QUSRPOSGS
QMPGDATA QUSER38 QUSRPOSSA
QMQMDATA QUSRADSM QUSRPYMSVR
QMQMPROC QUSRBRM QUSRRDARS
QPFRDATA QUSRDIRCL QUSRSYS
QRCL QUSRDIRDB QUSRVI
</pre>
</p>
<ol>
<li>'xxxxx' is the number of a primary auxiliary storage pool (ASP).
</li>
<li>A different library name, in the format QUSRVxRxMx, can be created by the user for each previous release supported by IBM to contain any user commands to be compiled in a CL program for the previous release. For the QUSRVxRxMx user library, VxRxMx is the version, release, and modification level of a previous release that IBM continues to support.
</li>
</ol>
</dd>
</dl>
<dl>
<dt><b>*ALL</b></dt>
<dd>All libraries in the system, including QSYS, are searched.
</dd>
</dl>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDBR.OUTPUT"></a>
<h3>Output (OUTPUT)</h3>
<p>Specifies whether the output from the command is displayed at the requesting work station or printed with the job's spooled output.
</p>
<dl>
<dt><b><u>*</u></b></dt>
<dd>The output is displayed (if requested by an interactive job) or printed with the job's spooled output (if requested by a batch job).
</dd>
</dl>
<dl>
<dt><b>*PRINT</b></dt>
<dd>The output is printed with the job's spooled output.
</dd>
</dl>
<dl>
<dt><b>*OUTFILE</b></dt>
<dd>The output is directed to the database output file specified on the <b>File to receive output</b> prompt (OUTFILE parameter).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDBR.OUTFILE"></a>
<h3>File to receive output (OUTFILE)</h3>
<p>Specifies the name and library of the database output file to which the output of the command is directed. If the file does not exist, this command creates a database output file in the specified library.
</p>
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the file. If no current entry exists in the library list, QGPL is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library where the file is located.
</dd>
</dl>
<p>
<b>Note: </b>The outfile format must be the same as QWHDRDBR of system file QADSPDBR in the QSYS library. For more information on the outfile format, refer to Database information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter book.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDBR.OUTMBR"></a>
<h3>Output member options (OUTMBR)</h3>
<p>Specifies the name of the database file member that receives the output of the command.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member in the file receives the output. If no members exist in the file, the system creates a member with the name of the file specified in the <b>File to receive output</b> prompt (OUTFILE parameter).
</dd>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the name of the file member that receives the output. If the name does not exist, the system creates it.
</dd>
</dl>
<p>The possible values for how information is stored are:
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The output data replaces any existing records in the specified file member.
</dd>
<dt><b>*ADD</b></dt>
<dd>The output data is added to the end of existing records in the specified file member.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDBR.MBR"></a>
<h3>Member (MBR)</h3>
<p>Specifies the name of the member in a database file whose dependent member information is shown, printed, or placed in an output file.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No information about the file members is provided.
</dd>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the full name of the file member. Information for this particular file member is provided. If a member name is specified, a record format name cannot be specified on the <b>Record format</b> prompt (RCDFMT parameter).
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPDBR.RCDFMT"></a>
<h3>Record format (RCDFMT)</h3>
<p>Specifies the name of the record format for which dependent information is shown, printed, or placed in a database file. If this parameter is specified, a member name cannot be specified for the <b>Member</b> prompt (MBR parameter).
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><i>record-format-name</i></b></dt>
<dd>Specify the full name of the record format. Information for this particular record format is provided.
</dd>
<dt><b><i>generic*-record-format-name</i></b></dt>
<dd>Specify a generic name. Information is provided for all record formats with names that begin with the specified characters.
</dd>
<dt><b>*NONE</b></dt>
<dd>No dependent record format information is provided.
</dd>
<dt><b>*ALL</b></dt>
<dd>Information about all record formats in the specified files is provided.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPDBR.COMMAND.EXAMPLES">Examples</a> </h3>
<p>In the following examples, assume that there is an interactive environment and that the user of the command is authorized to access all relevant libraries and objects.
</p>
<p><b>Example 1: Displaying Database Relations Information</b>
</p>
<p>
<pre>
DSPDBR FILE(LIBRARY1/FILE1) RCDFMT(FORMAT1)
</pre>
</p>
<p>This command shows a list of the names and database relations information for all files that use the FORMAT1 format and are associated with FILE1 in LIBRARY1. Because the environment is interactive, the output is shown at the work station running this command.
</p>
<p><b>Example 2: Displaying Database Relations Information</b>
</p>
<p>
<pre>
DSPDBR FILE(LIB1/FILE1)
</pre>
</p>
<p>This command shows database relations information for all files that are dependent on FILE1 in LIB1 for data sharing. It is shown at the work station running this command.
</p>
<p><b>Example 3: Displaying Database Relations Information</b>
</p>
<p>
<pre>
DSPDBR FILE(LIB1/FILE1) MBR(MEMBER1)
</pre>
</p>
<p>This command shows database relations information for all members that are dependent on MEMBER1 in FILE1 in LIB1 for data sharing or access path sharing. They are shown at the work station running this command.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPDBR.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF3010</b></dt>
<dd>No database files found for &amp;1 in &amp;2.
</dd>
<dt><b>CPF3012</b></dt>
<dd>File &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF3014</b></dt>
<dd>No file specified as &amp;1 in &amp;2 can be displayed.
</dd>
<dt><b>CPF3028</b></dt>
<dd>Record format &amp;1 not found in file &amp;2.
</dd>
<dt><b>CPF3029</b></dt>
<dd>Member &amp;1 not found in file &amp;2 in &amp;3.
</dd>
<dt><b>CPF3052</b></dt>
<dd>Description for file &amp;1 not available.
</dd>
<dt><b>CPF3061</b></dt>
<dd>Record format &amp;3 not found for outfile &amp;1.
</dd>
<dt><b>CPF3063</b></dt>
<dd>Output file &amp;1 in &amp;2 not physical file.
</dd>
<dt><b>CPF3064</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF3066</b></dt>
<dd>Error creating output file &amp;1 in &amp;2.
</dd>
<dt><b>CPF3067</b></dt>
<dd>Error while opening file &amp;1 in &amp;2.
</dd>
<dt><b>CPF3068</b></dt>
<dd>Error while writing to file &amp;1 in &amp;2.
</dd>
<dt><b>CPF3069</b></dt>
<dd>Error while closing file &amp;1 in &amp;2.
</dd>
<dt><b>CPF3070</b></dt>
<dd>Error creating member &amp;3 in file &amp;1.
</dd>
<dt><b>CPF3072</b></dt>
<dd>File &amp;1 in &amp;2 is a system file.
</dd>
<dt><b>CPF3074</b></dt>
<dd>Not authorized to library &amp;1.
</dd>
<dt><b>CPF3075</b></dt>
<dd>Library &amp;1 not available.
</dd>
<dt><b>CPF3076</b></dt>
<dd>Error occurred when on display.
</dd>
<dt><b>CPF3077</b></dt>
<dd>Error occurred when canceling display.
</dd>
<dt><b>CPF3084</b></dt>
<dd>Error clearing member &amp;3 in file &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPDBR.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>