IBM Books

API Reference

API Ref IBM DB2 Universal Database
API Reference

Version 5

S10J-8167-00


10J8167

Before using this information and the product it supports, be sure to read the general information under Appendix I. "Notices".

This document contains proprietary information of IBM. It is provided under a license agreement and is protected by copyright law. The information contained in this publication does not include any product warranties and any statements provided in this manual should not be interpreted as such.

Order publications through your IBM representative or the IBM branch office serving your locality or by calling 1-800-879-2755 in U.S. or 1-800-IBM-4YOU in Canada.

When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to you.

© Copyright International Business Machines Corporation 1993, 1997. All rights reserved.
Note to U.S. government Users -- Documentation related to restricted rights -- Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule contract with IBM Corp.

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
  • 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
  • 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
  • sqleregs - Register
  • sqlerstd - Restart Database
  • sqlesact - Set Accounting String
  • sqlesdeg - Set Runtime Degree
  • sqlesetc - Set Client
  • 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
  • sqlmon - Get/Update Monitor Switches
  • sqlmonss - Get Snapshot
  • sqlmonsz - Estimate Size Required for sqlmonss() Output Buffer
  • sqlmrset - Reset Monitor
  • 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
  • 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
  • sqluimpr - Import
  • sqluload - Load
  • sqluqry - Load Query
  • sqlureot - Reorganize Table
  • sqlurlog - Asynchronous Read Log
  • sqluroll - Rollforward Database
  • sqlurst - Restore Database
  • sqlustat - Runstats
  • sqluvqdp - Quiesce Tablespaces for Table

    • Chapter 2. Additional REXX APIs

  • Change Isolation Level

    • Chapter 3. Data Structures

  • 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-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
  • SQLUHINFO
  • 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 Database Director
  • 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 Propagation, Alter Check Pending, Rollback Propagation Change, Rollback Check Pending Change
  • 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 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
  • Utility Manager Log Records
  • Migration Begin
  • Migration End
  • Load Start
  • Load Pending List
  • Backup End
  • Tablespace Rolled Forward
  • Tablespace Roll Forward to PIT Begins
  • Tablespace Roll Forward to PIT Ends

    • Appendix G. Application Migration Considerations

  • Changed APIs and Data Structures

    • Appendix H. How the DB2 Library Is Structured

  • SmartGuides
  • Online Help
  • DB2 Books
  • About the Information Center

    • Appendix I. Notices

  • Trademarks
  • Trademarks of Other Companies

    • Appendix J. Contacting IBM

    Index

    About This Book

    This book provides information about the use of application programming interfaces (APIs) to execute database administrative functions. It presents detailed information on the use of database manager API calls in applications written in the following programming languages:

    For a compiled language, an appropriate precompiler must be available to process the statements. Precompilers are provided for all supported languages.

    [ Top of Page | Next Page | Index ]

    [ DB2 List of Books | Search the DB2 Books ]