DB2 APIs

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

Table 10.1. DB2 APIs
DB2 APIInclude FileSample Programs
Database Manager Control
db2DatabaseQuiesce—Database Quiescedb2ApiDfn/a
db2DatabaseUnquiesce—Database Unquiescedb2ApiDfn/a
db2InstanceStart—Instance Startdb2ApiDfC: instart.c C++: instart.C
db2InstanceStop—Instance Stopdb2ApiDfC: instart.c C++: instart.C
db2InstanceQuiesce—Instance Quiescedb2ApiDfn/a
db2InstanceUnquiesce—Instance Unquiescedb2ApiDfn/a
sqlesdeg—Set Runtime DegreesqlenvC: ininfo.c C++: ininfo.C
Database Control
db2DatabaseRestart—Restart Databasedb2ApiDfC: dbconn.sqc C++: dbconn.sqC
sqlecrea—Create DatabasesqlenvC: dbcreate.c, dbrecov.sqc, dbsample.sqc

C++: dbcreate.C, dbrecov.sqC,

COBOL: db_udcs.cbl, dbconf.cbl, ebcdicdb.cbl
sqlecran—Create Database at Nodesqlenvn/a
sqledrpd—Drop DatabasesqlenvC: dbcreate.c

C++: dbcreate.C

COBOL: dbconf.cbl
sqledpan—Drop Database at Nodesqlenvn/a
sqlemgdb—Migrate DatabasesqlenvC: dbmigrat.c

C++: dbmigrat.C

COBOL: migrate.cbl
db2XaListIndTrans—List Indoubt Transactionsdb2ApiDfn/a
sqle_activate_db—Activate Databasesqlenvn/a
sqle_deactivate_db—Deactivate Databasesqlenvn/a
sqlcspqy—List DRDA Indoubt Transactionssqlxan/a
Database Manager and Database Configuration
db2CfgGet—Get Configuration Parametersdb2ApiDfC: dbinfo.c, dbrecov.sqc, inauth.sqc, ininfo.c, tscreate.sqc C++: dbinfo.C, dbrecov.sqC, inauth.sqC, ininfo.C, tscreate.sqC
db2CfgSet—Set Configuration Parametersdb2ApiDfC: dbinfo.c, dbrecov.sqc, ininfo.c C++: dbinfo.C, dbrecov.sqC, ininfo.C
Database Directory Management
sqlecadb—Catalog DatabasesqlenvC: ininfo.c

C++: ininfo.C

COBOL: dbcat.cbl
sqleuncd—Uncatalog DatabasesqlenvC: ininfo.c

C++: ininfo.C

COBOL: dbcat.cbl
sqlegdad—Catalog DCS DatabasesqlenvC: ininfo.c

C++: ininfo.C

COBOL: dcscat.cbl
sqlegdel—Uncatalog DCS DatabasesqlenvC: ininfo.c

C++: ininfo.C

COBOL: dcscat.cbl
sqledcgd—Change Database CommentsqlenvC: ininfo.c

C++: ininfo.C

COBOL: dbcmt.cbl
sqledosd—Open Database Directory ScansqlenvC: ininfo.c

C++: ininfo.C

COBOL: dbcat.cbl, dbcmt.cbl
sqledgne—Get Next Database Directory EntrysqlenvC: ininfo.c

C++: ininfo.C

COBOL: dbcat.cbl, dbcmt.cbl
sqledcls—Close Database Directory ScansqlenvC: ininfo.c

C++: ininfo.C

COBOL: dbcat.cbl, dbcmt.cbl
sqlegdsc—Open DCS Directory ScansqlenvC: ininfo.c

C++: ininfo.C

COBOL: dcscat.cbl
sqlegdgt—Get DCS Directory EntriessqlenvC: ininfo.c

C++: ininfo.C

COBOL: dcscat.cbl
sqlegdcl—Close DCS Directory ScansqlenvC: ininfo.c

C++: ininfo.C

COBOL: dcscat.cbl
sqlegdge—Get DCS Directory Entry for DatabasesqlenvC: ininfo.c

