API Reference

DB2 APIs

The following table lists the APIs grouped by functional category:

Table 1. DB2 APIs

API Description	API Function Name b	Sample Code c d	INCLUDE File e f
Database Manager Control
START DATABASE MANAGER	sqlepstart	makeapi	sqlenv
STOP DATABASE MANAGER	sqlepstp	makeapi, dbstop	sqlenv
GET DATABASE MANAGER CONFIGURATION	sqlfxsys	dbmconf	sqlutil
GET DATABASE MANAGER CONFIGURATION DEFAULTS	sqlfdsys	d_dbmcon	sqlutil
RESET DATABASE MANAGER CONFIGURATION	sqlfrsys	dbmconf	sqlutil
UPDATE DATABASE MANAGER CONFIGURATION	sqlfusys	dbmconf	sqlutil
SET RUNTIME DEGREE	sqlesdeg	setrundg	sqlenv
Database Control
RESTART DATABASE	sqlerstd	restart	sqlenv
CREATE DATABASE	sqlecrea	dbconf	sqlenv
CREATE DATABASE AT NODE	sqlecran	n/a	sqlenv
DROP DATABASE	sqledrpd	dbconf	sqlenv
DROP DATABASE AT NODE	sqledpan	n/a	sqlenv
MIGRATE DATABASE	sqlemgdb	migrate	sqlenv
LIST INDOUBT TRANSACTIONS	sqlxphqr	n/a	sqlxa
ACTIVATE DATABASE	sqle_acti- vate_db	n/a	sqlenv
DEACTIVATE DATABASE	sqle_deac- tivate_db	n/a	sqlenv
LIST DRDA INDOUBT TRANSACTIONS	sqlcspqy	n/a	sqlxa
Database Directory Management
CATALOG DATABASE	sqlecadb	dbcat	sqlenv
UNCATALOG DATABASE	sqleuncd	dbcat	sqlenv
CATALOG DCS DATABASE	sqlegdad	dcscat	sqlenv
UNCATALOG DCS DATABASE	sqlegdel	dcscat	sqlenv
CHANGE DATABASE COMMENT	sqledcgd	dbcmt	sqlenv
OPEN DATABASE DIRECTORY SCAN	sqledosd	dbcat	sqlenv
GET NEXT DATABASE DIRECTORY ENTRY	sqledgne	dbcat	sqlenv
CLOSE DATABASE DIRECTORY SCAN	sqledcls	dbcat	sqlenv
OPEN DCS DIRECTORY SCAN	sqlegdsc	dcscat	sqlenv
GET DCS DIRECTORY ENTRIES	sqlegdgt	dcscat	sqlenv
CLOSE DCS DIRECTORY SCAN	sqlegdcl	dcscat	sqlenv
GET DCS DIRECTORY ENTRY FOR DATABASE	sqlegdge	dcscat	sqlenv
Client/Server Directory Management
CATALOG NODE	sqlectnd	nodecat	sqlenv
UNCATALOG NODE	sqleuncn	nodecat	sqlenv
OPEN NODE DIRECTORY SCAN	sqlenops	nodecat	sqlenv
GET NEXT NODE DIRECTORY ENTRY	sqlengne	nodecat	sqlenv
CLOSE NODE DIRECTORY SCAN	sqlencls	nodecat	sqlenv
Network Support
REGISTER	sqleregs	regder	sqlenv
DEREGISTER	sqledreg	regder	sqlenv
Database Configuration
GET DATABASE CONFIGURATION	sqlfxdb	dbconf	sqlutil
GET DATABASE CONFIGURATION DEFAULTS	sqlfddb	d_dbconf	sqlutil
RESET DATABASE CONFIGURATION	sqlfrdb	dbconf	sqlutil
UPDATE DATABASE CONFIGURATION	sqlfudb	dbconf	sqlutil
Recovery
BACKUP DATABASE	sqlubkp	backrest	sqlutil
RECONCILE	sqlurcon	n/a	sqlutil
RESTORE DATABASE	sqlurst	backrest	sqlutil
ROLLFORWARD DATABASE	sqluroll	backrest	sqlutil
OPEN RECOVERY HISTORY FILE SCAN	sqluhops	rechist	sqlutil
GET NEXT RECOVERY HISTORY FILE ENTRY	sqluhgne	rechist	sqlutil
CLOSE RECOVERY HISTORY FILE SCAN	sqluhcls	rechist	sqlutil
PRUNE RECOVERY HISTORY FILE	sqluhprn	rechist	sqlutil
UPDATE RECOVERY HISTORY FILE	sqluhupd	rechist	sqlutil
Operational Utilities
FORCE APPLICATION	sqlefrce	dbstop	sqlenv
REORGANIZE TABLE	sqlureot	dbstat	sqlutil
RUNSTATS	sqlustat	dbstat	sqlutil
Database Monitoring
ESTIMATE SIZE REQUIRED FOR sqlmonss() OUTPUT BUFFER	sqlmonsz	monsz	sqlmon
GET/UPDATE MONITOR SWITCHES	sqlmon	n/a	sqlmon
GET SNAPSHOT	sqlmonss	dbsnap	sqlmon
RESET MONITOR	sqlmrset	monreset	sqlmon
Data Utilities
EXPORT	sqluexpr	impexp	sqlutil
IMPORT	sqluimpr	impexp	sqlutil
LOAD	sqluload	tload	sqlutil
LOAD QUERY	sqluqry	qload	sqlutil
General Application Programming
GET ERROR MESSAGE	sqlaintp	util, checkerr	sql
GET SQLSTATE MESSAGE	sqlogstt	util, checkerr	sql
INSTALL SIGNAL HANDLER	sqleisig	util, checkerr	sqlenv
INTERRUPT	sqleintr	util, checkerr	sqlenv
DEREFERENCE ADDRESS	sqlgdref	nodecat	sqlutil
COPY MEMORY	sqlgmcpy	tspace	sqlutil
FREE MEMORY	sqlefmem	tabspace, tspace	sqlenv
GET ADDRESS	sqlgaddr	dbmconf	sqlutil
Application Preparation
PRECOMPILE PROGRAM	sqlaprep	makeapi	sql
BIND	sqlabndx	makeapi	sql
REBIND	sqlarbnd	rebind	sql
Remote Server Utilities
ATTACH	sqleatin	dbinst	sqlenv
ATTACH AND CHANGE PASSWORD	sqleatcp	dbinst	sqlenv
DETACH	sqledtin	dbinst	sqlenv
Table Space Management
TABLESPACE CONTAINER QUERY	sqlbtcq	tabscont	sqlutil
OPEN TABLESPACE CONTAINER QUERY	sqlbotcq	tabscont	sqlutil
FETCH TABLESPACE CONTAINER QUERY	sqlbftcq	tabscont	sqlutil
CLOSE TABLESPACE CONTAINER QUERY	sqlbctcq	tabscont	sqlutil
SET TABLESPACE CONTAINERS	sqlbstsc	backrest	sqlutil
TABLESPACE QUERY	sqlbmtsq	tabspace	sqlutil
SINGLE TABLESPACE QUERY	sqlbstpq	tabspace	sqlutil
OPEN TABLESPACE QUERY	sqlbotsq	tabspace	sqlutil
FETCH TABLESPACE QUERY	sqlbftpq	tabspace	sqlutil
CLOSE TABLESPACE QUERY	sqlbctsq	tabspace	sqlutil
GET TABLESPACE STATISTICS	sqlbgtss	tabspace	sqlutil
QUIESCE TABLESPACES FOR TABLE	sqluvqdp	tquiesce	sqlutil
Node Management
ADD NODE	sqleaddn	n/a	sqlenv
DROP NODE VERIFY	sqledrpn	n/a	sqlenv
Nodegroup Management
REDISTRIBUTE NODEGROUP	sqludrdt	n/a	sqlutil
Additional APIs
GET AUTHORIZATIONS	sqluadau	dbauth	sqlutil
GET INSTANCE	sqlegins	dbinst	sqlenv
QUERY CLIENT	sqleqryc	client	sqlenv
QUERY CLIENT INFORMATION	sqleqryi	n/a	sqlenv
SET CLIENT	sqlesetc	client	sqlenv
SET CLIENT INFORMATION	sqleseti	n/a	sqlenv
SET ACCOUNTING STRING	sqlesact	setact	sqlenv
ASYNCHRONOUS READ LOG	sqlurlog	n/a	sqlutil
GET ROW PARTITIONING NUMBER	sqlugrpn	n/a	sqlutil
GET TABLE PARTITIONING INFORMATION	sqlugtpi	n/a	sqlutil
Note: a This is a pre-version 2 API and is not supported on all platforms. b The fourth character of the generic API function name is always g. c The sample programs can be found in the language specific directory of the samples directory in the sqllib directory (for example, sqllib\samples\c for C source code). d The file extensions on sample code depend on the programming language being used. For example, for sample code written in C, the extension is .c or .sqc. Not all programs are available in all supported programming languages. Not all APIs have sample code (indicated by n/a). e The file extensions on INCLUDE files depend on the programming language being used. For example, an INCLUDE file written for C has a file extension of .h. f The INCLUDE files can be found in directory sqllib\include (directory delimiters are dependant upon the operating system).

[ DB2 List of Books | Search the DB2 Books ]