DB2 APIs

db2AddContact API - Add a contact to whom notification messages can be sent
Adds a contact to the contact list. Contacts are users to whom notification messages can be sent.
db2AddContactGroup API - Add a contact group to whom notification messages can be sent
Adds a new contact group to the list of contact groups. A contact group contains a list of users to whom notification messages can be sent.
db2AddSnapshotRequest API - Add a snapshot request
Prepares the snapshot request stream for db2GetSnapshotSize and db2GetSnapshot.
db2AdminMsgWrite API - Write log messages for administration and replication function
Provides a mechanism for users and Replication to write information to the db2diag log file, and the administration notification log.
db2ArchiveLog API - Archive the active log file
Closes and truncates the active log file for a recoverable database. If user exit is enabled, it also issues an archive request.
db2AutoConfig API - Access the Configuration Advisor
Allows application programs to access the Configuration Advisor.
db2AutoConfigFreeMemory API - Free the memory allocated by the db2AutoConfig API
Frees the memory allocated by the db2AutoConfig API.
db2Backup API - Back up a database or table space
Creates a backup copy of a database or a table space.
db2CfgGet API - Get the database manager or database configuration parameters
Returns the values of individual entries in a specific database configuration file or a database manager configuration file.
db2CfgSet API - Set the database manager or database configuration parameters
Modifies individual entries in a specific database configuration file or a database manager configuration file.
db2ConvMonStream API - Convert the monitor stream to the pre-version 6 format
Converts the new, self-describing format for a single logical data element (for example, SQLM_ELM_DB2) to the corresponding pre-version 6 external monitor structure (for example, sqlm_db2).
db2DatabasePing API - Ping the database to test network response time
Tests the network response time of the underlying connectivity between a client and a database server.
db2DatabaseQuiesce API - Quiesce the database
Forces all users off the database, immediately rolls back all active transactions or waits for them to complete their current units of work within the number of minutes specified (if they cannot be completed within the specified number of minutes, the operation will fail), and puts the database into quiesce mode.
db2DatabaseRestart API - Restart database
Restarts a database that has been abnormally terminated and left in an inconsistent state.
db2DatabaseUnquiesce API - Unquiesce database
Restores user access to databases which have been quiesced for maintenance or other reasons. User access is restored without necessitating a shutdown and database restart.
db2DatabaseUpgrade API - Upgrade previous version of Db2 database to the current release
Upgrades a Db2 database to the current release from a supported release earlier than Db2 version 11.1.
db2DbDirCloseScan API - End a system or local database directory scan
Frees the resources allocated by db2DbDirOpenScan.
db2DbDirGetNextEntry API - Get the next system or local database directory entry
Returns the next entry in the system database directory or the local database directory copy returned by db2DbDirOpenScan. Subsequent calls to this API return additional entries.
db2DbDirOpenScan API - Start a system or local database directory scan
Stores a copy of the system database directory or the local database directory in memory, and returns the number of entries.
db2DropContact API - Remove a contact from the list of contacts to whom notification messages can be sent
Removes a contact from the list of contacts. Contacts are users to whom notification messages can be sent.
db2DropContactGroup API - Remove a contact group from the list of contacts to whom notification messages can be sent
Removes a contact group from the list of contacts. A contact group contains a list of users to whom notification messages can be sent.
db2Export API - Export data from a database
Exports data from a database to one of several external file formats.
db2GetAlertCfg API - Get the alert configuration settings for the health indicators
Returns the alert configuration settings for the health indicators.
db2GetAlertCfgFree API - Free the memory allocated by the db2GetAlertCfg API
Frees the memory allocated by the db2GetAlertCfg API.
db2GetContactGroup API - Get the list of contacts in a single contact group to whom notification messages can be sent
Returns the contacts included in a single contact group.
db2GetContactGroups API - Get the list of contact groups to whom notification messages can be sent
Returns the list of contact groups. Contacts are users to whom notification messages can be sent.
db2GetContacts API - Get the list of contacts to whom notification messages can be sent
Returns the list of contacts. Contacts are users to whom notification messages can be sent.
db2GetDistMap API - Get distribution map
Allows an application to obtain the distribution information for a table. The distribution information includes the distribution map and the column definitions of the distribution key.
db2GetHealthNotificationList API - Get the list of contacts to whom health alert notifications can be sent
Returns the list of contacts or contact groups, or both, that are notified about the health of an instance.
db2GetRecommendations API - Get recommendations to resolve a health indicator in alert state
Retrieves a set of recommendations to resolve a health indicator in alert state on a particular object. The recommendations are returned as an XML document.
db2GetRecommendationsFree API - Free the memory allocated by the db2GetRecommendations API
Frees the memory allocated by the db2GetRecommendations API.
db2GetRowPartNum API - Get the database partition server number for a row
Returns the database partition number and the database partition server number based on the distribution key values. An application can use this information to determine on which database partition server a specific row of a table is stored.
db2GetSnapshot API - Get a snapshot of the database manager operational status
Collects database manager monitor information and returns it to a user-allocated data buffer. The information returned represents a snapshot of the database manager operational status at the time the API was called.
db2GetSnapshotSize API - Estimate the output buffer size required for the db2GetSnapshot API
Estimates the buffer size needed by the db2GetSnapshot API.
db2GetSyncSession API - Get a satellite synchronization session identifier
Gets the satellite's current synchronization session identifier.
db2HADRStart API - Start high availability disaster recovery (HADR) operations
Starts HADR operations on a database.
db2HADRStop API - Stop high availability disaster recovery (HADR) operations
Stops HADR operations on a database.
db2HADRTakeover API - Instruct a database to take over as the high availability disaster recovery (HADR) primary database
Instructs a standby database to take over as the primary database. This API can be called against a standby database only.
db2HistoryCloseScan API - End the database history records scan
Ends a database history records scan and frees Db2 resources required for the scan. This API must be preceded by a successful call to the db2HistoryOpenScan API.
db2HistoryGetEntry API - Get the next entry in the database history records
Gets the next entry from the database history records. This API must be preceded by a successful call to the db2HistoryOpenScan API.
db2HistoryOpenScan API - Start a database history records scan
Starts a database history records scan.
db2HistoryUpdate API - Update a database history records entry
Updates the location, device type, or comment in a database history records entry.
db2Import API - Import data into a table, hierarchy, nickname or view
Inserts data from an external file with a supported file format into a table, hierarchy, nickname or view.
db2Ingest API- Ingest data from an input file or pipe into a Db2 table.
Inserts data from an input file or pipe into a Db2 table.
db2Inspect API - Inspect database for architectural integrity
Inspects the database for architectural integrity and checks the pages of the database for page consistency.
db2InstanceQuiesce API - Quiesce instance
Forces all users off the instance, immediately rolls back all active transaction, and puts the instance into quiesce mode.
db2InstanceStart API - Start instance
Starts the local or remote Db2 instance.
db2InstanceStop API - Stop instance
Stops the local or remote Db2 instance.
db2InstanceUnquiesce API - Unquiesce instance
Unquiesce all databases in the instance.
db2LdapCatalogDatabase API - Register the database on the LDAP server
Catalogs a database entry in LDAP (Lightweight Directory Access Protocol).
db2LdapCatalogNode API - Provide an alias for node name in LDAP server
Specifies an alternate name for the node entry in LDAP (Lightweight Directory Access Protocol), or a different protocol type for connecting to the database server.
db2LdapDeregister API - Deregister the Db2 server and cataloged databases from the LDAP server
Deregisters the Db2 server from LDAP (Lightweight Directory Access Protocol).
db2LdapRegister API - Register the Db2 server on the LDAP server
Registers the Db2 server in LDAP (Lightweight Directory Access Protocol).
db2LdapUncatalogDatabase API - Deregister database from LDAP server
Removes a database entry from LDAP (Lightweight Directory Access Protocol).
db2LdapUncatalogNode API - Delete alias for node name from LDAP server
Removes a node entry from LDAP (Lightweight Directory Access Protocol).
db2LdapUpdate API - Update the attributes of the Db2 server on the LDAP server
Updates the communication protocol information for the Db2 server in LDAP (Lightweight Directory Access Protocol).
db2LdapUpdateAlternateServerForDB API - Update the alternate server for the database on the LDAP server
Updates the alternate server for a database in Lightweight Directory Access Protocol (LDAP).
db2Load API - Load data into a table
Loads data into a Db2 table. Although faster than the import utility, the load utility does not support loading data at the hierarchy level or loading into a nickname.
db2LoadQuery API - Get the status of a load operation
Checks the status of a load operation during processing.
db2MonitorSwitches API - Get or update the monitor switch settings
Selectively turns on or off switches for groups of monitor data to be collected by the database manager. Returns the current state of these switches for the application issuing the call.
db2Prune API - Delete the history file entries or log files from the active log path
Deletes entries from the history file or log files from the active log path.
db2QuerySatelliteProgress API - Get the status of a satellite synchronization session
Checks on the status of a satellite synchronization session.
db2ReadLog API - Read log records
The db2ReadLog API reads log records from the Db2 database logs, or queries the Log Manager for current log state information.
db2ReadLogNoConn API - Read the database logs without a database connection
The db2ReadLogNoConn API extracts log records from the Db2 database logs, or queries the Log Manager for current log state information.
db2ReadLogNoConnInit API - Initialize reading the database logs without a database connection
Allocates the memory to be used by db2ReadLogNoConn in order to extract log records from the Db2 database logs and query the Log Manager for current log state information.
db2ReadLogNoConnTerm API - Terminate reading the database logs without a database connection
Deallocates the memory used by the db2ReadLogNoConn API, originally initialized by the db2ReadLogNoConnInit API.
db2Recover API - Restore and roll forward a database
Restores and rolls forward a database to a particular point in time or to the end of the logs.
db2Reorg API - Reorganize an index or a table
Reorganizes a table or all indexes defined on a table by compacting the information and reconstructing the rows or index data to eliminate fragmented data.
db2ResetAlertCfg API - Reset the alert configuration of health indicators
Resets the health indicator settings for specific objects to the current defaults for that object type or resets the current default health indicator settings for an object type to the install defaults.
db2ResetMonitor API - Reset the database system monitor data
Resets the database system monitor data of a specified database, or of all active databases, for the application issuing the call.
db2Restore API - Restore a database or table space
Recreates a damaged or corrupted database that has been backed up using the db2Backup API. The restored database is in the same state it was in when the backup copy was made.
db2Rollforward API - Roll forward a database
Recovers a database by applying transactions recorded in the database log files.
db2Runstats API - Update statistics for tables and indexes
Updates statistics about the characteristics of a table or any associated indexes or statistical views. This command can also update statistics about the characteristics of both a table and any associated indexes or statistical views.
db2SelectDB2Copy API - Select the Db2 copy to be used by your application
Sets the environment required by your application to use a particular Db2 copy or the location specified.
db2SetStogroupPaths API - Redirect storage group paths
Sets the storage paths of a storage group during a redirected restore operation.
db2SetSyncSession API - Set satellite synchronization session
Sets the synchronization session for a satellite.
db2SetWriteForDB API - Suspend or resume I/O writes for database
Suspends or resumes the I/O write operations for a database. I/O write operations must be suspended before a split mirror of a database can be taken.
db2SpmListIndTrans API - List SPM indoubt transactions
Provides a list of transactions that are indoubt at the Syncpoint Manager.
db2SyncSatellite API - Start satellite synchronization
Synchronizes a satellite. Satellite synchronization involves bringing a satellite to a state that is consistent with the other satellites of its group.
db2SyncSatelliteStop API - Pause satellite synchronization
Stops the satellite's currently active synchronization session.
db2SyncSatelliteTest API - Test whether a satellite can be synchronized
Tests the ability of a satellite to synchronize that is, tests whether the satellite can be brought to a state that is consistent with the other satellites of its group.
db2UpdateAlertCfg API - Update the alert configuration settings for health indicators
Updates the alert configuration settings for health indicators.
db2UpdateAlternateServerForDB API - Update the alternate server for a database alias in the system database directory
Updates the alternate server for a database alias in the system database directory.
db2UpdateContact API - Update the attributes of a contact
Updates the attributes of a contact. Contacts are users to whom notification messages can be sent.
db2UpdateContactGroup API - Update the attributes of a contact group
Updates the attributes of a contact group. A contact group contains a list of users to whom notification messages can be sent.
db2UpdateHealthNotificationList API - Update the list of contacts to whom health alert notifications can be sent
Updates the contact list for notification about health alerts issued by an instance.
db2UtilityControl API - Set the priority level of running utilities
Controls the priority level of running utilities. Can be used to throttle and unthrottle utility invocations.
sqlabndx API - Bind application program to create a package
Invokes the bind utility, which prepares SQL statements stored in the bind file generated by the precompiler, and creates a package that is stored in the database.
sqlaintp API - Get error message
Retrieves the message associated with an error condition specified by the sqlcode field of the sqlca structure.
sqlaprep API - Precompile application program
Processes an application program source file containing embedded SQL statements. A modified source file is produced containing host language calls for the SQL statements and, by default, a package is created in the database.
sqlarbnd API - Rebind package
Allows the user to re-create a package stored in the database without the need for a bind file.
sqlbctcq API - Close a table space container query
Ends a table space container query request and frees the associated resources.
sqlbctsq API - Close a table space query
Ends a table space query request, and frees up associated resources.
sqlbftcq API - Fetch the query data for rows in a table space container
Fetches a specified number of rows of table space container query data, each row consisting of data for a container.
sqlbftpq API - Fetch the query data for rows in a table space
Fetches a specified number of rows of table space query data, each row consisting of data for a table space.
sqlbgtss API - Get table space usage statistics
Provides information about the space utilization of a table space.
sqlbmtsq API - Get the query data for all table spaces
Provides a one-call interface to the table space query data. The query data for all table spaces in the database is returned in an array.
sqlbotcq API - Open a table space container query
Prepares for a table space container query operation, and returns the number of containers currently in the table space.
sqlbotsq API - Open a table space query
Prepares for a table space query operation, and returns the number of table spaces currently in the database.
sqlbstpq API - Get information about a single table space
Retrieves information about a single currently defined table space.
sqlbstsc API - Set table space containers
Facilitates the provision of a redirected restore, in which the user is restoring a database, and a different set of operating system storage containers is required.
sqlbtcq API - Get the query data for all table space containers
Provides a one-call interface to the table space container query data. The query data for all containers in a table space, or for all containers in all table spaces, is returned in an array.
sqlcspqy API - List DRDA indoubt transactions
Provides a list of transactions that are indoubt between the syncpoint manager partner connections.
sqle_activate_db API - Activate database
Activates the specified database and starts up all associated database services, so that the database is available for connection and use by any application.
sqle_deactivate_db API - Deactivate database
Deactivates the specified database and stops all associated database services.
sqleaddn API - Add a database partition to the partitioned database environment
Adds a database partition to a database partition server.
sqleatcp API - Attach to instance and change password
Enables an application to specify the node at which instance-level functions (CREATE DATABASE and FORCE APPLICATION, for example) are to be executed.
sqleatin API - Attach to instance
Enables an application to specify the node at which instance-level functions (CREATE DATABASE and FORCE APPLICATION, for example) are to be executed.
sqlecadb API - Catalog a database in the system database directory
Stores database location information in the system database directory. The database can be located either on the local workstation or on a remote database partition server.
sqlecran API - Create a database on a database partition server
Creates a database only on the database partition server that calls the API.
sqlecrea API - Create database
Initializes a new database with an optional user-defined collating sequence, creates the three initial table spaces, creates the system tables, and allocates the recovery log.
sqlectnd API - Catalog an entry in the node directory
Stores information in the node directory about the location of a Db2 server instance based on the communications protocol used to access that instance.
sqledcgd API - Change a database comment in the system or local database directory
Changes a database comment in the system database directory or the local database directory.
sqledpan API - Drop a database on a database partition server
Drops a database at a specified database partition server. Can only be run in a partitioned database environment.
sqledrpd API - Drop database
Deletes the database contents and all log files for the database, uncatalogs the database, and deletes the database subdirectory.
sqledrpn API - Check whether a database partition server can be dropped
Verifies whether a database partition server is being used by a database. A message is returned, indicating whether the database partition server can be dropped.
sqledtin API - Detach from instance
Removes the logical instance attachment, and terminates the physical communication connection if there are no other logical connections using this layer.
sqlefmem API - Free the memory allocated by the sqlbtcq and sqlbmtsq API
Frees memory allocated by Db2 APIs on the caller's behalf. Intended for use with the sqlbtcq and sqlbmtsq APIs.
sqlefrce API - Force users and applications off the system
Forces local or remote users or applications off the system to allow for maintenance on a server.
sqlegdad API - Catalog a database in the database connection services (DCS) directory
Stores information about remote databases in the Database Connection Services (DCS) directory.
sqlegdcl API - End a database connection services (DCS) directory scan
Frees the resources that are allocated by the sqlegdsc API.
sqlegdel API - Uncatalog a database from the database connection services (DCS) directory
Deletes an entry from the Database Connection Services (DCS) directory.
sqlegdge API - Get a specific entry in the database connection services (DCS) directory
Returns information for a specific entry in the Database Connection Services (DCS) directory.
sqlegdgt API - Get database connection services (DCS) directory entries
Transfers a copy of Database Connection Services (DCS) directory entries to a buffer supplied by the application.
sqlegdsc API - Start a database connection services (DCS) directory scan
Stores a copy in memory of the Database Connection Services directory entries, and returns the number of entries. This is a snapshot of the directory at the time the directory is opened.
sqlegins API - Get current instance
Returns the value of the DB2INSTANCE environment variable.
sqleintr API - Interrupt application requests
Stops a request. This API is called from a control break signal handler in an application.
sqleisig API - Install signal handler
Installs the default interrupt (usually Control-C or Control-Break, or both) signal handler. When this default handler detects an interrupt signal, it resets the signal and calls sqleintr.
sqlemgdb API - Upgrade previous version of Db2 database to current version
Converts a previous (Version 8 or higher) version of a Db2 database to the current release.
sqlencls API - End a node directory scan
Frees the resources that are allocated by the sqlenops API.
sqlengne API - Get the next node directory entry
Returns the next entry in the node directory after sqlenops - Open Node Directory Scan is called. Subsequent calls to this API return additional entries.
sqlenops API - Start a node directory scan
Stores a copy in memory of the node directory, and returns the number of entries.
sqleqryc API - Query client connection settings
Returns current connection settings for an application process. The sqle_conn_setting data structure is populated with the connection setting types and values.
sqleqryi API - Query client information
Returns existing client information by populating the fields in the sqle_client_info data structure.
sqlesact API - Set accounting string
Provides accounting information that will be sent to a DRDA server with the application's next connect request.
sqlesdeg API - Set the maximum runtime intrapartition parallelism level or degree for SQL statements
Sets the maximum run time degree of intrapartition parallelism for SQL statement execution for specified active applications. It has no effect on CREATE INDEX statement execution parallelism.
sqlesetc API - Set client connection settings
Specifies connection settings for the application. Use the sqle_conn_setting data structure to specify the connection setting types and values.
sqleseti API - Set client information
Permits an application to set client information (by setting the fields in the sqle_client_info data structure) associated with a specific connection, provided a connection already exists.
sqleuncd API - Uncatalog a database from the system database directory
Deletes an entry from the system database directory.
sqleuncn API - Uncatalog an entry from the node directory
Deletes an entry from the node directory.
sqlgaddr API - Get the address of a variable
Places the address of a variable into another variable.
sqlgdref API - Dereference an address
Copies data from a buffer that is defined by a pointer, into a variable that is directly accessible by the application.
sqlgmcpy API - Copy data from one memory area to another
Copies data from one memory area to another. This API is used in host programming languages, FORTRAN and COBOL, that do not provide memory block copy functions.
sqlogstt API - Get the SQLSTATE message
Retrieves the message text associated with an SQLSTATE value.
sqludrdt API - Redistribute data across a database partition group
Redistributes data across the database partitions in a database partition group.
sqlugrpn API - Get the database partition server number for a row
Beginning with Version 9.7, this API is deprecated. Use the db2GetRowPartNum (Get the database partition server number for a row) API to return the database partition number and database partition server number for a row.
sqlugtpi API - Get table distribution information
Allows an application to obtain the distribution information for a table.
sqluvqdp API - Quiesce table spaces for a table
Quiesces table spaces for a table.

Parent topic: Db2 APIs