C++: ininfo.C

COBOL: dcscat.cbl
Client–Server Directory Management
sqlectnd—Catalog NodesqlenvC: ininfo.c

C++: ininfo.C

COBOL: nodecat.cbl
sqleuncn—Uncatalog NodesqlenvC: ininfo.c

C++: ininfo.C

COBOL: nodecat.cbl
sqlenops—Open Node Directory ScansqlenvC: ininfo.c

C++: ininfo.C

COBOL: nodecat.cbl
sqlengne—Get Next Node Directory EntrysqlenvC: ininfo.c

C++: ininfo.C

COBOL: nodecat.cbl
sqlencls—Close Node Directory ScansqlenvC: ininfo.c

C++: ininfo.C

COBOL: nodecat.cbl
Network Support
sqleregs—Registersqlenvn/a
sqledreg—Deregistersqlenvn/a
db2LdapRegister—LDAP Register Serverdb2ApiDfn/a
db2LdapUpdate—LDAP Update Serverdb2ApiDfn/a
db2LdapDeregister—LDAP Deregister Serverdb2ApiDfn/a
db2LdapCatalogNode—Catalog Node LDAP Entrydb2ApiDfn/a
db2LdapUncatalogNode—Uncatalog Node LDAP Entrydb2ApiDfn/a
db2LdapCatalogDatabase—Catalog Database LDAP Entrydb2ApiDfn/a
db2LdapUncatalogDatabase—Uncatalog Database LDAP Entrydb2ApiDfn/a
Recovery
db2Backup—Backup Databasedb2ApiDfC: dbrecov.sqc C++: dbrecov.sqC
sqlurcon—Reconcilesqlutiln/a
db2Restore—Restore Databasedb2ApiDfC: dbrecov.sqc C++: dbrecov.sqC
db2Rollforward—Rollforward Databasedb2ApiDfC: dbrecov.sqc C++: dbrecov.sqC
db2HistoryOpenScan—Open History File Scandb2ApiDfC: dbrecov.sqc C++: dbrecov.sqC
db2HistoryGetEntry—Get Next History File Entrydb2ApiDfC: dbrecov.sqc C++: dbrecov.sqC
db2HistoryCloseScan—Close History File Scandb2ApiDfC: dbrecov.sqc C++: dbrecov.sqC
db2Prune—Prune History Filedb2ApiDfC: dbrecov.sqc C++: dbrecov.sqC
db2HistoryUpdate—Update History Filedb2ApiDfC: dbrecov.sqc C++: dbrecov.sqC
Operational Utilities
sqlefrce—Force ApplicationsqlenvC: dbconn.sqc, dbsample.sqc, instart.c

C++: dbconn.sqC, instart.C

COBOL: dbstop.cbl
db2Reorg—Reorganizedb2ApiDfC: tbreorg.sqc

C++: tbreorg.sqC

COBOL: dbstat.sqb
db2Runstats—Runstatsdb2ApiDfC: tbreorg.sqc

C++: tbreorg.sqC

COBOL: dbstat.sqb
Database Monitoring
db2GetSnapshotSize—Estimate Size Required for db2GetSnapshot Output Bufferdb2ApiDfn/a
db2MonitorSwitches—Get/Update Monitor Switchesdb2ApiDfC: utilsnap.c C++: utilsnap.C
db2GetSnapshot—Get Snapshotdb2ApiDfC: utilsnap.c C++: utilsnap.C
db2ResetMonitor—Reset Monitordb2ApiDfn/a
db2ConvMonStream—Convert Monitor Streamdb2ApiDfn/a
Health Monitoring
db2AddContact—Add Contactdb2ApiDfn/a
db2AddContactGroup—Add Contact Groupdb2ApiDfn/a
db2DropContact—Drop Contactdb2ApiDfn/a
db2DropContactGroup—Drop Contact Groupdb2ApiDfn/a
db2GetAlertCfg—Get Alert Configurationdb2ApiDfn/a
db2GetContactGroup—Get Contact Groupdb2ApiDfn/a
db2GetContactGroups—Get Contact Groupsdb2ApiDfn/a
db2GetContacts—Get Contactsdb2ApiDfn/a
db2GetHealthNotificationList—Get Health Notification Listdb2ApiDfn/a
db2ResetAlertCfg—Reset Alert Configurationdb2ApiDfn/a
db2UpdateAlertCfg—Update Alert Configurationdb2ApiDfn/a
db2UpdateContact—Update Contactdb2ApiDfn/a
db2UpdateContactGroup—Update Contact Groupdb2ApiDfn/a
db2UpdateHealthNotificationList—Update Health Notification Listdb2ApiDfn/a
Data Utilities
sqluexpr—ExportsqlutilC: tbmove.sqc

