DB2 APIs are grouped into the following functional categories. See Table 10.1 for the API function names.
Database Manager Control
Database Control
Database Manager and Database Configuration
Database Directory Management
Client–Server Directory Management
Network Support
Recovery
Operational Utilities
Database Monitoring
Health Monitoring
Data Utilities
General Application Programming
Application Preparation
Remote Server Utilities
Table Space Management
Node Management
Satellite
Database Partition Group Management
Additional APIs
DB2 API | Include File | Sample Programs |
---|---|---|
Database Manager Control | ||
db2DatabaseQuiesce—Database Quiesce | db2ApiDf | n/a |
db2DatabaseUnquiesce—Database Unquiesce | db2ApiDf | n/a |
db2InstanceStart—Instance Start | db2ApiDf | C: instart.c C++: instart.C |
db2InstanceStop—Instance Stop | db2ApiDf | C: instart.c C++: instart.C |
db2InstanceQuiesce—Instance Quiesce | db2ApiDf | n/a |
db2InstanceUnquiesce—Instance Unquiesce | db2ApiDf | n/a |
sqlesdeg—Set Runtime Degree | sqlenv | C: ininfo.c C++: ininfo.C |
Database Control | ||
db2DatabaseRestart—Restart Database | db2ApiDf | C: dbconn.sqc C++: dbconn.sqC |
sqlecrea—Create Database | sqlenv | C: dbcreate.c, dbrecov.sqc, dbsample.sqc
C++: dbcreate.C, dbrecov.sqC, COBOL: db_udcs.cbl, dbconf.cbl, ebcdicdb.cbl |
sqlecran—Create Database at Node | sqlenv | n/a |
sqledrpd—Drop Database | sqlenv | C: dbcreate.c
C++: dbcreate.C COBOL: dbconf.cbl |
sqledpan—Drop Database at Node | sqlenv | n/a |
sqlemgdb—Migrate Database | sqlenv | C: dbmigrat.c
C++: dbmigrat.C COBOL: migrate.cbl |
db2XaListIndTrans—List Indoubt Transactions | db2ApiDf | n/a |
sqle_activate_db—Activate Database | sqlenv | n/a |
sqle_deactivate_db—Deactivate Database | sqlenv | n/a |
sqlcspqy—List DRDA Indoubt Transactions | sqlxa | n/a |
Database Manager and Database Configuration | ||
db2CfgGet—Get Configuration Parameters | db2ApiDf | C: dbinfo.c, dbrecov.sqc, inauth.sqc, ininfo.c, tscreate.sqc C++: dbinfo.C, dbrecov.sqC, inauth.sqC, ininfo.C, tscreate.sqC |
db2CfgSet—Set Configuration Parameters | db2ApiDf | C: dbinfo.c, dbrecov.sqc, ininfo.c C++: dbinfo.C, dbrecov.sqC, ininfo.C |
Database Directory Management | ||
sqlecadb—Catalog Database | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dbcat.cbl |
sqleuncd—Uncatalog Database | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dbcat.cbl |
sqlegdad—Catalog DCS Database | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dcscat.cbl |
sqlegdel—Uncatalog DCS Database | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dcscat.cbl |
sqledcgd—Change Database Comment | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dbcmt.cbl |
sqledosd—Open Database Directory Scan | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dbcat.cbl, dbcmt.cbl |
sqledgne—Get Next Database Directory Entry | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dbcat.cbl, dbcmt.cbl |
sqledcls—Close Database Directory Scan | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dbcat.cbl, dbcmt.cbl |
sqlegdsc—Open DCS Directory Scan | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dcscat.cbl |
sqlegdgt—Get DCS Directory Entries | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dcscat.cbl |
sqlegdcl—Close DCS Directory Scan | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dcscat.cbl |
sqlegdge—Get DCS Directory Entry for Database | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dcscat.cbl |
Client–Server Directory Management | ||
sqlectnd—Catalog Node | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: nodecat.cbl |
sqleuncn—Uncatalog Node | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: nodecat.cbl |
sqlenops—Open Node Directory Scan | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: nodecat.cbl |
sqlengne—Get Next Node Directory Entry | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: nodecat.cbl |
sqlencls—Close Node Directory Scan | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: nodecat.cbl |
Network Support | ||
sqleregs—Register | sqlenv | n/a |
sqledreg—Deregister | sqlenv | n/a |
db2LdapRegister—LDAP Register Server | db2ApiDf | n/a |
db2LdapUpdate—LDAP Update Server | db2ApiDf | n/a |
db2LdapDeregister—LDAP Deregister Server | db2ApiDf | n/a |
db2LdapCatalogNode—Catalog Node LDAP Entry | db2ApiDf | n/a |
db2LdapUncatalogNode—Uncatalog Node LDAP Entry | db2ApiDf | n/a |
db2LdapCatalogDatabase—Catalog Database LDAP Entry | db2ApiDf | n/a |
db2LdapUncatalogDatabase—Uncatalog Database LDAP Entry | db2ApiDf | n/a |
Recovery | ||
db2Backup—Backup Database | db2ApiDf | C: dbrecov.sqc C++: dbrecov.sqC |
sqlurcon—Reconcile | sqlutil | n/a |
db2Restore—Restore Database | db2ApiDf | C: dbrecov.sqc C++: dbrecov.sqC |
db2Rollforward—Rollforward Database | db2ApiDf | C: dbrecov.sqc C++: dbrecov.sqC |
db2HistoryOpenScan—Open History File Scan | db2ApiDf | C: dbrecov.sqc C++: dbrecov.sqC |
db2HistoryGetEntry—Get Next History File Entry | db2ApiDf | C: dbrecov.sqc C++: dbrecov.sqC |
db2HistoryCloseScan—Close History File Scan | db2ApiDf | C: dbrecov.sqc C++: dbrecov.sqC |
db2Prune—Prune History File | db2ApiDf | C: dbrecov.sqc C++: dbrecov.sqC |
db2HistoryUpdate—Update History File | db2ApiDf | C: dbrecov.sqc C++: dbrecov.sqC |
Operational Utilities | ||
sqlefrce—Force Application | sqlenv | C: dbconn.sqc, dbsample.sqc, instart.c
C++: dbconn.sqC, instart.C COBOL: dbstop.cbl |
db2Reorg—Reorganize | db2ApiDf | C: tbreorg.sqc
C++: tbreorg.sqC COBOL: dbstat.sqb |
db2Runstats—Runstats | db2ApiDf | C: tbreorg.sqc
C++: tbreorg.sqC COBOL: dbstat.sqb |
Database Monitoring | ||
db2GetSnapshotSize—Estimate Size Required for db2GetSnapshot Output Buffer | db2ApiDf | n/a |
db2MonitorSwitches—Get/Update Monitor Switches | db2ApiDf | C: utilsnap.c C++: utilsnap.C |
db2GetSnapshot—Get Snapshot | db2ApiDf | C: utilsnap.c C++: utilsnap.C |
db2ResetMonitor—Reset Monitor | db2ApiDf | n/a |
db2ConvMonStream—Convert Monitor Stream | db2ApiDf | n/a |
Health Monitoring | ||
db2AddContact—Add Contact | db2ApiDf | n/a |
db2AddContactGroup—Add Contact Group | db2ApiDf | n/a |
db2DropContact—Drop Contact | db2ApiDf | n/a |
db2DropContactGroup—Drop Contact Group | db2ApiDf | n/a |
db2GetAlertCfg—Get Alert Configuration | db2ApiDf | n/a |
db2GetContactGroup—Get Contact Group | db2ApiDf | n/a |
db2GetContactGroups—Get Contact Groups | db2ApiDf | n/a |
db2GetContacts—Get Contacts | db2ApiDf | n/a |
db2GetHealthNotificationList—Get Health Notification List | db2ApiDf | n/a |
db2ResetAlertCfg—Reset Alert Configuration | db2ApiDf | n/a |
db2UpdateAlertCfg—Update Alert Configuration | db2ApiDf | n/a |
db2UpdateContact—Update Contact | db2ApiDf | n/a |
db2UpdateContactGroup—Update Contact Group | db2ApiDf | n/a |
db2UpdateHealthNotificationList—Update Health Notification List | db2ApiDf | n/a |
Data Utilities | ||
sqluexpr—Export | sqlutil | C: tbmove.sqc
C++: tbmove.sqC COBOL: expsamp.sqb, impexp.sqb, tload.sqb |
sqluimpr—Import | sqlutil | C: dtformat.sqc, tbmove.sqc
C++: tbmove.sqC COBOL: expsamp.sqb, impexp.sqb |
db2Load—Load | db2ApiDf | C: dtformat.sqc, tbmove.sqc C++: tbmove.sq |
db2LoadQuery—Load Query | db2ApiDf | C: tbmove.sqc
C++: tbmove.sqC COBOL: loadqry.sqb |
General Application Programming | ||
db2AutoConfig—Autoconfigure | db2AuCfg | C: dbcfg.sqc C++: dbcfg.sqC |
db2AutoConfigFreeMemory—Free Autoconfigure Memory | db2AuCfg | C: dbcfg.sqc C++: dbcfg.sqC |
sqlaintp—Get Error Message | sql | C: dbcfg.sqc, utilapi.c
C++: dbcfg.sqC, utilapi.C COBOL: checkerr.cbl |
sqlogstt—Get SQLSTATE Message | sql | C: utilapi.c
C++: utilapi.C COBOL: checkerr.cbl |
sqleisig—Install Signal Handler | sqlenv | COBOL: dbcmt.cbl |
sqleintr—Interrupt | sqlenv | n/a |
sqlgdref—Dereference Address | sqlutil | n/a |
sqlgmcpy—Copy Memory | sqlutil | n/a |
sqlefmem—Free Memory | sqlenv | C: dbrecov.sqc, tsinfo.sqc
C++: dbrecov.sqC, tsinfo.sqC COBOL: tabscont.sqb, tabspace.sqb, tspace.sqb |
sqlgaddr—Get Address | sqlutil | n/a |
Application Preparation | ||
sqlaprep—Precompile Program | sql | C: dbpkg.sqc C++: dbpkg.sqC |
sqlabndx—Bind | sql | C: dbpkg.sqc, dbsample.sqc C++: dbpkg.sqC |
sqlarbnd—Rebind | sql | C: dbpkg.sqc, dbsample.sqc
C++: dbpkg.sqC COBOL: rebind.sqb |
Remote Server Utilities | ||
sqleatin—Attach | sqlenv | C: inattach.c, utilapi.c
C++: inattach.C, utilapi.C COBOL: dbinst.cb |
sqleatcp—Attach and Change Password | sqlenv | C: inattach.c
C++: inattach.C COBOL: dbinst.cbl |
sqledtin—Detach | sqlenv | C: inattach.c, utilapi.c
C++: inattach.C, utilapi.C COBOL: dbinst.cb |
Table Space Management | ||
sqlbtcq—Table Space Container Query | sqlutil | C: dbrecov.sqc, tsinfo.sqc
C++: dbrecov.sqC, tsinfo.sqC COBOL: tabscont.sqb, tspace.sqb |
sqlbotcq—Open Table Space Container Query | sqlutil | C: tsinfo.sqc
C++: tsinfo.sqC COBOL: tabscont.sqb, tspace.sqb |
sqlbftcq—Fetch Table Space Container Query | sqlutil | C: tsinfo.sqc
C++: tsinfo.sqC COBOL: tabscont.sqb, tspace.sqb |
sqlbctcq—Close Table Space Container Query | sqlutil | C: tsinfo.sqc
C++: tsinfo.sqC COBOL: tabscont.sqb, tspace.sqb |
sqlbstsc—Set Table Space Containers | sqlutil | C: dbrecov.sqc
C++: dbrecov.sqC COBOL: tabscont.sqb, tspace.sqb |
sqlbmtsq—Table Space Query | sqlutil | C: dbrecov.sqc, tsinfo.sqc
C++: dbrecov.sqC, tsinfo.sqC COBOL: tabspace.sqb, tspace.sqb |
sqlbstpq—Single Table Space Query | sqlutil | C: tsinfo.sqc
C++: tsinfo.sqC COBOL: tabspace.sqb, tspace.sqb |
sqlbotsq—Open Table Space Query | sqlutil | C: tsinfo.sqc
C++: tsinfo.sqC COBOL: tabspace.sqb, tspace.sqb |
sqlbftpq—Fetch Table Space Query | sqlutil | C: tsinfo.sqc
C++: tsinfo.sqC COBOL: tabspace.sqb, tspace.sqb |
sqlbctsq—Close Table Space Query | sqlutil | C: tsinfo.sqc
C++: tsinfo.sqC COBOL: tabspace.sqb, tspace.sqb |
sqlbgtss—Get Table Space Statistics | sqlutil | C: tsinfo.sqc
C++: tsinfo.sqC COBOL: tabspace.sqb, tspace.sqb |
sqluvqdp—Quiesce Table Spaces for Table | sqlutil | C: tbmove.sqc
C++: tbmove.sqC COBOL: tload.sqb |
Node Management | ||
sqleaddn—Add Node | sqlenv | n/a |
sqledrpn—Drop Node Verify | sqlenv | n/a |
Satellite | ||
db2GetSyncSession—Get Satellite Sync Session | db2ApiDf | n/a |
db2QuerySatelliteProgress—Query Satellite Sync | db2ApiDf | n/a |
db2SetSyncSession—Set Satellite Sync Session | db2ApiDf | n/a |
db2SyncSatellite—Sync Satellite | db2ApiDf | n/a |
db2SyncSatelliteStop—Stop Satellite Sync | db2ApiDf | n/a |
db2SyncSatelliteTest—Test Satellite Sync | db2ApiDf | n/a |
Database Partition Group Management | ||
sqludrdt—Redistribute Database Partition Group | sqlutil | n/a |
Additional APIs | ||
sqluadau—Get Authorizations | sqlutil | C: dbauth.sqc, inauth.sqc C++: dbauth.sqC, inauth.sqC |
sqlegins—Get Instance | sqlenv | C: ininfo.c
C++: ininfo.C COBOL: dbinst.cbl |
sqleqryc—Query Client | sqlenv | C: cli_info.c
C++: cli_info.C COBOL: client.cbl |
sqleqryi—Query Client Information | sqlenv | C: cli_info.c C++: cli_info.C |
sqlesetc—Set Client | sqlenv | C: cli_info.c, dbcfg.sqc, dbmcon.sqc
C++: cli_info.C, dbcfg.sqC, dbmcon.sqC COBOL: client.cbl |
sqleseti—Set Client Information | sqlenv | C: cli_info.c C++: cli_info.C |
sqlesact—Set Accounting String | sqlenv | C: cli_info.c
C++: cli_info.C COBOL: setact.cbl |
db2ReadLog—Asynchronous Read Log | db2ApiDf | C: dbrecov.sqc C++: dbrecov.sqC |
db2ReadLogNoConn—Read Log Without a Database Connectio | db2ApiDf | n/a |
db2ReadLogNoConnInit—Initialize Read Log Without a Database Connection | db2ApiDf | n/a |
db2ReadLogNoConnTerm—Terminate Read Log Without a Database Connection | db2ApiDf | n/a |
sqlugrpn—Get Row Partitioning Number | sqlutil | n/a |
sqlugtpi—Get Table Partitioning Information | sqlutil | n/a |
db2AdminMsgWrite—Administration Message Write | db2ApiDf | n/a |
db2SetWriteForDB | db2ApiDf | n/a |
db2ArchiveLog—Archive Active Log | db2ApiDf | n/a |
db2DatabasePing—Ping Database | db2ApiDf | n/a |
db2Inspect —Inspect database | db2ApiDf | n/a |
NOTE
The sample programs can be found in the language-specific directory of the samples directory in the sqllib directory (for example, Program FilesIBMsqllibsamplesc for C source code, if DB2 is installed on Windows platforms). 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).
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. The INCLUDE files can be found in directory sqllibinclude (directory delimiters are dependant upon the operating system).
3.144.250.153