Administrative API Reference

DB2 Sample Programs

The following tables list the APIs grouped by sample program. Table 2 lists the APIs that are called by programs which contain no embedded SQL, while Table 3 lists the APIs that are called by programs which do contain embedded SQL:

Table 2. DB2 APIs by Sample Program (with No Embedded SQL)

Sample Code	Included APIs
backrest	sqlbftcq - Fetch Tablespace Container Query sqlbstsc - Set Tablespace Containers sqlfudb - Update Database Configuration sqlubkp - Backup Database sqluroll - Rollforward Database sqlurst - Restore Database
checkerr	sqlaintp - Get Error Message sqlogstt - Get SQLSTATE Message
cli_info	sqleqryi - Query Client Information sqleseti - Set Client Information
client	sqleqryc - Query Client sqlesetc - Set Client
d_dbconf	sqleatin - Attach sqledtin - Detach sqlfddb - Get Database Configuration Defaults
d_dbmcon	sqleatin - Attach sqledtin - Detach sqlfdsys - Get Database Manager Configuration Defaults
db_udcs	sqleatin - Attach sqlecrea - Create Database sqledrpd - Drop Database
db2mon	sqleatin - Attach sqlmon - Get/Update Monitor Switches sqlmonss - Get Snapshot sqlmonsz - Estimate Size Required for sqlmonss() Output Buffer sqlmrset - Reset Monitor
dbcat	sqlecadb - Catalog Database sqledcls - Close Database Directory Scan sqledgne - Get Next Database Directory Entry sqledosd - Open Database Directory Scan sqleuncd - Uncatalog Database
dbcmt	sqledcgd - Change Database Comment sqledcls - Close Database Directory Scan sqledgne - Get Next Database Directory Entry sqledosd - Open Database Directory Scan sqleisig - Install Signal Handler
dbconf	sqleatin - Attach sqlecrea - Create Database sqledrpd - Drop Database sqlfrdb - Reset Database Configuration sqlfudb - Update Database Configuration sqlfxdb - Get Database Configuration
dbinst	sqleatcp - Attach and Change Password sqleatin - Attach sqledtin - Detach sqlegins - Get Instance
dbmconf	sqleatin - Attach sqledtin - Detach sqlfrsys - Reset Database Manager Configuration sqlfusys - Update Database Manager Configuration sqlfxsys - Get Database Manager Configuration
dbsnap	sqleatin - Attach sqlmonss - Get Snapshot
dbstart	sqlepstart - Start Database Manager
dbstop	sqlefrce - Force Application sqlepstp - Stop Database Manager
dcscat	sqlegdad - Catalog DCS Database sqlegdcl - Close DCS Directory Scan sqlegdel - Uncatalog DCS Database sqlegdge - Get DCS Directory Entry for Database sqlegdgt - Get DCS Directory Entries sqlegdsc - Open DCS Directory Scan
dmscont	sqleatin - Attach sqlecrea - Create Database sqledrpd - Drop Database
ebcdicdb	sqleatin - Attach sqlecrea - Create Database sqledrpd - Drop Database
migrate	sqlemgdb - Migrate Database
monreset	sqleatin - Attach sqlmrset - Reset Monitor
monsz	sqleatin - Attach sqlmonss - Get Snapshot sqlmonsz - Estimate Size Required for sqlmonss() Output Buffer
nodecat	sqlectnd - Catalog Node sqlencls - Close Node Directory Scan sqlengne - Get Next Node Directory Entry sqlenops - Open Node Directory Scan sqleuncn - Uncatalog Node
regder	sqledreg - Deregister sqleregs - Register
restart	sqlerstd - Restart Database
setact	sqlesact - Set Accounting String
setrundg	sqlesdeg - Set Runtime Degree
sws	sqleatin - Attach sqlmon - Get/Update Monitor Switches
util	sqlaintp - Get Error Message sqlogstt - Get SQLSTATE Message
Note: a 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). 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.

Table 3. DB2 APIs by Sample Program (with Embedded SQL)

Sample Code	Included APIs
asynrlog	sqlurlog - Asynchronous Read Log
bindfile	sqlabndx - Bind
dbauth	sqluadau - Get Authorizations
dbstat	sqlureot - Reorganize Table sqlustat - Runstats
expsamp	sqluexpr - Export sqluimpr - Import
impexp	sqluexpr - Export sqluimpr - Import
loadqry	db2LoadQuery - Load Query
makeapi	sqlabndx - Bind sqlaprep - Precompile Program sqlepstp - Stop Database Manager sqlepstr - Start Database Manager
rebind	sqlarbnd - Rebind
rechist	sqlubkp - Backup Database sqluhcls - Close Recovery History File Scan sqluhgne - Get Next Recovery History File Entry sqluhops - Open Recovery History File Scan sqluhprn - Prune Recovery History File sqluhupd - Update Recovery History File
tabscont	sqlbctcq - Close Tablespace Container Query sqlbftcq - Fetch Tablespace Container Query sqlbotcq - Open Tablespace Container Query sqlbtcq - Tablespace Container Query sqlefmem - Free Memory
tabspace	sqlbctsq - Close Tablespace Query sqlbftpq - Fetch Tablespace Query sqlbgtss - Get Tablespace Statistics sqlbmtsq - Tablespace Query sqlbotsq - Open Tablespace Query sqlbstpq - Single Tablespace Query sqlefmem - Free Memory
tload	sqluexpr - Export sqluload - Load sqluvqdp - Quiesce Tablespaces for Table
tspace	sqlbctcq - Close Tablespace Container Query sqlbctsq - Close Tablespace Query sqlbftcq - Fetch Tablespace Container Query sqlbftpq - Fetch Tablespace Query sqlbgtss - Get Tablespace Statistics sqlbmtsq - Tablespace Query sqlbotcq - Open Tablespace Container Query sqlbotsq - Open Tablespace Query sqlbstpq - Single Tablespace Query sqlbstsc - Set Tablespace Containers sqlbtcq - Tablespace Container Query sqlefmem - Free Memory
Note: a 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). 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.

[ DB2 List of Books | Search the DB2 Books ]