C++: tbmove.sqC

COBOL: expsamp.sqb, impexp.sqb, tload.sqb
sqluimpr—ImportsqlutilC: dtformat.sqc, tbmove.sqc

C++: tbmove.sqC

COBOL: expsamp.sqb, impexp.sqb
db2Load—Loaddb2ApiDfC: dtformat.sqc, tbmove.sqc C++: tbmove.sq
db2LoadQuery—Load Querydb2ApiDfC: tbmove.sqc

C++: tbmove.sqC

COBOL: loadqry.sqb
General Application Programming
db2AutoConfig—Autoconfiguredb2AuCfgC: dbcfg.sqc C++: dbcfg.sqC
db2AutoConfigFreeMemory—Free Autoconfigure Memorydb2AuCfgC: dbcfg.sqc C++: dbcfg.sqC
sqlaintp—Get Error MessagesqlC: dbcfg.sqc, utilapi.c

C++: dbcfg.sqC, utilapi.C

COBOL: checkerr.cbl
sqlogstt—Get SQLSTATE MessagesqlC: utilapi.c

C++: utilapi.C

COBOL: checkerr.cbl
sqleisig—Install Signal HandlersqlenvCOBOL: dbcmt.cbl
sqleintr—Interruptsqlenvn/a
sqlgdref—Dereference Addresssqlutiln/a
sqlgmcpy—Copy Memorysqlutiln/a
sqlefmem—Free MemorysqlenvC: dbrecov.sqc, tsinfo.sqc

C++: dbrecov.sqC, tsinfo.sqC

COBOL: tabscont.sqb, tabspace.sqb, tspace.sqb
sqlgaddr—Get Addresssqlutiln/a
Application Preparation
sqlaprep—Precompile ProgramsqlC: dbpkg.sqc C++: dbpkg.sqC
sqlabndx—BindsqlC: dbpkg.sqc, dbsample.sqc C++: dbpkg.sqC
sqlarbnd—RebindsqlC: dbpkg.sqc, dbsample.sqc

C++: dbpkg.sqC

COBOL: rebind.sqb
Remote Server Utilities
sqleatin—AttachsqlenvC: inattach.c, utilapi.c

C++: inattach.C, utilapi.C

COBOL: dbinst.cb
sqleatcp—Attach and Change PasswordsqlenvC: inattach.c

C++: inattach.C

COBOL: dbinst.cbl
sqledtin—DetachsqlenvC: inattach.c, utilapi.c

C++: inattach.C, utilapi.C

COBOL: dbinst.cb
Table Space Management
sqlbtcq—Table Space Container QuerysqlutilC: dbrecov.sqc, tsinfo.sqc

C++: dbrecov.sqC, tsinfo.sqC

COBOL: tabscont.sqb, tspace.sqb
sqlbotcq—Open Table Space Container QuerysqlutilC: tsinfo.sqc

C++: tsinfo.sqC

COBOL: tabscont.sqb, tspace.sqb
sqlbftcq—Fetch Table Space Container QuerysqlutilC: tsinfo.sqc

C++: tsinfo.sqC

COBOL: tabscont.sqb, tspace.sqb
sqlbctcq—Close Table Space Container QuerysqlutilC: tsinfo.sqc

C++: tsinfo.sqC

COBOL: tabscont.sqb, tspace.sqb
sqlbstsc—Set Table Space ContainerssqlutilC: dbrecov.sqc

