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

246 lines
8.2 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 RDB Directory Entries (DSPRDBDIRE)</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="DSPRDBDIRE.Top_Of_Page"></a>
<h2>Display RDB Directory Entries (DSPRDBDIRE)</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="#DSPRDBDIRE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPRDBDIRE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPRDBDIRE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPRDBDIRE"></a>
<p>The Display Relational Database Directory Entry (DSPRDBDIRE) command allows you to display one entry, generic entries, or all entries in the relational database (RDB) directory.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPRDBDIRE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPRDBDIRE.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"><a href="#DSPRDBDIRE.RDB"><b>RDB</b></a></td>
<td valign="top">Entry</td>
<td valign="top"><i>Generic name, name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#DSPRDBDIRE.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, Positional 2</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#DSPRDBDIRE.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="#DSPRDBDIRE.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>
</table>
<table width="100%">
<tr><td align="right"><a href="#DSPRDBDIRE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPRDBDIRE.RDB"></a>
<h3>Entry (RDB)</h3>
<p>Specifies the relational database directory entry. If an entry has no alias, the relational database name is used as the entry name. If an entry has an alias, the alias is used as the entry name.
</p>
<p>This is a required parameter.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All entries in the relational database directory.
</dd>
<dt><b><i>generic*-relational-database-name</i></b></dt>
<dd>Specify the generic name of the relational database entries. A generic name is a character string that contains one or more characters followed by an asterisk (*).
</dd>
<dt><b><i>relational-database-name</i></b></dt>
<dd>Specify the name of the relational database directory entry.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPRDBDIRE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPRDBDIRE.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>
<p>The possible values are:
</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>
</dl>
<dl>
<dt><b>*OUTFILE</b></dt>
<dd>The output is directed to an output file.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPRDBDIRE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPRDBDIRE.OUTFILE"></a>
<h3>File to receive output (OUTFILE)</h3>
<p>Specifies the name and library of the output file to which the output of this command is directed. If the file does not exist, it is created. If a new file is created, system file QADSPDE in system library QSYS with a record format name of RWRDDSP is used as a model. If the file already exists, it must have this format.
</p>
<p>This parameter is valid only if you specify *OUTFILE on the <b>Output</b> prompt (OUTPUT parameter).
</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 is used to locate the output file. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library in which the output file is to be located.
</dd>
<dt><b><i>database-file-name</i></b></dt>
<dd>Specify the name of the file in which the output is to be located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPRDBDIRE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPRDBDIRE.OUTMBR"></a>
<h3>Output member options (OUTMBR)</h3>
<p>Specifies the name of the database file member to which the output is directed when *OUTFILE is specified for the <b>Output (OUTPUT)</b> parameter.
</p>
<p>The possible <b>member to receive output</b> values are:
</p>
<dl>
</dl>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member of the specified file is used.
</dd>
</dl>
<dl>
<dt><b><i>member-name</i></b></dt>
<dd>Specify a maximum of 10 characters for the name of the output file member in which the requested information is to be located.
</dd>
</dl>
<p>The possible <b>replace or add records</b> values are:
</p>
<dl>
</dl>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The system clears the existing member and adds the new records.
</dd>
</dl>
<dl>
</dl>
<dl>
<dt><b>*ADD</b></dt>
<dd>The system adds the new records to the end of the existing records.
</dd>
</dl>
<dl>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPRDBDIRE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPRDBDIRE.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Directing Information to an Output File</b>
</p>
<p>
<pre>
DSPRDBDIRE OUTPUT(*PRINT)
</pre>
</p>
<p>This command directs information from all of the relational database directory entries to a spooled file.
</p>
<p><b>Example 2: Directing Information to an Output File</b>
</p>
<p>
<pre>
DSPRDBDIRE OUTPUT(*OUTFILE) OUTFILE(SAVEDIR)
</pre>
</p>
<p>This command directs all of the relational database directory entries to an output file named SAVEDIR. This is the usual method for backing up the contents of the relational database directory. The entries can be restored using a CL program that reads the information from the output file and issues Add Relational Database Directory Entry (ADDRDBDIRE) commands to add the information back into the relational database directory.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPRDBDIRE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPRDBDIRE.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF3EC3</b></dt>
<dd>Display relational database directory entry failed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPRDBDIRE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>