Administrative API Reference

Table of Contents

About This Book

Who Should Use this Book
How this Book is Structured

Chapter 1. Application Programming Interfaces

DB2 APIs
DB2 Sample Programs
How the API Descriptions are Organized
db2AdminMsgWrite
db2AutoConfig
db2AutoConfigFreeMemory
db2ConvMonStream
db2DatabaseRestart - Restart Database
db2GetSnapshot - Get Snapshot
db2GetSnapshotSize - Estimate Size Required for db2GetSnapshot() Output Buffer
db2GetSyncSession
db2HistoryCloseScan - Close Recovery History File Scan
db2HistoryGetEntry - Get Next Recovery History File Entry
db2HistoryOpenScan - Open Recovery History File Scan
db2HistoryUpdate - Update Recovery History File
db2LdapCatalogDatabase
db2LdapCatalogNode
db2LdapDeregister
db2LdapRegister
db2LdapUncatalogDatabase
db2LdapUncatalogNode
db2LdapUpdate
db2LoadQuery - Load Query
db2MonitorSwitches - Get/Update Monitor Switches
db2Prune
db2QuerySatelliteProgress
db2ResetMonitor - Reset Monitor
db2SetSyncSession
db2SyncSatellite
db2SyncSatelliteStop
db2SyncSatelliteTest
sqlabndx - Bind
sqlaintp - Get Error Message
sqlaprep - Precompile Program
sqlarbnd - Rebind
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
sqlcspqy - List DRDA Indoubt Transactions
sqle_activate_db - Activate Database
sqle_deactivate_db - Deactivate Database
sqleaddn - Add Node
sqleatcp - Attach and Change Password
sqleatin - Attach
sqlecadb - Catalog Database
sqlecran - Create Database at Node
sqlecrea - Create Database
sqlectnd - Catalog Node
sqledcgd - Change Database Comment
sqledcls - Close Database Directory Scan
sqledgne - Get Next Database Directory Entry
sqledosd - Open Database Directory Scan
sqledpan - Drop Database at Node
sqledreg - Deregister
sqledrpd - Drop Database
sqledrpn - Drop Node Verify
sqledtin - Detach
sqlefmem - Free Memory
sqlefrce - Force Application
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
sqlegins - Get Instance
sqleintr - Interrupt
sqleisig - Install Signal Handler
sqlemgdb - Migrate Database
sqlencls - Close Node Directory Scan
sqlengne - Get Next Node Directory Entry
sqlenops - Open Node Directory Scan
sqlepstart - Start Database Manager
sqlepstp - Stop Database Manager
sqleqryc - Query Client
sqleqryi - Query Client Information
sqleregs - Register
sqlesact - Set Accounting String
sqlesdeg - Set Runtime Degree
sqlesetc - Set Client
sqleseti - Set Client Information
sqleuncd - Uncatalog Database
sqleuncn - Uncatalog Node
sqlfddb - Get Database Configuration Defaults
sqlfdsys - Get Database Manager Configuration Defaults
sqlfrdb - Reset Database Configuration
sqlfrsys - Reset Database Manager Configuration
sqlfudb - Update Database Configuration
sqlfusys - Update Database Manager Configuration
sqlfxdb - Get Database Configuration
sqlfxsys - Get Database Manager Configuration
sqlgaddr - Get Address
sqlgdref - Dereference Address
sqlgmcpy - Copy Memory
sqlogstt - Get SQLSTATE Message
sqluadau - Get Authorizations
sqlubkp - Backup Database
sqludrdt - Redistribute Nodegroup
sqluexpr - Export
sqlugrpn - Get Row Partitioning Number
sqlugtpi - Get Table Partitioning Information
sqluimpr - Import
sqluload - Load
sqlurcon - Reconcile
sqlureot - Reorganize Table
sqlurestore - Restore Database
sqlurlog - Asynchronous Read Log
sqluroll - Rollforward Database
sqlustat - Runstats
sqluvqdp - Quiesce Tablespaces for Table

Chapter 2. Additional REXX APIs

Change Isolation Level

Chapter 3. Data Structures