C++: dbrecov.sqC

COBOL: tabscont.sqb, tspace.sqb
sqlbmtsq—Table Space QuerysqlutilC: dbrecov.sqc, tsinfo.sqc

C++: dbrecov.sqC, tsinfo.sqC

COBOL: tabspace.sqb, tspace.sqb
sqlbstpq—Single Table Space QuerysqlutilC: tsinfo.sqc

C++: tsinfo.sqC

COBOL: tabspace.sqb, tspace.sqb
sqlbotsq—Open Table Space QuerysqlutilC: tsinfo.sqc

C++: tsinfo.sqC

COBOL: tabspace.sqb, tspace.sqb
sqlbftpq—Fetch Table Space QuerysqlutilC: tsinfo.sqc

C++: tsinfo.sqC

COBOL: tabspace.sqb, tspace.sqb
sqlbctsq—Close Table Space QuerysqlutilC: tsinfo.sqc

C++: tsinfo.sqC

COBOL: tabspace.sqb, tspace.sqb
sqlbgtss—Get Table Space StatisticssqlutilC: tsinfo.sqc

C++: tsinfo.sqC

COBOL: tabspace.sqb, tspace.sqb
sqluvqdp—Quiesce Table Spaces for TablesqlutilC: tbmove.sqc

C++: tbmove.sqC

COBOL: tload.sqb
Node Management
sqleaddn—Add Nodesqlenvn/a
sqledrpn—Drop Node Verifysqlenvn/a
Satellite
db2GetSyncSession—Get Satellite Sync Sessiondb2ApiDfn/a
db2QuerySatelliteProgress—Query Satellite Syncdb2ApiDfn/a
db2SetSyncSession—Set Satellite Sync Sessiondb2ApiDfn/a
db2SyncSatellite—Sync Satellitedb2ApiDfn/a
db2SyncSatelliteStop—Stop Satellite Syncdb2ApiDfn/a
db2SyncSatelliteTest—Test Satellite Syncdb2ApiDfn/a
Database Partition Group Management
sqludrdt—Redistribute Database Partition Groupsqlutiln/a
Additional APIs
sqluadau—Get AuthorizationssqlutilC: dbauth.sqc, inauth.sqc C++: dbauth.sqC, inauth.sqC
sqlegins—Get InstancesqlenvC: ininfo.c

C++: ininfo.C

COBOL: dbinst.cbl
sqleqryc—Query ClientsqlenvC: cli_info.c

C++: cli_info.C

COBOL: client.cbl
sqleqryi—Query Client InformationsqlenvC: cli_info.c C++: cli_info.C
sqlesetc—Set ClientsqlenvC: cli_info.c, dbcfg.sqc, dbmcon.sqc

C++: cli_info.C, dbcfg.sqC, dbmcon.sqC

COBOL: client.cbl
sqleseti—Set Client InformationsqlenvC: cli_info.c C++: cli_info.C
sqlesact—Set Accounting StringsqlenvC: cli_info.c

C++: cli_info.C

COBOL: setact.cbl
db2ReadLog—Asynchronous Read Logdb2ApiDfC: dbrecov.sqc C++: dbrecov.sqC
db2ReadLogNoConn—Read Log Without a Database Connectiodb2ApiDfn/a
db2ReadLogNoConnInit—Initialize Read Log Without a Database Connectiondb2ApiDfn/a
db2ReadLogNoConnTerm—Terminate Read Log Without a Database Connectiondb2ApiDfn/a
sqlugrpn—Get Row Partitioning Numbersqlutiln/a
sqlugtpi—Get Table Partitioning Informationsqlutiln/a
db2AdminMsgWrite—Administration Message Writedb2ApiDfn/a
db2SetWriteForDBdb2ApiDfn/a
db2ArchiveLog—Archive Active Logdb2ApiDfn/a
db2DatabasePing—Ping Databasedb2ApiDfn/a
db2Inspect —Inspect databasedb2ApiDfn/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).


..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset
3.144.250.153