ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/file1.htm

100 lines
5.0 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Database and File APIs</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- 031030 JETAYLOR manually updated Exit listings -->
<!-- 031106 JETAYLOR manually updated Exit listings -->
<!-- 031111 JETAYLOR replaced API and/or Exit listings with -->
<!-- pagegenerator output from javascript array -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- End Header Records ============================================ -->
<!--Java sync-link ================================================= -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>Database and File APIs</h2>
<p>The database and file APIs retrieve specific information about i5/OS<SUP>(TM)</SUP> files.
These APIs also have the ability to get data and manipulate files.</p>
<p>With the exception of QDBLDBR, QDFRTVFD, QSQPRCED, QDBSTRS, QDBSTDS,
QDBSTUS, QDBSTCRS, QDBSTLS, QDBSTLDS, and QDBSTLRS, the database and file APIs
work with files that are either local or remote. Local files are files that are
on the server where the program is running. Remote files are files on a target
(remote) system that are accessed using a distributed data management (DDM)
file on a source (local) system. DDM files provide the information needed for a
local system to locate a remote system and to access data in the remote
system"s database files. The QDBLDBR, QDFRTVFD, QSQPRCED, QDBSTRS, QDBSTDS,
QDBSTUS, QDBSTCRS, QDBSTLS, QDBSTLDS, and QDBSTLRS APIs work with local
database files only.</p>
<p>When you call these APIs from a high-level language (HLL) program, you must
specify whether to use file override processing on your local or remote files.
The QDBLDBR, QSQPRCED, and QDMRTVFO APIs, however, do not support
overrides.</p>
<p>Some of the database and file APIs return character values that have an
associated coded character set identifier (CCSID). If the CCSID value for the
job calling the API is not 65535, the character values are converted from their
current CCSID to the CCSID of the job. This conversion may cause some data to
be lost. The CCSID associated with the job is returned to the user. If the
CCSID value for the job is 65535, no conversions are performed on the character
values. The character value CCSID stored in the file object is returned to the
user.</p>
<p>The database and file APIs use the standard user space format for the lists
of information they return. If you are not familiar with this format, see <a
href="../apiref/usf.htm">User Space Format for List APIs</a> before using these APIs.</p>
<p>The database and file APIs include:</p>
<ul>
<li><a href="file2.htm">File Information APIs</a></li>
<li><a href="database1.htm">Database APIs</a></li>
</ul>
<p>A database exit program provides additional (user-written) functions for the
database. The database and file exit programs are:</p><!-- ***** NOTE ***** Do not manually update text or links in this section. -->
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
<!-- Updates made in this section *will* be overlaid by automated tools -->
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
<!--***************EXIT PROGRAM BEGIN PASTE***************-->
<ul>
<li><A HREF="xclicep.htm">CLI Connection</A> exit program is called by CLI through the registration facility before the connection is made to the relational database.</li>
<li><A HREF="xclosedbf.htm">Close Database File</A> exit program is called when a process is trying to lock a file that is held by another process.</li>
<li><A HREF="xopendbf.htm">Open Database File</A> exit program is called when a when a job is opening a database file.</li>
<li><img src="delta.gif" alt="Start of change"><A HREF="xqrygovr.htm">Query Governor</A> exit program is called when a job is running a query
and the estimated runtime or temporary storage usage has exceeded the user
specified limits.<img src="deltaend.gif" alt="End of change"></li>
<li><A HREF="qdbrplay.htm">Rename exit program</A></li>
<li><A HREF="xsqlci.htm">SQL Client Integration</A> exit program enables SQL applications to access data managed by a database management system other than the OS\/400 relational database.</li>
</ul>
<!--***************EXIT PROGRAM END PASTE***************-->
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>