db2HistData
RFWD-INPUT
RFWD-OUTPUT
SQL-AUTHORIZATIONS
SQL-DIR-ENTRY
SQLA-FLAGINFO
SQLB-TBS-STATS
SQLB-TBSCONTQRY-DATA
SQLB-TBSPQRY-DATA
SQLCA
SQLCHAR
SQLDA
SQLDCOL
SQLE-ADDN-OPTIONS
SQLE-CLIENT-INFO
SQLE-CONN-SETTING
SQLE-NODE-APPC
SQLE-NODE-APPN
SQLE-NODE-CPIC
SQLE-NODE-IPXSPX
SQLE-NODE-LOCAL
SQLE-NODE-NETB
SQLE-NODE-NPIPE
SQLE-NODE-STRUCT
SQLE-NODE-TCPIP
SQLE-REG-NWBINDERY
SQLE-START-OPTIONS
SQLEDBCOUNTRYINFO
SQLEDBDESC
SQLEDBSTOPOPT
SQLEDINFO
SQLENINFO
SQLFUPD
SQLM-COLLECTED
SQLM-RECORDING-GROUP
SQLMA
SQLOPT
SQLU-LSN
SQLU-MEDIA-LIST
SQLU-RLOG-INFO
SQLU-TABLESPACE-BKRST-LIST
SQLUEXPT-OUT
SQLUIMPT-IN
SQLUIMPT-OUT
SQLULOAD-IN
SQLULOAD-OUT
SQLUPI
SQLXA-RECOVER
SQLXA-XID

Appendix A. Naming Conventions

Appendix B. Transaction APIs

Heuristic APIs
sqlxhfrg - Forget Transaction Status
sqlxphcm - Commit an Indoubt Transaction
sqlxphqr - List Indoubt Transactions
sqlxphrl - Roll Back an Indoubt Transaction

Appendix C. Precompiler Customization APIs

Appendix D. Backup and Restore APIs for Vendor Products

Operational Overview
Number of Sessions
Operation with No Errors, Warnings or Prompting
PROMPTING Mode
Device Characteristics
If Error Conditions Are Returned to DB2
Warning Conditions
Operational Hints and Tips
Recovery History File
Functions and Data Structures
sqluvint - Initialize and Link to Device
sqluvget - Reading Data from Device
sqluvput - Writing Data to Device
sqluvend - Unlink the Device and Release its Resources
sqluvdel - Delete Committed Session
DB2-INFO
VENDOR-INFO
INIT-INPUT
INIT-OUTPUT
DATA
RETURN-CODE
Invoking Backup/Restore Using Vendor Products
The Control Center
The Command Line Processor
Backup and Restore API Function Calls

Appendix E. Threaded Applications with Concurrent Access

sqleAttachToCtx - Attach to Context
sqleBeginCtx - Create and Attach to an Application Context
sqleDetachFromCtx - Detach From Context
sqleEndCtx - Detach and Destroy Application Context
sqleGetCurrentCtx - Get Current Context
sqleInterruptCtx - Interrupt Context
sqleSetTypeCtx - Set Application Context Type

Appendix F. DB2 Common Server Log Records

Log Manager Header
Data Manager Log Records
Initialize Table
Import Replace (Truncate)
Rollback Insert
Reorg Table
Create Index, Drop Index
Create Table, Drop Table, Rollback Create Table, Rollback Drop Table
Alter Table Attribute
Alter Table Add Columns, Rollback Add Columns
Insert Record, Delete Record, Rollback Delete Record, Rollback Update Record
Update Record
Long Field Manager Log Records
Add/Delete/Non-update Long Field Record
LOB Manager Log Records
Insert LOB Data Log Record (AFIM_DATA)
Insert LOB Data Log Record (AFIM_AMOUNT)
Transaction Manager Log Records
Normal Commit
Heuristic Commit
MPP Coordinator Commit
MPP Subordinator Commit
Normal Abort
Heuristic Abort
Local Pending List
Global Pending List
XA Prepare
MPP Subordinator Prepare
Backout Free
Utility Manager Log Records
Datalink Manager Log Records
Application Migration Considerations
Changed APIs and Data Structures
Using the DB2 Library
DB2 PDF Files and Printed Books
DB2 Online Documentation
Notices
Trademarks
Contacting IBM
Product Information

Index