IBM Books

API Reference


DB2 Sample Programs

The following table lists the APIs grouped by sample program:

Table 2. DB2 APIs by Sample Program
Sample Code Included APIs
backrest
sqlbstsc - Set Tablespace Containers
sqlubkp - Backup Database
sqluroll - Rollforward Database
sqlurst - Restore Database

checkerr
sqlaintp - Get Error Message
sqleintr - Interrupt
sqleisig - Install Signal Handler
sqlogstt - Get SQLSTATE Message

client
sqleqryc - Query Client
sqlesetc - Set Client

d_dbconf
sqlfddb - Get Database Configuration Defaults

d_dbmcon
sqlfdsys - Get Database Manager Configuration Defaults

dbauth
sqluadau - Get Authorizations

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

dbconf
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
sqlfrsys - Reset Database Manager Configuration
sqlfusys - Update Database Manager Configuration
sqlfxsys - Get Database Manager Configuration
sqlgaddr - Get Address

dbsnap
sqlmonss - Get Snapshot

dbstat
sqlureot - Reorganize Table
sqlustat - Runstats

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

impexp
sqluexpr - Export
sqluimpr - Import

makeapi
sqlabndx - Bind
sqlaprep - Precompile Program
sqlepstp - Stop Database Manager
sqlepstr - Start Database Manager

migrate
sqlemgdb - Migrate Database

monreset
sqlmrset - Reset Monitor

monsz
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
sqlgdref - Dereference Address

qload
sqluqry - Load Query

rebind
sqlarbnd - Rebind

rechist
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

regder
sqledreg - Deregister
sqleregs - Register

restart
sqlerstd - Restart Database

setact
sqlesact - Set Accounting String

setrundg
sqlesdeg - Set Runtime Degree

tabscont
sqlbctcq - Close Tablespace Container Query
sqlbftcq - Fetch Tablespace Container Query
sqlbotcq - Open Tablespace Container Query
sqlbtcq - Tablespace Container Query

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
sqluload - Load

tquiesce
sqluvqdp - Quiesce Tablespaces for Table

tspace
sqlefmem - Free Memory
sqlgmcpy - Copy Memory

util
sqlaintp - Get Error Message
sqleintr - Interrupt
sqleisig - Install Signal Handler
sqlogstt - Get SQLSTATE Message

n/a
sqlcspqy - List DRDA Indoubt Transactions
sqle_activate_db - Activate Database
sqle_deactivate_db - Deactivate Database
sqleaddn - Add Node
sqlecran - Create Database at Node
sqledpan - Drop Database at Node
sqledrpn - Drop Node Verify
sqleqryi - Query Client Information
sqleseti - Set Client Information
sqludrdt - Redistribute Nodegroup
sqlugrpn - Get Row Partitioning Number
sqlugtpi - Get Table Partitioning Information
sqlurcon - Reconcile
sqlurlog - Asynchronous Read Log
sqlxphqr - List Indoubt Transactions

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 (indicated by n/a).


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]

[ DB2 List of Books | Search the DB2 Books ]