Upload
others
View
6
Download
0
Embed Size (px)
Citation preview
IBM DB2 10.1para Linux, UNIX y Windows
Consulta de las API administrativas
SC11-8067-00
���
IBM DB2 10.1para Linux, UNIX y Windows
Consulta de las API administrativas
SC11-8067-00
���
NotaAntes de utilizar esta información y el producto al que da soporte, lea la información general contenida en el apartadoApéndice D, “Avisos”, en la página 783.
Nota de edición
Este manual es la traducción del original en inglés IBM DB2 10.1 for Linux, UNIX, and Windows Administrative APIReference (SC27-3864-00).
Este documento contiene información propiedad de IBM. Se proporciona según un acuerdo de licencia y estáprotegido por la ley de la propiedad intelectual. La información contenida en esta publicación no incluye ningunagarantía de producto, por lo que ninguna declaración proporcionada en este manual deberá interpretarse como tal.
Puede realizar pedidos de publicaciones de IBM en línea o a través del representante de IBM de su localidad.v Para solicitar publicaciones en línea, vaya a IBM Publications Center en http://www.ibm.com/shop/
publications/order
v Para encontrar al representante local de IBM que le corresponde, vaya a la sección Worlwide Contacts de IBMDirectory en http://www.ibm.com/planetwide/
Para realizar pedidos de publicaciones de DB2 desde DB2 Marketing and Sales, en los EE.UU. o en Canadá, llameal 1-800-IBM-4YOU (426-4968).
Cuando envía información a IBM, está otorgando a IBM el derecho no exclusivo de utilizar o distribuir lainformación de cualquier forma que considere adecuada sin incurrir por ello a ninguna obligación para con usted.
© Copyright IBM Corporation 1993, 2012.
http://www.ibm.com/shop/publications/orderhttp://www.ibm.com/shop/publications/orderhttp://www.ibm.com/planetwide/
Contenido
Acerca de este manual . . . . . . . . ixQuién debe utilizar este manual . . . . . . . ixCómo esta estructurado este manual . . . . . . ixConvenios de resaltado . . . . . . . . . . . x
Capítulo 1. Las API de DB2 . . . . . . 1
Capítulo 2. Cambios en las API yestructuras de datos. . . . . . . . . 23
Capítulo 3. Cambios en el número desecuencia de anotaciones cronológicasque afectan al comportamiento de lasAPI y las aplicaciones . . . . . . . . 27
Capítulo 4. Cómo están organizadaslas descripciones de las API . . . . . 31Archivos de inclusión para aplicaciones de las APIde DB2 . . . . . . . . . . . . . . . . 35
Capítulo 5. API administrativas . . . . 37db2AddContact - Añadir un contacto al que sepueden enviar mensajes de notificación . . . . . 38db2AddContactGroup - Añadir un grupo decontactos al que se pueden enviar mensajes denotificación . . . . . . . . . . . . . . 40db2AddSnapshotRequest - Añadir una petición deinstantánea . . . . . . . . . . . . . . 42db2AdminMsgWrite - Grabar mensajes de anotacióncronológica para la función de administración yduplicación . . . . . . . . . . . . . . 44db2ArchiveLog - Archivar el archivo de anotacionescronológicas activo . . . . . . . . . . . . 46db2AutoConfig - Acceder al Asesor deconfiguración . . . . . . . . . . . . . . 49db2AutoConfigFreeMemory - Liberar la memoriaasignada por la API db2AutoConfig . . . . . . 53db2Backup - Hacer copia de seguridad de una basede datos o un espacio de tablas. . . . . . . . 54db2CfgGet - Obtener los parámetros deconfiguración del gestor de bases de datos o de labase de datos . . . . . . . . . . . . . . 65db2CfgSet - Definir los parámetros de configuracióndel gestor de bases de datos o de la base de datos . 68db2ConvMonStream - Convertir la corriente desupervisor en el formato anterior a la versión 6 . . 73db2DatabasePing - Sondear la base de datos paraprobar el tiempo de respuesta de la red . . . . . 76db2DatabaseQuiesce - Inmovilizar la base de datos 78db2DatabaseRestart - Reiniciar base de datos . . . 80db2DatabaseUnquiesce - Movilizar base de datos . . 83db2DatabaseUpgrade - Actualizar la versión anteriorde la base de datos DB2 al release actual . . . . 85
db2DbDirCloseScan - Finalizar una exploración deldirectorio de bases de datos locales o del sistema. . 87db2DbDirGetNextEntry - Obtener la entradasiguiente del directorio de bases de datos locales odel sistema . . . . . . . . . . . . . . 88db2DbDirOpenScan - Iniciar una exploración deldirectorio de bases de datos locales o del sistema. . 92db2DropContact - Eliminar un contacto de la listade contactos a los que se pueden enviar mensajes denotificación . . . . . . . . . . . . . . 94db2DropContactGroup - Eliminar un grupo decontactos de la lista de contactos a los que sepueden enviar mensajes de notificación . . . . . 95db2Export - Exportar datos de una base de datos. . 96db2GetAlertCfg - Obtener los valores deconfiguración de alertas para los indicadores desalud . . . . . . . . . . . . . . . . 103db2GetAlertCfgFree - Liberar la memoria asignadapor la API db2GetAlertCfg . . . . . . . . . 108db2GetContactGroup - Obtener la lista de contactosde un solo grupo de contactos al que se puedanenviar mensajes de notificación . . . . . . . 109db2GetContactGroups - Obtener la lista de gruposde contactos a los que se puedan enviar mensajesde notificación . . . . . . . . . . . . . 111db2GetContacts - Obtener la lista de contactos a losque se pueden enviar mensajes de notificación . . 113db2GetDistMap - Obtener correlación dedistribución . . . . . . . . . . . . . . 115db2GetHealthNotificationList - Obtener la lista decontactos a los que se puedan enviar notificacionesde alerta de salud . . . . . . . . . . . . 117db2GetRecommendations - Obtenerrecomendaciones para resolver un indicador desalud en estado de alerta . . . . . . . . . 119db2GetRecommendationsFree - Liberar la memoriaasignada por la API db2GetRecommendations . . 122db2GetSnapshot - Obtener una instantánea delestado operacional del gestor de bases de datos . . 123db2GetSnapshotSize - Calcular el tamaño delalmacenamiento intermedio de salida necesariopara la API db2GetSnapshot . . . . . . . . 127db2GetSyncSession - Obtener un identificador desesión de sincronización de satélites . . . . . . 130db2HADRStart - Iniciar operaciones de HADR(high availability disaster recovery) . . . . . . 131db2HADRStop - Detener operaciones de HADR(high availability disaster recovery) . . . . . . 133db2HADRTakeover - Dar instrucciones a una basede datos para que se convierta en la base de datosprimaria de HADR (high availability disasterrecovery) . . . . . . . . . . . . . . . 135db2HistoryCloseScan - Finalizar la exploración delos registros del histórico de la base de datos . . . 138db2HistoryGetEntry - Obtener la entrada siguientede los registros del histórico de la base de datos. . 139
© Copyright IBM Corp. 1993, 2012 iii
db2HistoryOpenScan - Iniciar una exploración delos registros del histórico de la base de datos . . . 141db2HistoryUpdate - Actualizar una entrada de losregistros del histórico de la base de datos . . . . 145db2Import - Importar datos a una tabla, jerarquía,apodo o vista . . . . . . . . . . . . . 149db2Inspect - Inspeccionar la base de datos paracomprobar la integridad de la arquitectura . . . 164db2InstanceQuiesce - Inmovilizar instancia . . . 172db2InstanceStart - Iniciar instancia . . . . . . 175db2InstanceStop - Detener instancia . . . . . . 181db2InstanceUnquiesce - Movilizar instancia . . . 186db2LdapCatalogDatabase - Registrar la base dedatos en el servidor LDAP . . . . . . . . . 188db2LdapCatalogNode - Proporcionar un alias parael nombre de nodo en el servidor LDAP . . . . 191db2LdapDeregister - Desregistrar el servidor DB2 ylas bases de datos catalogadas del servidor LDAP . 193db2LdapRegister - Registrar el servidor DB2 en elservidor LDAP . . . . . . . . . . . . . 194db2LdapUncatalogDatabase - Desregistrar base dedatos del servidor LDAP . . . . . . . . . 198db2LdapUncatalogNode - Suprimir alias paranombre de nodo del servidor LDAP. . . . . . 199db2LdapUpdate - Actualizar los atributos delservidor DB2 en el servidor LDAP . . . . . . 200db2LdapUpdateAlternateServerForDB - Actualizarel servidor alternativo de la base de datos en elservidor LDAP . . . . . . . . . . . . . 203db2Load - Cargar datos en una tabla . . . . . 205db2LoadQuery - Obtener el estado de unaoperación de carga . . . . . . . . . . . 228db2MonitorSwitches - Obtener o actualizar losvalores de los conmutadores del supervisor . . . 236db2Prune - Suprimir las entradas del archivohistórico o archivos de anotaciones cronológicas dela vía de acceso de anotación cronológica activa . . 239db2QuerySatelliteProgress - Obtener el estado deuna sesión de sincronización de satélites . . . . 242db2ReadLog - Leer registros de anotacionescronológicas . . . . . . . . . . . . . . 244db2ReadLogNoConn - Leer las anotacionescronológicas de la base de datos sin una conexiónde base de datos . . . . . . . . . . . . 251db2ReadLogNoConnInit - Inicializar la lectura delas anotaciones cronológicas de la base de datos sinuna conexión de base de datos . . . . . . . 255db2ReadLogNoConnTerm - Terminar la lectura delas anotaciones cronológicas de la base de datos sinuna conexión de base de datos . . . . . . . 258db2Recover - Restaurar y avanzar una base dedatos . . . . . . . . . . . . . . . . 259db2Reorg - Reorganizar un índice o una tabla . . 265db2ResetAlertCfg - Restablecer la configuración dealertas de los indicadores de salud . . . . . . 275db2ResetMonitor - Restaurar los datos delsupervisor del sistema de base de datos . . . . 277db2Restore - Restaurar una base de datos o unespacio de tablas . . . . . . . . . . . . 280db2Rollforward - Avanzar una base de datos . . . 296
db2Runstats - Actualizar estadísticas para tablas eíndices . . . . . . . . . . . . . . . 307db2SelectDB2Copy - Seleccionar la copia de DB2que la aplicación utiliza . . . . . . . . . . 320db2SetSyncSession - Establecer sesión desincronización de satélites . . . . . . . . . 322db2SetWriteForDB - Suspender o reanudar lasgrabacións de E/S para la base de datos . . . . 323db2SpmListIndTrans - Listar transacciones dudosasSPM . . . . . . . . . . . . . . . . 325db2SyncSatellite - Iniciar sincronización de satélites 329db2SyncSatelliteStop - Pausar sincronización desatélites . . . . . . . . . . . . . . . 330db2SyncSatelliteTest - Probar si se puedesincronizar un satélite . . . . . . . . . . 331db2UpdateAlertCfg - Actualizar los valores deconfiguración de alertas para los indicadores desalud . . . . . . . . . . . . . . . . 332db2UpdateAlternateServerForDB - Actualizar elservidor alternativo para un alias de base de datosen el directorio de bases de datos del sistema . . 338db2UpdateContact - Actualizar los atributos de uncontacto . . . . . . . . . . . . . . . 340db2UpdateContactGroup - Actualizar los atributosde un grupo de contactos . . . . . . . . . 342db2UpdateHealthNotificationList - Actualizar lalista de contactos a los que se puedan enviarnotificaciones de alerta de salud . . . . . . . 344db2UtilityControl - Establecer el nivel de prioridadde los programas de utilidad en ejecución . . . . 346sqlabndx - Programa de aplicación de vinculaciónpara crear un paquete . . . . . . . . . . 348sqlaintp - Obtener mensaje de error . . . . . . 351sqlaprep - Precompilar programa de aplicación . . 353sqlarbnd - Volver a vincular paquete . . . . . 356sqlbctcq - Cerrar una consulta de contenedor deespacio de tablas . . . . . . . . . . . . 359sqlbctsq - Cerrar una consulta de espacio de tablas 360sqlbftcq - Captar los datos de la consulta para filasde un contenedor de espacio de tablas . . . . . 361sqlbftpq - Captar los datos de la consulta para filasde un espacio de tablas . . . . . . . . . . 363sqlbgtss - Obtener estadísticas de utilización delespacio de tablas . . . . . . . . . . . . 365sqlbmtsq - Obtener los datos de la consulta paratodos los espacios de tablas . . . . . . . . 367sqlbotcq - Abrir una consulta de contenedor deespacio de tablas . . . . . . . . . . . . 369sqlbotsq - Abrir una consulta de espacio de tablas 371sqlbstpq - Obtener información sobre un espacio detablas individual . . . . . . . . . . . . 373sqlbstsc - Definir contenedores de espacios detablas . . . . . . . . . . . . . . . . 375sqlbtcq - Obtener los datos de la consulta paratodos los contenedores de espacios de tablas . . . 378sqlcspqy - Listar transacciones dudosas DRDA . . 380sqle_activate_db - Activar base de datos . . . . 381sqle_deactivate_db - Desactivar base de datos . . 384sqleaddn - Añadir una partición de base de datosal entorno de base de datos particionado . . . . 387
iv Consulta de las API administrativas
sqleatcp - Conectar a instancia y cambiarcontraseña . . . . . . . . . . . . . . 390sqleatin - Conectar a instancia . . . . . . . . 393sqlecadb - Catalogar una base de datos deldirectorio de bases de datos del sistema . . . . 396sqlecran - Crear una base de datos en un servidorde particiones de base de datos . . . . . . . 402sqlecrea - Crear una base de datos . . . . . . 404sqlectnd - Catalogar una entrada en el directorio denodos . . . . . . . . . . . . . . . . 412sqledcgd - Cambiar un comentario de base dedatos en el directorio de bases de datos locales odel sistema . . . . . . . . . . . . . . 415sqledpan - Descartar una base de datos de unservidor de particiones de base de datos . . . . 418sqledrpd - Descartar base de datos . . . . . . 420sqledrpn - Comprobar si se puede descartar unservidor de particiones de base de datos . . . . 422sqledtin - Desconectar de instancia . . . . . . 424sqlefmem - Liberar la memoria asignada por lasAPI sqlbtcq y sqlbmtsq . . . . . . . . . . 425sqlefrce - Desconectar usuarios y aplicaciones delsistema . . . . . . . . . . . . . . . 426sqlegdad - Catalogar una base de datos en eldirectorio de DCS (Database Connection Services) . 429sqlegdcl - Finalizar una exploración del directoriode DCS (Database Connection Services) . . . . 431sqlegdel - Descatalogar una base de datos deldirectorio de DCS (Database Connection Services) . 432sqlegdge - Obtener una entrada específica deldirectorio de DCS (Database Connection Services) . 434sqlegdgt - Obtener entradas del directorio de DCS(servicios de conexión de base de datos) . . . . 436sqlegdcl - Iniciar una exploración del directorio deDCS (Database Connection Services). . . . . . 438sqlegins - Obtener instancia actual . . . . . . 439sqleintr - Interrumpir peticiones de aplicaciones 440sqleisig - Instalar manejador de señales. . . . . 442sqlemgdb - Actualizar la versión anterior de labase de datos DB2 a la versión actual . . . . . 443sqlencl - Finalizar una exploración del directorio denodos . . . . . . . . . . . . . . . . 445sqlengne - Obtener la entrada siguiente deldirectorio de nodos . . . . . . . . . . . 446sqlenops - Iniciar una exploración del directorio denodos . . . . . . . . . . . . . . . . 448sqleqryc - Consultar valores de conexión del cliente 450sqleqryi - Consultar información sobre el cliente 452sqlesact - Establecer serie de contabilidad . . . . 454sqlesdeg - Establecer el nivel o grado máximo deparalelismo intrapartición para la ejecución desentencias de SQL . . . . . . . . . . . . 455sqlesetc - Establecer valores de conexión del cliente 457sqleseti - Establecer información sobre el cliente 460sqleuncd - Descatalogar una base de datos deldirectorio de bases de datos del sistema . . . . 463sqleuncn - Descatalogar una entrada del directoriode nodos . . . . . . . . . . . . . . . 465sqlgaddr - Obtener la dirección de una variable 467sqlgdref - Eliminar la referencia de una dirección 468
sqlgmcpy - Copiar datos de un área de memoria aotra . . . . . . . . . . . . . . . . 469sqlogstt - Obtener el mensaje de SQLSTATE . . . 470sqludrdt: redistribuir datos a través de un grupode particiones de base de datos . . . . . . . 472sqlugrpn - Obtener el número de servidor departiciones de base de datos para una fila . . . . 476qlugtpi - Obtener información de distribución detablas . . . . . . . . . . . . . . . . 479sqluvqdp - Inmovilizar espacios de tablas para unatabla . . . . . . . . . . . . . . . . 481
Capítulo 6. Llamada a las API de DB2en REXX . . . . . . . . . . . . . 485Cambiar el nivel de aislamiento . . . . . . . 487
Capítulo 7. Las API de gestión detransacciones dudosas . . . . . . . 489db2XaGetInfo - Obtener información para ungestor de recursos . . . . . . . . . . . . 491db2XaListIndTrans - Listar transacciones dudosas 492sqlxhfrg - Olvidar estado de transacción . . . . 497sqlxphcm - Confirmar una transacción dudosa . . 498sqlxphrl - Retrotraer una transacción dudosa . . . 499
Capítulo 8. Aplicaciones por hebrascon acceso simultáneo . . . . . . . 501sqleAttachToCtx - Conectar a contexto . . . . . 502sqleBeginCtx - Crear y conectar a un contexto deaplicación . . . . . . . . . . . . . . 503sqleDetachFromCtx - Desconectar de contexto . . 504sqleEndCtx - Desconectar y liberar la memoriaasociada a un contexto de aplicación . . . . . 505sqleGetCurrentCtx - Obtener contexto actual . . . 507sqleInterruptCtx - Interrumpir contexto. . . . . 508sqleSetTypeCtx - Definir el tipo de contexto deaplicación . . . . . . . . . . . . . . 509
Capítulo 9. Plugins del sistema debase de datos de DB2 parapersonalizar la gestión de bases dedatos . . . . . . . . . . . . . . . 511Habilitación de los plugins . . . . . . . . . 511
Despliegue de un plugin de recuperación degrupos. . . . . . . . . . . . . . . 511Despliegue de un plugin de ID deusuario/contraseña . . . . . . . . . . 512Despliegue de un plugin de GSS-API . . . . 513Despliegue de un plugin de Kerberos . . . . 515
Escritura de plugins de seguridad . . . . . . 516Cómo carga DB2 los plugins de seguridad . . 516Restricciones en el desarrollo de bibliotecas deplugins de seguridad . . . . . . . . . . 518Restricciones para plugins de seguridad . . . 520Códigos de retorno para plugins de seguridad 523Manejo de mensajes de error para los pluginsde seguridad . . . . . . . . . . . . 526Secuencias de llamada para las API de pluginsde seguridad . . . . . . . . . . . . 527
Contenido v
Plugins de seguridad . . . . . . . . . . . 530Ubicaciones de las bibliotecas de plugins deseguridad . . . . . . . . . . . . . 535Convenios de denominación para los plugins deseguridad . . . . . . . . . . . . . 536Soporte de plugin de seguridad para los ID deusuario de dos componentes . . . . . . . 537Mantenimiento de las versiones de las API deplugins de seguridad . . . . . . . . . . 539Consideraciones sobre los sistemas de 32 y 64bits para los plugins de seguridad . . . . . 539Determinación de problemas para plugins deseguridad . . . . . . . . . . . . . 540
Las API del plugin de seguridad . . . . . . . 541API para plugins de recuperación de grupos 544API db2secDoesGroupExist - Comprobar siexiste el grupo . . . . . . . . . . . . 546API db2secFreeErrormsg - Liberar la memoriade mensajes de error . . . . . . . . . . 547API db2secFreeGroupListMemory - Liberarmemoria de lista de grupos . . . . . . . 548API db2secGetGroupsForUser - Obtener la listade grupos del usuario . . . . . . . . . 549API db2secGroupPluginInit - Inicializar pluginde grupo . . . . . . . . . . . . . . 553db2secPluginTerm - Liberar los recursos deplugin de grupo . . . . . . . . . . . 555
Las API de los plugins de autentificación por ID deusuario/contraseña . . . . . . . . . . . 556
API db2secClientAuthPluginInit - Inicializar elplugin de autentificación del cliente . . . . . 562API db2secClientAuthPluginTerm - Liberar losrecursos de plugin de autentificación de cliente . 564db2secDoesAuthIDExist - Comprobar si existe elID de autentificación . . . . . . . . . . 565API db2secFreeInitInfo - Liberar los recursosretenidos por la API db2secGenerateInitialCred . 566API db2secFreeToken - Liberar memoriaretenida por símbolo (token) . . . . . . . 567API db2secGenerateInitialCred - Generarcredenciales iniciales . . . . . . . . . . 568API db2secGetAuthIDs - Obtener los ID deautentificación . . . . . . . . . . . . 570API db2secGetDefaultLoginContext - Obtenercontexto de conexión por omisión . . . . . 572API db2secProcessServerPrincipalName -Procesar nombre de principal de serviciodevuelto desde servidor . . . . . . . . . 574API db2secRemapUserid - Volver acorrelacionar el ID de usuario y la contraseña . 575db2secServerAuthPluginInit - Inicializar elplugin de autentificación del servidor . . . . 577API db2secServerAuthPluginTerm - Liberar losrecursos de plugin de autentificación deservidor . . . . . . . . . . . . . . 580API db2secValidatePassword - Validarcontraseña . . . . . . . . . . . . . 581
Las API y definiciones necesarias para los pluginsde autentificación de GSS-API . . . . . . . . 584
Restricciones para los plugins de autentificaciónde GSS-API . . . . . . . . . . . . . 586
Ejemplos de plugins de seguridad . . . . . . 587Las API de DB2 para hacer copias de seguridad yrestauraciones en gestores de almacenamiento . . 588
db2VendorGetNextObj - Obtener el objetosiguiente en el dispositivo . . . . . . . . 589db2VendorQueryApiVersion - Obtener el nivelsoportado de la API de almacenamiento deproveedor . . . . . . . . . . . . . 592sqluvdel - Suprimir sesión confirmada . . . . 593sqluvend - Desenlazar un dispositivo deproveedor y liberar sus recursos . . . . . . 594sqluvget - Leer datos de un dispositivo deproveedor . . . . . . . . . . . . . 596sqluvint - Inicializar y enlazar con undispositivo de proveedor . . . . . . . . 598sqluvpt - Grabar datos en un dispositivo deproveedor . . . . . . . . . . . . . 602DB2_info . . . . . . . . . . . . . . 604Vendor_info . . . . . . . . . . . . . 608Init_input . . . . . . . . . . . . . 610Init_output . . . . . . . . . . . . . 612Data . . . . . . . . . . . . . . . 613Return_code . . . . . . . . . . . . . 614
Las API de DB2 para utilizar la compresión conoperaciones de copia de seguridad y restauración . 615
COMPR_CB . . . . . . . . . . . . . 618COMPR_DB2INFO . . . . . . . . . . 619COMPR_PIINFO . . . . . . . . . . . 621Compress - Comprimir un bloque de datos . . 623Decompress - Descomprimir un bloque de datos 625GetMaxCompressedSize - Calcular el tamañomáximo posible del almacenamiento intermedio. 627GetSavedBlock - Obtener el proveedor delbloque de datos para la imagen de copia deseguridad . . . . . . . . . . . . . 628InitCompression - Inicializar la biblioteca decompresión . . . . . . . . . . . . . 629InitDecompression - Inicializar la biblioteca dedescompresión . . . . . . . . . . . . 630TermCompression - Detener la biblioteca decompresión . . . . . . . . . . . . . 631TermDecompression - Detener la biblioteca dedescompresión . . . . . . . . . . . . 632
Capítulo 10. Estructuras de datos quelas API utilizan . . . . . . . . . . . 633db2DistMapStruct . . . . . . . . . . . . 634db2HistoryData . . . . . . . . . . . . 635Estructura de datos db2LSN . . . . . . . . 641sql_dir_entry . . . . . . . . . . . . . 642SQLB_TBS_STATS . . . . . . . . . . . . 644SQLB_TBSCONTQRY_DATA . . . . . . . . 646SQLB_TBSPQRY_DATA . . . . . . . . . . 648SQLCA . . . . . . . . . . . . . . . 653sqlchar . . . . . . . . . . . . . . . 654SQLDA . . . . . . . . . . . . . . . 655sqldcol . . . . . . . . . . . . . . . 657sqle_addn_options. . . . . . . . . . . . 660sqle_client_info . . . . . . . . . . . . . 662sqle_conn_setting . . . . . . . . . . . . 665sqle_node_local. . . . . . . . . . . . . 668
vi Consulta de las API administrativas
sqle_node_npipe . . . . . . . . . . . . 669sqle_node_struct . . . . . . . . . . . . 670sqle_node_tcpip . . . . . . . . . . . . 671sqledbdesc . . . . . . . . . . . . . . 672sqledbdescext . . . . . . . . . . . . . 681sqledbterritoryinfo. . . . . . . . . . . . 688sqleninfo . . . . . . . . . . . . . . . 689sqlfupd . . . . . . . . . . . . . . . 692sqllob . . . . . . . . . . . . . . . . 701sqlma . . . . . . . . . . . . . . . . 702sqlopt . . . . . . . . . . . . . . . . 706SQLU_LSN . . . . . . . . . . . . . . 708sqlu_media_list . . . . . . . . . . . . . 709SQLU_RLOG_INFO . . . . . . . . . . . 714sqlupi . . . . . . . . . . . . . . . . 715SQLXA_XID. . . . . . . . . . . . . . 717
Apéndice A. Las API depersonalización de precompilador . . 719Las API de personalización de precompilador . . 720
Apéndice B. Registros de anotacionesde DB2 . . . . . . . . . . . . . . 721Registros de anotaciones cronológicas de DB2 . . 722
Cabecera de registro de anotacionescronológicas . . . . . . . . . . . . . 725Registros de anotaciones del gestor detransacciones . . . . . . . . . . . . 728
Registros de anotaciones cronológicas del gestorde campos largos . . . . . . . . . . . 738Registros de anotaciones cronológicas del gestorde programas de utilidad . . . . . . . . 740Registros de anotaciones del gestor de datos . . 744Registros de anotaciones del gestor de relaciones 766
Apéndice C. Visión general de lainformación técnica de DB2 . . . . . 773Biblioteca técnica de DB2 en copia impresa o enformato PDF . . . . . . . . . . . . . 774Visualización de la ayuda para estados de SQLdesde el procesador de línea de mandatos. . . . 776Acceso a diferentes versiones del Centro deinformación de DB2 . . . . . . . . . . . 776Actualización del Centro de información de DB2instalado en el sistema o en el servidor de intranet . 777Actualización manual del Centro de informaciónde DB2 instalado en el sistema o en el servidor deintranet . . . . . . . . . . . . . . . 778Guías de aprendizaje de DB2 . . . . . . . . 780Información de resolución de problemas de DB2 780Términos y condiciones . . . . . . . . . . 781
Apéndice D. Avisos . . . . . . . . . 783
Índice. . . . . . . . . . . . . . . 787
Contenido vii
viii Consulta de las API administrativas
Acerca de este manual
Este manual proporciona información sobre cómo utilizar las interfaces deprogramación de aplicaciones (API) para ejecutar funciones administrativas de lasbases de datos. Presenta información detallada sobre el uso de llamadas a la APIdel gestor de bases de datos en aplicaciones escritas en los lenguajes deprogramación siguientes:v Cv C++v COBOLv FORTRANv REXX
Para un lenguaje compilado, es necesario que esté disponible un precompiladorpara procesar las sentencias. Se proporcionan precompiladores para todos loslenguajes soportados.
Quién debe utilizar este manualSe supone que el lector tiene conocimientos sobre la programación de aplicacionesy la administración de bases de datos, así como conocimientos sobre:v Lenguaje de consulta estructurada (SQL)v Los lenguajes de programación C, C++, COBOL, FORTRAN, y/o REXXv El diseño de programas de aplicación
Cómo esta estructurado este manualEste manual proporciona la información de consulta necesaria para utilizar las APIadministrativas en el desarrollo de aplicaciones.
Las principales áreas temáticas tratadas en los capítulos de este manual son lassiguientes:
Visión genera de las API administrativas y estructuras de datos
v El capítulo 1, “DB2 API,” incluye tablas que muestran las APIadministrativas, los archivos de inclusión y los programas de ejemplo.
v El capítulo 2, “API y estructuras de datos modificadas” utiliza tablaspara mostrar las API soportadas y no soportadas y las estructuras dedatos que se han cambiado.
v El capítulo 3, “Cómo están organizadas las descripciones de las API,”describe cómo están organizadas las descripciones de las API y muestralos archivos de inclusión para las aplicaciones de API DB2.
API
v El capítulo 4, “API administrativas” muestra, en orden alfabético, lasAPI administrativas de DB2.
v El capítulo 5, “Llamada a las API de DB2 en REXX,” describe cómollamar a las API de DB2 desde una aplicación REXX.
© Copyright IBM Corp. 1993, 2012 ix
v El capítulo 6, “API de gestión de transacciones dudosas” presenta unconjunto de API proporcionadas para que los escritores de herramientaslleven a cabo funciones heurísticas en transacciones dudosas.
v El capítulo 7, “Aplicaciones con hebras con acceso simultáneo,” describelas API de DB2 que pueden utilizarse en aplicaciones de hebras.
API de plugins
v El capítulo 8, “Plugins del sistema de base de datos de DB2 parapersonalizar la gestión de las bases de datos” presenta las API deplugins de seguridad, copia de seguridad, restauración, archivado deanotaciones cronológicas y compresión/descompresión para lasimágenes de copia de seguridad.
Estructuras de datos
v El capítulo 9, “Estructuras de datos utilizadas por las API,” describe lasestructuras de datos utilizadas por las API.
Apéndices
v El Apéndice A, “API de personalización del precompilador,” proporcionaun enlace con lugares donde obtener información sobre un conjunto deAPI documentadas que permiten que otras herramientas de desarrollode aplicaciones implementen el soporte del precompilador para DB2directamente en sus productos.
v El Apéndice B, “Registros de anotaciones cronológicas de DB2,” describela estructura de los distintos registros de anotaciones cronológicas deDB2.
Convenios de resaltadoEn este manual se utilizan los siguientes convenios de resaltado.
Negrita Indica mandatos, palabras clave y otros elementos cuyos nombres estánpredefinidos por el sistema.
Cursiva Indica uno de los siguientes valores:
v Nombres o valores (variables) que el usuario debe proporcionarv Énfasis generalv La introducción de un término nuevov Una referencia a otra fuente de información
Monoespaciado Indica uno de los siguientes valores:
v Archivos y directoriosv Información que el usuario debe escribir en una solicitud de mandatos o
en una ventana
v Ejemplos de valores de datos concretosv Ejemplo de texto similares a la forma en que es posible que el sistema los
visualice
v Ejemplos de mensajes de textov Ejemplos de código de programación
Cómo esta estructurado este manual
x Consulta de las API administrativas
Capítulo 1. Las API de DB2
Enumera las API de DB2 que aparecen en los ejemplos de DB2.
Importante: Las API administrativas de DB2 no se admiten en aplicacionesmultihebra, a menos que gestione explícitamente la serialización de hebras con eluso de las API de contexto de DB2. En lugar de las API administrativas de DB2junto con las API de contexto de DB2, utilice el procedimientoSYSPROC.ADMIN_CMD almacenado y utilice el gestor de base de datos de DB2para gestionar automáticamente los contextos del usuario con el soporte deaplicaciones multihebra. Si desea más información sobre el soporte de aplicacionesmultihebra y el uso de contextos para aplicaciones con hebras con accesosimultáneo, consulte: “Transacciones simultáneas y acceso a base de datos devarias hebras en aplicaciones de SQL incorporado” en Developing Embedded SQLApplications.
La primera tabla incluye las API de DB2 agrupadas por categoría funcional, suscorrespondientes archivos de inclusión y los programas de ejemplo que muestransu utilización (consulte la nota incluida a continuación de la tabla para obtenermás información sobre los archivos de inclusión). La segunda tabla lista losprogramas de ejemplo de C/C++ y muestra las API de DB2 ejemplificadas en cadaprograma de C/C++. La tercera tabla muestra los programas de ejemplo deCOBOL y las API de DB2 ejemplificadas en cada programa COBOL.
Las API de DB2, archivos de inclusión y programas de ejemploTabla 1.
Programas de ejemplo de C/C++ con las API de DB2Tabla 2 en la página 15.
Programas de ejemplo de COBOL con las API de DB2Tabla 3 en la página 18.
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo.
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de controlde bases dedatos
“db2DatabaseQuiesce - Inmovilizar labase de datos” en la página 78
db2ApiDf n/d
API de controlde bases dedatos
“db2DatabaseUnquiesce - Movilizarbase de datos” en la página 83
db2ApiDf n/d
API de controlde bases dedatos
“db2DatabaseRestart - Reiniciar basede datos” en la página 80
db2ApiDf C: dbconn.sqc C++: dbconn.sqC
API de controlde bases dedatos
“sqlecrea - Crear una base de datos”en la página 404
sqlenv C: dbcreate.c dbrecov.sqc dbsample.sqcC++: dbcreate.C dbrecov.sq COBOL:db_udcs.cbl dbconf.cbl ebcdicdb.cbl
API de controlde bases dedatos
“sqlecran - Crear una base de datos enun servidor de particiones de base dedatos” en la página 402
sqlenv n/d
© Copyright IBM Corp. 1993, 2012 1
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de controlde bases dedatos
“sqledrpd - Descartar base de datos”en la página 420
sqlenv C: dbcreate.c C++: dbcreate.C COBOL:dbconf.cbl
API de controlde bases dedatos
“sqledpan - Descartar una base dedatos de un servidor de particiones debase de datos” en la página 418
sqlenv n/d
API de controlde bases dedatos
“db2DatabaseUpgrade - Actualizar laversión anterior de la base de datosDB2 al release actual” en la página 85
db2ApiDf C: dbupgrade.c C++: dbupgrade.CCOBOL: dbupgrade.cbl
API de controlde bases dedatos
“db2XaListIndTrans - Listartransacciones dudosas” en la página492
db2ApiDf n/d
API de controlde bases dedatos
“sqle_activate_db - Activar base dedatos” en la página 381
sqlenv n/d
API de controlde bases dedatos
“sqle_deactivate_db - Desactivar basede datos” en la página 384
sqlenv n/d
API de controlde bases dedatos
“sqlcspqy - Listar transaccionesdudosas DRDA” en la página 380
sqlxa n/d
API de controlde bases dedatos
“db2SetWriteForDB - Suspender oreanudar las grabacións de E/S para labase de datos” en la página 323
db2ApiDf n/d
API de controlde bases dedatos
“sqlefrce - Desconectar usuarios yaplicaciones del sistema” en la página426
sqlenv C: dbconn.sqc dbsample.sqc instart.cC++: dbconn.sqC instart.C COBOL:dbstop.cbl
API de controlde instancias
“db2InstanceStart - Iniciar instancia”en la página 175
db2ApiDf C: instart.c C++: instart.C
API de controlde instancias
“db2InstanceStop - Detener instancia”en la página 181
db2ApiDf C: instart.c C++: instart.C
API de controlde instancias
“db2InstanceQuiesce - Inmovilizarinstancia” en la página 172
db2ApiDf n/d
API de controlde instancias
“db2InstanceUnquiesce - Movilizarinstancia” en la página 186
db2ApiDf n/d
API de controlde instancias
“sqleatin - Conectar a instancia” en lapágina 393
sqlenv C: inattach.c utilapi.c C++:inattach.C utilapi.C COBOL:dbinst.cbl
API de controlde instancias
“sqleatcp - Conectar a instancia ycambiar contraseña” en la página 390
sqlenv C: inattach.c C++: inattach.C COBOL:dbinst.cbl
API de controlde instancias
“sqledtin - Desconectar de instancia”en la página 424
sqlenv C: inattach.c utilapi.c C++:inattach.C utilapi.C COBOL:dbinst.cbl
API de controlde instancias
“sqlegins - Obtener instancia actual”en la página 439
sqlenv C: ininfo.c C++: ininfo.C COBOL:dbinst.cbl
Las API de DB2
2 Consulta de las API administrativas
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de controlde instancias
“db2UtilityControl - Establecer el nivelde prioridad de los programas deutilidad en ejecución” en la página 346
db2ApiDf n/d
API del gestorde bases dedatos y deconfiguración debases de datos
“db2CfgGet - Obtener los parámetrosde configuración del gestor de basesde datos o de la base de datos” en lapágina 65
db2ApiDf C: dbinfo.c dbrecov.sqc ininfo.ctscreate.sqc C++: dbinfo.C dbrecov.sqCininfo.C tscreate.sqC
API del gestorde bases dedatos y deconfiguración debases de datos
“db2CfgSet - Definir los parámetros deconfiguración del gestor de bases dedatos o de la base de datos” en lapágina 68
db2ApiDf C: dbinfo.c dbrecov.sqc ininfo.c C++:dbinfo.C dbrecov.sqC ininfo.C
API del gestorde bases dedatos y deconfiguración debases de datos
“db2AutoConfig - Acceder al Asesorde configuración” en la página 49
db2AuCfg C: dbcfg.sqc C++: dbcfg.sqC
API del gestorde bases dedatos y deconfiguración debases de datos
“db2AutoConfigFreeMemory - Liberarla memoria asignada por la APIdb2AutoConfig” en la página 53
db2AuCfg C: dbcfg.sqc C++: dbcfg.sqC
API desupervisión debases de datos
“db2GetSnapshotSize - Calcular eltamaño del almacenamientointermedio de salida necesario para laAPI db2GetSnapshot” en la página 127
db2ApiDf n/d
API desupervisión debases de datos
“db2AddSnapshotRequest - Añadiruna petición de instantánea” en lapágina 42
db2ApiDf n/d
API desupervisión debases de datos
“db2MonitorSwitches - Obtener oactualizar los valores de losconmutadores del supervisor” en lapágina 236
db2ApiDf C: utilsnap.c C++: utilsnap.C
API desupervisión debases de datos
“db2GetSnapshot - Obtener unainstantánea del estado operacional delgestor de bases de datos” en la página123
db2ApiDf C: utilsnap.c C++: utilsnap.C
API desupervisión debases de datos
“db2ResetMonitor - Restaurar losdatos del supervisor del sistema debase de datos” en la página 277
db2ApiDf n/d
API desupervisión debases de datos
“db2ConvMonStream - Convertir lacorriente de supervisor en el formatoanterior a la versión 6” en la página 73
db2ApiDf n/d
API desupervisión debases de datos
“db2Inspect - Inspeccionar la base dedatos para comprobar la integridad dela arquitectura” en la página 164
db2ApiDf n/d
Las API de DB2
Capítulo 1. API administrativas 3
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API desupervisión desalud de basesde datos
“db2AddContact - Añadir un contactoal que se pueden enviar mensajes denotificación” en la página 38
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2AddContactGroup - Añadir ungrupo de contactos al que se puedenenviar mensajes de notificación” en lapágina 40
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2DropContact - Eliminar uncontacto de la lista de contactos a losque se pueden enviar mensajes denotificación” en la página 94
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2DropContactGroup - Eliminar ungrupo de contactos de la lista decontactos a los que se pueden enviarmensajes de notificación” en la página95
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2GetAlertCfg - Obtener los valoresde configuración de alertas para losindicadores de salud” en la página 103
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2GetAlertCfgFree - Liberar lamemoria asignada por la APIdb2GetAlertCfg” en la página 108
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2GetContactGroup - Obtener lalista de contactos de un solo grupo decontactos al que se puedan enviarmensajes de notificación” en la página109
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2GetContactGroups - Obtener lalista de grupos de contactos a los quese puedan enviar mensajes denotificación” en la página 111
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2GetContacts - Obtener la lista decontactos a los que se pueden enviarmensajes de notificación” en la página113
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2GetHealthNotificationList -Obtener la lista de contactos a los quese puedan enviar notificaciones dealerta de salud” en la página 117
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2ResetAlertCfg - Restablecer laconfiguración de alertas de losindicadores de salud” en la página 275
db2ApiDf n/d
Las API de DB2
4 Consulta de las API administrativas
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API desupervisión desalud de basesde datos
“db2UpdateAlertCfg - Actualizar losvalores de configuración de alertaspara los indicadores de salud” en lapágina 332
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2UpdateContact - Actualizar losatributos de un contacto” en la página340
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2UpdateContactGroup - Actualizarlos atributos de un grupo decontactos” en la página 342
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2UpdateHealthNotificationList -Actualizar la lista de contactos a losque se puedan enviar notificaciones dealerta de salud” en la página 344
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2GetSnapshot - Obtener unainstantánea del estado operacional delgestor de bases de datos” en la página123
db2ApiDf C: utilsnap.c C++: utilsnap.C
API desupervisión desalud de basesde datos
“db2GetSnapshotSize - Calcular eltamaño del almacenamientointermedio de salida necesario para laAPI db2GetSnapshot” en la página 127
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2GetRecommendations - Obtenerrecomendaciones para resolver unindicador de salud en estado dealerta” en la página 119
db2ApiDf n/d
API desupervisión desalud de basesde datos
“db2GetRecommendationsFree -Liberar la memoria asignada por laAPI db2GetRecommendations” en lapágina 122
db2ApiDf n/d
API de trasladode datos
“db2Export - Exportar datos de unabase de datos” en la página 96
sqlutil C: tbmove.sqc C++: tbmove.sqC COBOL:expsamp.sqb impexp.sqb tload.sqb
API de trasladode datos
“db2Import - Importar datos a unatabla, jerarquía, apodo o vista” en lapágina 149
db2ApiDf C: dtformat.sqc tbmove.sqc C++:tbmove.sqC COBOL: expsamp.sqbimpexp.sqb
API de trasladode datos
“db2Load - Cargar datos en una tabla”en la página 205
db2ApiDf C: dtformat.sqc tbload.sqc tbmove.sqcC++: tbmove.sqC
API de trasladode datos
“db2LoadQuery - Obtener el estado deuna operación de carga” en la página228
db2ApiDf C: tbmove.sqc C++: tbmove.sqC COBOL:loadqry.sqb
API derecuperación
“db2Backup - Hacer copia deseguridad de una base de datos o unespacio de tablas” en la página 54
db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC
API derecuperación
“db2Restore - Restaurar una base dedatos o un espacio de tablas” en lapágina 280
db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC
Las API de DB2
Capítulo 1. API administrativas 5
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API derecuperación
“db2Recover - Restaurar y avanzaruna base de datos” en la página 259
db2ApiDf n/d
API derecuperación
“db2Rollforward - Avanzar una basede datos” en la página 296
db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC
API derecuperación
“db2HistoryOpenScan - Iniciar unaexploración de los registros delhistórico de la base de datos” en lapágina 141
db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC
API derecuperación
“db2HistoryGetEntry - Obtener laentrada siguiente de los registros delhistórico de la base de datos” en lapágina 139
db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC
API derecuperación
“db2HistoryCloseScan - Finalizar laexploración de los registros delhistórico de la base de datos” en lapágina 138
db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC
API derecuperación
“db2Prune - Suprimir las entradas delarchivo histórico o archivos deanotaciones cronológicas de la vía deacceso de anotación cronológicaactiva” en la página 239
db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC
API derecuperación
“db2HistoryUpdate - Actualizar unaentrada de los registros del históricode la base de datos” en la página 145
db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC
API derecuperación
“db2ArchiveLog - Archivar el archivode anotaciones cronológicas activo” enla página 46
db2ApiDf n/d
API de HADR(HighAvailabilityDisasterRecovery)
“db2HADRStart - Iniciar operacionesde HADR (high availability disasterrecovery)” en la página 131
db2ApiDf n/d
API de HADR(HighAvailabilityDisasterRecovery)
“db2HADRStop - Detener operacionesde HADR (high availability disasterrecovery)” en la página 133
db2ApiDf n/d
API de HADR(HighAvailabilityDisasterRecovery)
“db2HADRTakeover - Darinstrucciones a una base de datos paraque se convierta en la base de datosprimaria de HADR (high availabilitydisaster recovery)” en la página 135
db2ApiDf n/d
API de gestiónde directorios debases de datos yde DCS
“sqlecadb - Catalogar una base dedatos del directorio de bases de datosdel sistema” en la página 396
sqlenv C: ininfo.c C++: ininfo.C COBOL:dbcat.cbl
Las API de DB2
6 Consulta de las API administrativas
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de gestiónde directorios debases de datos yde DCS
“sqleuncd - Descatalogar una base dedatos del directorio de bases de datosdel sistema” en la página 463
sqlenv C: ininfo.c C++: ininfo.C COBOL:dbcat.cbl
API de gestiónde directorios debases de datos yde DCS
“sqlegdad - Catalogar una base dedatos en el directorio de DCS(Database Connection Services)” en lapágina 429
sqlenv C: ininfo.c C++: ininfo.C COBOL:dcscat.cbl
API de gestiónde directorios debases de datos yde DCS
“sqlegdel - Descatalogar una base dedatos del directorio de DCS (DatabaseConnection Services)” en la página 432
sqlenv C: ininfo.c C++: ininfo.C COBOL:dcscat.cbl
API de gestiónde directorios debases de datos yde DCS
“sqledcgd - Cambiar un comentario debase de datos en el directorio de basesde datos locales o del sistema” en lapágina 415
sqlenv C: ininfo.c C++: ininfo.C COBOL:dbcmt.cbl
API de gestiónde directorios debases de datos yde DCS
“db2DbDirOpenScan - Iniciar unaexploración del directorio de bases dedatos locales o del sistema” en lapágina 92
db2ApiDf C: ininfo.c C++: ininfo.C COBOL:dbcat.cbl dbcmt.cbl
API de gestiónde directorios debases de datos yde DCS
“db2DbDirGetNextEntry - Obtener laentrada siguiente del directorio debases de datos locales o del sistema”en la página 88
db2ApiDf C: ininfo.c C++: ininfo.C COBOL:dbcat.cbl dbcmt.cbl
API de gestiónde directorios debases de datos yde DCS
“db2DbDirCloseScan - Finalizar unaexploración del directorio de bases dedatos locales o del sistema” en lapágina 87
db2ApiDf C: ininfo.c C++: ininfo.C COBOL:dbcat.cbl dbcmt.cbl
API de gestiónde directorios debases de datos yde DCS
“sqlegdcl - Iniciar una exploración deldirectorio de DCS (DatabaseConnection Services)” en la página 438
sqlenv C: ininfo.c C++: ininfo.C COBOL:dcscat.cbl
API de gestiónde directorios debases de datos yde DCS
“sqlegdgt - Obtener entradas deldirectorio de DCS (servicios deconexión de base de datos)” en lapágina 436
sqlenv C: ininfo.c C++: ininfo.C COBOL:dcscat.cbl
API de gestiónde directorios debases de datos yde DCS
“sqlegdcl - Finalizar una exploracióndel directorio de DCS (DatabaseConnection Services)” en la página 431
sqlenv C: ininfo.c C++: ininfo.C COBOL:dcscat.cbl
API de gestiónde directorios debases de datos yde DCS
“sqlegdge - Obtener una entradaespecífica del directorio de DCS(Database Connection Services)” en lapágina 434
sqlenv C: ininfo.c C++: ininfo.C COBOL:dcscat.cbl
API de gestiónde directorios debases de datos yde DCS
“db2UpdateAlternateServerForDB -Actualizar el servidor alternativo paraun alias de base de datos en eldirectorio de bases de datos delsistema” en la página 338
db2ApiDf n/d
Las API de DB2
Capítulo 1. API administrativas 7
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de gestióndecliente/servidor
“sqleqryc - Consultar valores deconexión del cliente” en la página 450
sqlenv C: cli_info.c C++: cli_info.C COBOL:client.cbl
API de gestióndecliente/servidor
“sqleqryi - Consultar informaciónsobre el cliente” en la página 452
sqlenv C: cli_info.c C++: cli_info.C
API de gestióndecliente/servidor
“sqlesetc - Establecer valores deconexión del cliente” en la página 457
sqlenv C: cli_info.c dbcfg.sqc dbmcon.sqcC++: cli_info.C dbcfg.sqC dbmcon.sqCCOBOL: client.cbl
API de gestióndecliente/servidor
“sqleseti - Establecer información sobreel cliente” en la página 460
sqlenv C: cli_info.c C++: cli_info.C
API de gestióndecliente/servidor
“sqlesact - Establecer serie decontabilidad” en la página 454
sqlenv COBOL: setact.cbl
API de gestióndecliente/servidor
“db2DatabasePing - Sondear la base dedatos para probar el tiempo derespuesta de la red” en la página 76
db2ApiDf n/d
API de gestióndecliente/servidor
“sqleisig - Instalar manejador deseñales” en la página 442
sqlenv COBOL: dbcmt.cbl
API de gestióndecliente/servidor
“sqleintr - Interrumpir peticiones deaplicaciones” en la página 440
sqlenv n/d
API de gestiónde directorios deLDAP(LightweightDirectory AccessProtocol)
“db2LdapRegister - Registrar elservidor DB2 en el servidor LDAP” enla página 194
db2ApiDf n/d
API de gestiónde directorios deLDAP(LightweightDirectory AccessProtocol)
“db2LdapUpdate - Actualizar losatributos del servidor DB2 en elservidor LDAP” en la página 200
db2ApiDf n/d
API de gestiónde directorios deLDAP(LightweightDirectory AccessProtocol)
“db2LdapDeregister - Desregistrar elservidor DB2 y las bases de datoscatalogadas del servidor LDAP” en lapágina 193
db2ApiDf n/d
API de gestiónde directorios deLDAP(LightweightDirectory AccessProtocol)
“db2LdapCatalogNode - Proporcionarun alias para el nombre de nodo en elservidor LDAP” en la página 191
db2ApiDf n/d
Las API de DB2
8 Consulta de las API administrativas
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de gestiónde directorios deLDAP(LightweightDirectory AccessProtocol)
“db2LdapUncatalogNode - Suprimiralias para nombre de nodo delservidor LDAP” en la página 199
db2ApiDf n/d
API de gestiónde directorios deLDAP(LightweightDirectory AccessProtocol)
“db2LdapCatalogDatabase - Registrarla base de datos en el servidor LDAP”en la página 188
db2ApiDf n/d
API de gestiónde directorios deLDAP(LightweightDirectory AccessProtocol)
“db2LdapUncatalogDatabase -Desregistrar base de datos del servidorLDAP” en la página 198
db2ApiDf n/d
API de gestiónde directorios deLDAP(LightweightDirectory AccessProtocol)
“db2LdapUpdateAlternateServerForDB- Actualizar el servidor alternativo dela base de datos en el servidor LDAP”en la página 203
db2ApiDf n/d
API deprogramación ypreparación deaplicaciones
“sqlaintp - Obtener mensaje de error”en la página 351
sql C: dbcfg.sqcutilapi.c C++: dbcfg.sqCutilapi.C COBOL: checkerr.cbl
API deprogramación ypreparación deaplicaciones
“sqlogstt - Obtener el mensaje deSQLSTATE” en la página 470
sql C: utilapi.c C++: utilapi.C COBOL:checkerr.cbl
API deprogramación ypreparación deaplicaciones
“sqleisig - Instalar manejador deseñales” en la página 442
sqlenv COBOL: dbcmt.cbl
API deprogramación ypreparación deaplicaciones
“sqleintr - Interrumpir peticiones deaplicaciones” en la página 440
sqlenv n/d
API deprogramación ypreparación deaplicaciones
“sqlaprep - Precompilar programa deaplicación” en la página 353
sql C: dbpkg.sqc C++: dbpkg.sqC
API deprogramación ypreparación deaplicaciones
“sqlabndx - Programa de aplicación devinculación para crear un paquete” enla página 348
sql C: dbpkg.sqc dbsample.sqc C++:dbpkg.sqC
Las API de DB2
Capítulo 1. API administrativas 9
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API deprogramación ypreparación deaplicaciones
“sqlarbnd - Volver a vincular paquete”en la página 356
sql C: dbpkg.sqc C++: dbpkg.sqC COBOL:rebind.sqb
Las APIespecíficas deaplicacionesCOBOL,FORTRAN yREXX
“sqlgaddr - Obtener la dirección deuna variable” en la página 467
sqlutil n/d
Las APIespecíficas deaplicacionesCOBOL,FORTRAN yREXX
“sqlgdref - Eliminar la referencia deuna dirección” en la página 468
sqlutil n/d
Las APIespecíficas deaplicacionesCOBOL,FORTRAN yREXX
“sqlgmcpy - Copiar datos de un áreade memoria a otra” en la página 469
sqlutil n/d
API de gestiónde espacios detablas y gestiónde tablas
“sqlbtcq - Obtener los datos de laconsulta para todos los contenedoresde espacios de tablas” en la página378Este mandato o API ha quedado endesuso y puede que se elimine en unfuturo release. Consulte tsinfo.db2tsinfo.db2 para obtener un programade ejemplo que utiliza una funciónsustituta.
sqlutil n/d
API de gestiónde espacios detablas y gestiónde tablas
“sqlbotcq - Abrir una consulta decontenedor de espacio de tablas” en lapágina 369
sqlutil COBOL: tabscont.sqb tspace.sqb
API de gestiónde espacios detablas y gestiónde tablas
“sqlbftcq - Captar los datos de laconsulta para filas de un contenedorde espacio de tablas” en la página 361
sqlutil COBOL: tabscont.sqb tspace.sqb
API de gestiónde espacios detablas y gestiónde tablas
“sqlbctcq - Cerrar una consulta decontenedor de espacio de tablas” en lapágina 359
sqlutil COBOL: tabscont.sqb tspace.sqb
API de gestiónde espacios detablas y gestiónde tablas
“sqlbstsc - Definir contenedores deespacios de tablas” en la página 375
sqlutil C: dbrecov.sqc C++: dbrecov.sqCCOBOL: tabscont.sqb tspace.sqb
Las API de DB2
10 Consulta de las API administrativas
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de gestiónde espacios detablas y gestiónde tablas
“sqlbmtsq - Obtener los datos de laconsulta para todos los espacios detablas” en la página 367Este mandatoo API ha quedado en desuso y puedeque se elimine en un futuro release.Consulte tsinfo.db2 tsinfo.db2 paraobtener un programa de ejemplo queutiliza una función sustituta.
sqlutil n/d
API de gestiónde espacios detablas y gestiónde tablas
“sqlbstpq - Obtener información sobreun espacio de tablas individual” en lapágina 373
sqlutil COBOL: tabspace.sqb tspace.sqb
API de gestiónde espacios detablas y gestiónde tablas
“sqlbotsq - Abrir una consulta deespacio de tablas” en la página 371Estemandato o API ha quedado en desusoy puede que se elimine en un futurorelease.
sqlutil n/d
API de gestiónde espacios detablas y gestiónde tablas
“sqlbftpq - Captar los datos de laconsulta para filas de un espacio detablas” en la página 363
sqlutil COBOL: tabspace.sqb tspace.sqb
API de gestiónde espacios detablas y gestiónde tablas
“sqlbctsq - Cerrar una consulta deespacio de tablas” en la página 360Estemandato o API ha quedado en desusoy puede que se elimine en un futurorelease.
sqlutil n/d
API de gestiónde espacios detablas y gestiónde tablas
Este mandato o API ha quedado endesuso y puede que se elimine en unfuturo release.
sqlutil n/d
API de gestiónde espacios detablas y gestiónde tablas
“sqluvqdp - Inmovilizar espacios detablas para una tabla” en la página 481
sqlutil C: tbmove.sqc C++: tbmove.sqC COBOL:tload.sqb
API de gestiónde espacios detablas y gestiónde tablas
“db2Runstats - Actualizar estadísticaspara tablas e índices” en la página 307
db2ApiDf C: tbreorg.sqc C++: tbreorg.sqCCOBOL: dbstat.sqb
API de gestiónde espacios detablas y gestiónde tablas
“db2Reorg - Reorganizar un índice ouna tabla” en la página 265
db2ApiDf C: tbreorg.sqc C++: tbreorg.sqCCOBOL: dbstat.sqb
API de gestiónde espacios detablas y gestiónde tablas
“sqlefmem - Liberar la memoriaasignada por las API sqlbtcq ysqlbmtsq” en la página 425
sqlenv C: dbrecov.sqc C++: dbrecov.sqCCOBOL: tabscont.sqb tabspace.sqbtspace.sqb
API de gestiónde directorios denodos
“sqlectnd - Catalogar una entrada enel directorio de nodos” en la página412
sqlenv C: ininfo.c C++: ininfo.C COBOL:nodecat.cbl
Las API de DB2
Capítulo 1. API administrativas 11
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de gestiónde directorios denodos
“sqleuncn - Descatalogar una entradadel directorio de nodos” en la página465
sqlenv C: ininfo.c C++: ininfo.C COBOL:nodecat.cbl
API de gestiónde directorios denodos
“sqlenops - Iniciar una exploración deldirectorio de nodos” en la página 448
sqlenv C: ininfo.c C++: ininfo.C COBOL:nodecat.cbl
API de gestiónde directorios denodos
“sqlengne - Obtener la entradasiguiente del directorio de nodos” enla página 446
sqlenv C: ininfo.c C++: ininfo.C COBOL:nodecat.cbl
API de gestiónde directorios denodos
“sqlencl - Finalizar una exploración deldirectorio de nodos” en la página 445
sqlenv C: ininfo.c C++: ininfo.C COBOL:nodecat.cbl
API de gestiónde directorios denodos
“db2UpdateAlternateServerForDB -Actualizar el servidor alternativo paraun alias de base de datos en eldirectorio de bases de datos delsistema” en la página 338
db2ApiDf n/d
API desincronizaciónde satélites
“db2GetSyncSession - Obtener unidentificador de sesión desincronización de satélites” en lapágina 130
db2ApiDf n/d
API desincronizaciónde satélites
“db2QuerySatelliteProgress - Obtenerel estado de una sesión desincronización de satélites” en lapágina 242
db2ApiDf n/d
API desincronizaciónde satélites
“db2SetSyncSession - Establecer sesiónde sincronización de satélites” en lapágina 322
db2ApiDf n/d
API desincronizaciónde satélites
“db2SyncSatellite - Iniciarsincronización de satélites” en lapágina 329
db2ApiDf n/d
API desincronizaciónde satélites
“db2SyncSatelliteStop - Pausarsincronización de satélites” en lapágina 330
db2ApiDf n/d
API desincronizaciónde satélites
“db2SyncSatelliteTest - Probar si sepuede sincronizar un satélite” en lapágina 331
db2ApiDf n/d
API de archivosde anotacionesde lectura
“db2ReadLog - Leer registros deanotaciones cronológicas” en la página244
db2ApiDf C: dbrecov.sqc C++: dbrecov.sqC
API de archivosde anotacionesde lectura
“db2ReadLogNoConn - Leer lasanotaciones cronológicas de la base dedatos sin una conexión de base dedatos” en la página 251
db2ApiDf n/d
API de archivosde anotacionesde lectura
“db2ReadLogNoConnInit - Inicializarla lectura de las anotacionescronológicas de la base de datos sinuna conexión de base de datos” en lapágina 255
db2ApiDf n/d
Las API de DB2
12 Consulta de las API administrativas
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de archivosde anotacionesde lectura
“db2ReadLogNoConnTerm - Terminarla lectura de las anotacionescronológicas de la base de datos sinuna conexión de base de datos” en lapágina 258
db2ApiDf n/d
API de gestiónde transaccionesdudosas
“db2XaListIndTrans - Listartransacciones dudosas” en la página492
db2ApiDf n/d
API de gestiónde transaccionesdudosas
“sqlxhfrg - Olvidar estado detransacción” en la página 497
sqlxa n/d
API de gestiónde transaccionesdudosas
“sqlxphcm - Confirmar unatransacción dudosa” en la página 498
sqlxa n/d
API de gestiónde transaccionesdudosas
“sqlxphrl - Retrotraer una transaccióndudosa” en la página 499
sqlxa n/d
API de gestiónde transaccionesdudosas
“sqlcspqy - Listar transaccionesdudosas DRDA” en la página 380
sqlxa n/d
Las API paraobtener accesosimultáneo a unabase de datos
“sqleAttachToCtx - Conectar acontexto” en la página 502
sql C: dbthrds.sqc C++: dbthrds.sqC
Las API paraobtener accesosimultáneo a unabase de datos
“sqleBeginCtx - Crear y conectar a uncontexto de aplicación” en la página503
sql C: dbthrds.sqc C++: dbthrds.sqC
Las API paraobtener accesosimultáneo a unabase de datos
“sqleDetachFromCtx - Desconectar decontexto” en la página 504
sql C: dbthrds.sqc C++: dbthrds.sqC
Las API paraobtener accesosimultáneo a unabase de datos
“sqleEndCtx - Desconectar y liberar lamemoria asociada a un contexto deaplicación” en la página 505
sql n/d
Las API paraobtener accesosimultáneo a unabase de datos
“sqleGetCurrentCtx - Obtener contextoactual” en la página 507
sql n/d
Las API paraobtener accesosimultáneo a unabase de datos
“sqleInterruptCtx - Interrumpircontexto” en la página 508
sql n/d
Las API paraobtener accesosimultáneo a unabase de datos
“sqleSetTypeCtx - Definir el tipo decontexto de aplicación” en la página509
sql C: dbthrds.sqc C++: dbthrds.sqC
Las API de DB2
Capítulo 1. API administrativas 13
Tabla 1. Las API de DB2, archivos de inclusión y programas de ejemplo (continuación).
La fila inferior de esta tabla es una celda distribuida que contiene notas a pie de página de la tabla.
Tipo de API API de DB2Archivo deinclusión Programas de ejemplo
API de gestiónde particiones debase de datos
“sqleaddn - Añadir una partición debase de datos al entorno de base dedatos particionado” en la página 387
sqlenv n/d
API de gestiónde particiones debase de datos
“sqledrpn - Comprobar si se puededescartar un servidor de particiones debase de datos” en la página 422
sqlenv n/d
API de gestiónde particiones debase de datos
“sqlecran - Crear una base de datos enun servidor de particiones de base dedatos” en la página 402
sqlenv n/d
API de gestiónde particiones debase de datos
“sqledpan - Descartar una base dedatos de un servidor de particiones debase de datos” en la página 418
sqlenv n/d
API de gestiónde particiones debase de datos
“sqlesdeg - Establecer el nivel o gradomáximo de paralelismo intraparticiónpara la ejecución de sentencias deSQL” en la página 455
sqlenv C: ininfo.c C++: ininfo.C
API de gestiónde particiones debase de datos
“qlugtpi - Obtener información dedistribución de tablas” en la página479
sqlutil n/d
API de gestiónde particiones debase de datos
“sqlugrpn - Obtener el número deservidor de particiones de base dedatos para una fila” en la página 476
sqlutil n/d
API diversas “db2AdminMsgWrite - Grabarmensajes de anotación cronológicapara la función de administración yduplicación” en la página 44
db2ApiDf n/d
API diversas “db2XaGetInfo - Obtener informaciónpara un gestor de recursos” en lapágina 491
sqlxa n/d
Nota: Las extensiones de los archivos de inclusión varían según el lenguaje de programación. Los archivos deinclusión de C/C++ tienen la extensión de archivo .h. Los archivos de inclusión de COBOL tienen la extensión dearchivo .cbl. Los archivos de inclusión se pueden encontrar en los directorios siguientes:
C/C++ (UNIX):sqllib/include
C/C++ (Windows):sqllib\include
COBOL (UNIX):sqllib/include/cobol_a
sqllib/include/cobol_i
sqllib/include/cobol_mf
COBOL (Windows):sqllib\include\cobol_a
sqllib\include\cobol_i
sqllib\include\cobol_mf
Las API de DB2
14 Consulta de las API administrativas
Tabla 2. Programas de ejemplo de C/C++ con las API de DB2
Programa deejemplo Las API incluidas
cli_info.c,cli_info.C
v API sqlesetc - Establecer valores de conexión del clientev API sqleseti - Establecer información sobre el clientev API sqleqryc - Consultar valores de conexión del clientev API sqleqryi - Consultar información sobre el cliente
dbcfg.sqc,dbcfg.sqC
v API db2AutoConfig - Acceder al Asesor de configuraciónv API db2AutoConfigFreeMemory - Liberar la memoria asignada por
la API db2AutoConfig
v API sqlesetc - Establecer valores de conexión del clientev API sqlaintp - Obtener mensaje de error
dbconn.sqc,dbconn.sqC
v API db2DatabaseRestart - Reiniciar base de datosv API sqlefrce - Desconectar usuarios y aplicaciones del sistema
dbcreate.c,dbcreate.C
v API sqlecrea - Crear base de datosv API sqledrpd - Descartar base de datos
dbinfo.c, dbinfo.C v API db2CfgGet - Obtener los parámetros de configuración delgestor de bases de datos o de la base de datos
v API db2CfgSet - Definir los parámetros de configuración del gestorde bases de datos o de la base de datos
dbmcon.sqc,dbmcon.sqC
v API sqlesetc - Establecer valores de conexión del cliente
dbmigrat.c,dbmigrat.C
v API sqlemgdb - Migrar la versión anterior de la base de datos DB2a la versión actual
dbpkg.sqc,dbpkg.sqC
v API sqlaprep - Precompilar programa de aplicaciónv API sqlabndx - Vincular programa de aplicación para crear un
paquete
v API sqlarbnd - Volver a vincular paquete
Las API de DB2
Capítulo 1. API administrativas 15
Tabla 2. Programas de ejemplo de C/C++ con las API de DB2 (continuación)
Programa deejemplo Las API incluidas
dbrecov.sqc,dbrecov.sqC
v API db2HistoryCloseScan - Finalizar la exploración del archivohistórico
v API db2HistoryGetEntry - Obtener la entrada siguiente del archivohistórico
v API db2HistoryOpenScan - Iniciar una exploración del archivohistórico
v API db2HistoryUpdate - Actualizar una entrada de archivohistórico
v API db2Prune - Suprimir las entradas del archivo histórico oarchivos de anotaciones cronológicas de la vía de acceso deanotación cronológica activa
v API db2CfgGet - Obtener los parámetros de configuración delgestor de bases de datos o de la base de datos
v API db2CfgSet - Definir los parámetros de configuración del gestorde bases de datos o de la base de datos
v API sqlbmtsq - Obtener los datos de la consulta para todos losespacios de tablas
v API sqlbstsc - Definir contenedores de espacios de tablasv API sqlbtcq - Obtener los datos de la consulta para todos los
contenedores de espacios de tablas
v API sqlecrea - Crear base de datosv API sqledrpd - Descartar base de datosv API sqlefmem - Liberar la memoria asignada por las API sqlbtcq y
sqlbmtsq
v API db2Backup - Hacer copia de seguridad de una base de datos oun espacio de tablas
v API db2Restore - Restaurar una base de datos o un espacio detablas
v API db2ReadLog - Lectura asíncrona de anotación cronológicav API db2ReadLogNoConn - Leer anotación cronológica sin una
conexión de base de datos
v API db2Rollforward - Avanzar una base de datosdbsample.sqc v API db2DatabaseRestart - Reiniciar base de datos
v API sqlecrea - Crear base de datosv API sqlefrce - Desconectar usuarios y aplicaciones del sistemav API sqlabndx - Vincular programa de aplicación para crear un
paquete
dbthrds.sqc,dbthrds.sqC
v API sqleAttachToCtx - Conectar a contextov API sqleBeginCtx - Crear y conectar a un contexto de aplicaciónv API sqleDetachFromCtx - Desconectar de contextov API sqleSetTypeCtx - Definir tipo de contexto de aplicación
dtformat.sqc v API db2Load - Cargar datos en una tablav API db2Import - Importar datos a una tabla, jerarquía, apodo o
vista
Las API de DB2
16 Consulta de las API administrativas
Tabla 2. Programas de ejemplo de C/C++ con las API de DB2 (continuación)
Programa deejemplo Las API incluidas
inattach.c,inattach.C
v API sqleatcp - Conectar a instancia y cambiar contraseñav API sqleatin - Conectar a instanciav API sqledtin - Desconectar de instancia
ininfo.c, ininfo.C v API db2CfgGet - Obtener los parámetros de configuración delgestor de bases de datos o de la base de datos
v API db2CfgSet - Definir los parámetros de configuración del gestorde bases de datos o de la base de datos
v API sqlegins - Obtener instancia actualv API sqlectnd - Catalogar una entrada en el directorio de nodosv API sqlenops - Iniciar una exploración del directorio de nodosv API sqlengne - Obtener la entrada siguiente del directorio de nodosv API sqlencls - Finalizar una exploración del directorio de nodosv API sqleuncn - Descatalogar una entrada del directorio de nodosv API sqlecadb - Catalogar una base de datos del directorio de bases
de datos del sistema
v API db2DbDirOpenScan - Iniciar una exploración del directorio debases de datos locales o del sistema
v API db2DbDirGetNextEntry - Obtener la entrada siguiente deldirectorio de bases de datos locales o del sistema
v API sqledcgd - Cambiar un comentario de base de datos en eldirectorio de bases de datos locales o del sistema
v API db2DbDirCloseScan - Finalizar una exploración del directoriode bases de datos locales o del sistema
v API sqleuncd - Descatalogar una base de datos del directorio debases de datos del sistema
v API sqlegdad - Catalogar una base de datos en el directorio deDCS (Directorio de servicios de conexión de bases de datos)
v API sqlegdsc - Iniciar una exploración del directorio de DCS(Directorio de servicios de conexión de bases de datos)
v API sqlegdge - Obtener una entrada específica del directorio deDCS (Directorio de servicios de conexión de bases de datos)
v API sqlegdgt - Obtener entradas del directorio de DCS (Directoriode servicios de conexión de bases de datos)
v API sqlegdcl - Finalizar una exploración del directorio de DCS(Directorio de servicios de conexión de bases de datos)
v API sqlegdel - Descatalogar una base de datos del directorio deDCS (Directorio de servicios de conexión de bases de datos)
v API sqlesdeg - Establecer el nivel o grado máximo de paralelismointrapartición para la ejecución de sentencias de SQL
instart.c,instart.C
v API sqlefrce - Desconectar usuarios y aplicaciones del sistemav API db2InstanceStart - Iniciar instanciav API db2InstanceStop - Detener instancia
Las API de DB2
Capítulo 1. API administrativas 17
Tabla 2. Programas de ejemplo de C/C++ con las API de DB2 (continuación)
Programa deejemplo Las API incluidas
tbmove.sqc,tbmove.sqC
v API db2Export - Exportar datos de una base de datosv API db2Import - Importar datos a una tabla, jerarquía, apodo o
vista
v API sqluvqdp - Inmovilizar espacios de tablas para una tablav API db2Load - Cargar datos en una tablav API db2LoadQuery - Obtener el estado de una operación de carga
tbreorg.sqc,tbreorg.sqC
v API db2Reorg - Reorganizar un índice o una tablav API db2Runstats - Actualizar estadísticas sobre las características
de una tabla e índices asociados
tscreate.sqc,tscreate.sqC
v API db2CfgGet - Obtener los parámetros de configuración delgestor de bases de datos o de la base de datos
utilapi.c,utilapi.C
v API sqlaintp - Obtener mensaje de errorv API sqlogstt - Obtener el mensaje de SQLSTATEv API sqleatin - Conectar a instanciav API sqledtin - Desconectar de instancia
utilsnap.c,utilsnap.C
v API db2GetSnapshot - Obtener una instantánea del estadooperativo del gestor de bases de datos
v API db2MonitorSwitches - Obtener o actualizar los valores de losconmutadores del supervisor
Tabla 3. Programas de ejemplo de COBOL con las API de DB2
Programa deejemplo Las API incluidas
checkerr.cbl v API sqlaintp - Obtener mensaje de errorv API sqlogstt - Obtener el mensaje de SQLSTATE
client.cbl v API sqleqryc - Consultar valores de conexión del clientev API sqlesetc - Establecer valores de conexión del cliente
db_udcs.cbl v API sqleatin - Conectar a instanciav API sqlecrea - Crear base de datosv API sqledrpd - Descartar base de datos
dbcat.cbl v API sqlecadb - Catalogar una base de datos del directorio de basesde datos del sistema
v API db2DbDirCloseScan - Finalizar una exploración del directoriode bases de datos locales o del sistema
v API db2DbDirGetNextEntry - Obtener la entrada siguiente deldirectorio de bases de datos locales o del sistema
v API db2DbDirOpenScan - Iniciar una exploración del directorio debases de datos locales o del sistema
v API sqleuncd - Descatalogar una base de datos del directorio debases de datos del sistema
Las API de DB2
18 Consulta de las API administrativas
Tabla 3. Programas de ejemplo de COBOL con las API de DB2 (continuación)
Programa deejemplo Las API incluidas
dbcmt.cbl v API sqledcgd - Cambiar un comentario de base de datos en eldirectorio de bases de datos locales o del sistema
v API db2DbDirCloseScan - Finalizar una exploración del directoriode bases de datos locales o del sistema
v API db2DbDirGetNextEntry - Obtener la entrada siguiente deldirectorio de bases de datos locales o del sistema
v API db2DbDirOpenScan - Iniciar una exploración del directorio debases de datos locales o del sistema
v API sqleisig - Instalar manejador de señalesdbinst.cbl v API sqleatcp - Conectar a instancia y cambiar contraseña
v API sqleatin - Conectar a instanciav API sqledtin - Desconectar de instanciav API sqlegins - Obtener instancia actual
dbstat.sqb v API db2Reorg - Reorganizar un índice o una tablav API db2Runstats - Actualizar estadísticas sobre las características
de una tabla e índices asociados
dcscat.cbl v API sqlegdad - Catalogar una base de datos en el directorio deDCS (Directorio de servicios de conexión de bases de datos)
v API sqlegdcl - Finalizar una exploración del directorio de DCS(Directorio de servicios de conexión de bases de datos)
v API sqlegdel - Descatalogar una base de datos del directorio deDCS (Directorio de servicios de conexión de bases de datos)
v API sqlegdge - Obtener una entrada específica del directorio deDCS (Directorio de servicios de conexión de bases de datos)
v API sqlegdgt - Obtener entradas del directorio de DCS (Directoriode servicios de conexión de bases de datos)
v API sqlegdsc - Iniciar una exploración del directorio de DCS(Directorio de servicios de conexión de bases de datos)
ebcdicdb.cbl v API sqleatin - Conectar a instanciav API sqlecrea - Crear base de datosv API sqledrpd - Descartar base de datos
expsamp.sqb v API db2Export - Exportar datos de una base de datosv API db2Import - Importar datos a una tabla, jerarquía, apodo o
vista
impexp.sqb v API db2Export - Exportar datos de una base de datosv API db2Import - Importar datos a una tabla, jerarquía, apodo o
vista
loadqry.sqb v API db2LoadQuery - Obtener el estado de una operación de cargamigrate.cbl v API sqlemgdb - Migrar la versión anterior de la base de datos DB2
a la versión actual
Las API de DB2
Capítulo 1. API administrativas 19
Tabla 3. Programas de ejemplo de COBOL con las API de DB2 (continuación)
Programa deejemplo Las API incluidas
nodecat.cbl v API sqlectnd - Catalogar una entrada en el directorio de nodosv API sqlencls - Finalizar una exploración del directorio de nodosv API sqlengne - Obtener la entrada siguiente del directorio de nodosv API sqlenops - Iniciar una exploración del directorio de nodosv API sqleuncn - Descatalogar una entrada del directorio de nodos
rebind.sqb v API sqlarbnd - Volver a vincular paquetetabscont.sqb v API sqlbctcq - Cerrar una consulta de contenedor de espacio de
tablas
v API sqlbftcq - Captar los datos de la consulta para filas de uncontenedor de espacio de tablas
v API sqlbotcq - Abrir una consulta de contenedor de espacio detablas
v API sqlbtcq - Obtener los datos de la consulta para todos loscontenedores de espacios de tablas
v API sqlefmem - Liberar la memoria asignada por las API sqlbtcq ysqlbmtsq
tabspace.sqb v API sqlbctsq - Cerrar una consulta de espacio de tablasv API sqlbftpq - Captar los datos de la consulta para filas de un
espacio de tablas
v API sqlbgtss - Obtener estadísticas de utilización del espacio detablas
v API sqlbmtsq - Obtener los datos de la consulta para todos losespacios de tablas
v API sqlbotsq - Abrir una consulta de espacio de tablasv API sqlbstpq - Obtener información sobre un espacio de tablas
individual
v API sqlefmem - Liberar la memoria asignada por las API sqlbtcq ysqlbmtsq
tload.sqb v API db2Export - Exportar datos de una base de datosv API sqluvqdp - Inmovilizar espacios de tablas para una tabla
Las API de DB2
20 Consulta de las API administrativas
Tabla 3. Programas de ejemplo de COBOL con las API de DB2 (continuación)
Programa deejemplo Las API incluidas
tspace.sqb v API sqlbctcq - Cerrar una consulta de contenedor de espacio detablas
v API sqlbctsq - Cerrar una consulta de espacio de tablasv API sqlbftcq - Captar los datos de la consulta para filas de un
contenedor de espacio de tablas
v API sqlbftpq - Captar los datos de la consulta para filas de unespacio de tablas
v API sqlbgtss - Obtener estadísticas de utilización del espacio detablas
v API sqlbmtsq - Obtener los datos de la consulta para todos losespacios de tablas
v API sqlbotcq - Abrir una consulta de contenedor de espacio detablas
v API sqlbotsq - Abrir una consulta de espacio de tablasv API sqlbstpq - Obtener información sobre un espacio de tablas
individual
v API sqlbstsc - Definir contenedores de espacios de tablasv API sqlbtcq - Obtener los datos de la consulta para todos los
contenedores de espacios de tablas
v API sqlefmem - Liberar la memoria asignada por las API sqlbtcq ysqlbmtsq
setact.cbl v API sqlesact - Establecer serie de contabilidad
Las API de DB2
Capítulo 1. API administrativas 21
22 Consulta de las API administrativas
Capítulo 2. Cambios en las API y estructuras de datos
En esta sección se proporciona información acerca de las API y estructuras dedatos que han cambiado.
Tabla 4. Interfaces API y estructuras de datos de nivel anterior que siguen siendo válidas
API o estructura de datos(Versión) Nombre descriptivo
Nueva API, estructura de datos o funciónde tabla (Versión)
sqlbftsq (V2) Recuperar consulta de espacios detablas
sqlbftpq (V5)
sqlbstsq (V2) Consulta de espacio de tablas simple sqlbstpq (V5)
sqlbtsq (V2) Consulta de espacios de tablas sqlbmtsq (V5)
sqlectdd (V2) Catalogar base de datos sqlecadb (V5)
sqledosd (V8.1) Abrir exploración del directorio debases de datos
db2DbDirOpenScan (V8.2)
sqledgne (V8.1) Obtener entrada siguiente deldirectorio de bases de datos
db2DbDirGetNextEntry (V8.2)
sqledcls (V8.1) Cerrar exploración de directorio debases de datos
db2DbDirCloseScan (V8.2)
sqlepstart (V5) Iniciar gestor de bases de datos db2InstanceStart (V8)
sqlepstp (V5) Detener gestor de bases de datos db2InstanceStop (V8)
sqlepstr (V2) Iniciar el gestor de bases de datos(DB2 Parallel Edition Versión 1.2)
db2InstanceStart (V8)
sqlestar (V2) Iniciar gestor de bases de datos (DB2Versión 2)
db2InstanceStart (V8)
sqlestop (V2) Detener gestor de bases de datos db2InstanceStop (V8)
sqlerstd (V5) Reiniciar base de datos db2DatabaseRestart (V6)
sqlfddb (V7) Obtener valores por omisión de laconfiguración de la base de datos
db2CfgGet (V8)
sqlfdsys (V7) Obtener valores por omisión de laconfiguración del gestor de bases dedatos
db2CfgGet (V8)
sqlfrdb (V7) Restaurar configuración de la base dedatos
db2CfgSet (V8)
sqlfrsys (V7) Restaurar configuración del gestor debases de datos
db2CfgSet (V8)
sqlfudb (V7) Actualizar configuración de la basede datos
db2CfgSet (V8)
sqlfusys (V7) Actualizar configuración del gestorde bases de datos
db2CfgSet (V8)
sqlfxdb (V7) Obtener configuración de la base dedatos
db2CfgGet (V8)
sqlfxsys (V7) Obtener configuración de la base dedatos
db2CfgGet (V8)
sqlmon (V6) Obtener/actualizar conmutadores desupervisor
db2MonitorSwitches (V7)
sqlmonss (V5) Obtener instantánea db2GetSnapshot (V6)
© Copyright IBM Corp. 1993, 2012 23
Tabla 4. Interfaces API y estructuras de datos de nivel anterior que siguen siendo válidas (continuación)
API o estructura de datos(Versión) Nombre descriptivo
Nueva API, estructura de datos o funciónde tabla (Versión)
sqlmonsz (V6) Calcular tamaño necesario paraalmacenamiento intermedio de salidade sqlmonss()
db2GetSnapshotSize (V7)
sqlmrset (V6) Restaurar supervisor db2ResetMonitor (V7)
sqlubkp (V5) Hacer copia de seguridad de base dedatos
db2Backup (V8)
sqlubkup (V2) Hacer copia de seguridad de base dedatos
db2Backup (V8)
sqluexpr Exportar db2Export (V8)
sqlugrpi (V2) Obtener información sobre elparticionamiento de filas (DB2Parallel Edition Versión 1.x)
sqlugrpn (V5)
sqluhcls (V5) Cerrar exploración del archivohistórico de recuperación
db2HistoryCloseScan (V6)
sqluhget (V5) Recuperar información sobre DDL delarchivo histórico
db2HistoryGetEntry (V6)
sqluhgne (V5) Obtener entrada siguiente del archivohistórico de recuperación
db2HistoryGetEntry (V6)
sqluhops (V5) Abrir exploración del archivohistórico de recuperación
db2HistoryOpenScan (V6)
sqluhprn (V5) Eliminar archivo histórico derecuperación
db2Prune (V6)
sqluhupd (V5) Actualizar archivo histórico derecuperación
db2HistoryUpdate (V6)
sqluimpr Importar db2Import (V8)
sqluload (V7) Cargar db2Load (V8)
sqluqry (V5) Cargar consulta db2LoadQuery (V6)
sqlureot (V7) Reorganizar tabla db2Reorg (V8)
sqlurestore (V7) Restaurar base de datos db2Restore (V8)
sqlurlog (V7) Archivo de anotaciones de lecturaasíncrona
db2ReadLog (V8)
sqluroll (V7) Avanzar base de datos db2Rollforward (V8)
sqlursto (V2) Restaurar base de datos sqlurst (V5)
sqlustat (V7) Ejecutar estadísticas db2Runstats (V8)
sqlxhcom (V2) Confirmar transacción dudosa sqlxphcm (V5)
sqlxhqry (V2) Listar transacciones dudosas sqlxphqr (V5)
sqlxhrol (V2) Retrotraer transacción dudosa sqlxphrl (V5)
SQLB-TBSQRY-DATA (V2) Estructura de datos del espacio detablas.
SQLB-TBSPQRY-DATA (V5)
SQLE-START-OPTIONS (V7) Iniciar estructura de datos del gestorde bases de datos
db2StartOptionsStruct (V8)
SQLEDBSTOPOPT (V7) Iniciar estructura de datos del gestorde bases de datos
db2StopOptionsStruct (V8)
Cambios en las API y estructuras de datos
24 Consulta de las API administrativas
Tabla 4. Interfaces API y estructuras de datos de nivel anterior que siguen siendo válidas (continuación)
API o estructura de datos(Versión) Nombre descriptivo
Nueva API, estructura de datos o funciónde tabla (Versión)
SQLEDBSTRTOPT (V2) Iniciar estructura de datos del gestorde bases de datos (DB2 ParallelEdition Versión 1.2)
db2StartOptionsStruct (V8)
SQLEDINFO (v8.1) Obtener estructura de datos siguientepara la entrada del directorio debases de datos
db2DbDirInfo (V8.2)
SQLUEXPT-OUT Exportar estructura de salida db2ExportOut (V8.2)
SQLUHINFO y SQLUHADM(V5)
Estructuras de datos del archivohistórico
db2HistData (V6)
SQLUIMPT-IN Importar estructura de entrada db2ImportIn (V8.2)
SQLUIMPT-OUT Importar estructura de salida db2ImportOut (V8.2)
SQLULOAD-IN (V7) Cargar estructura de entrada db2LoadIn (V8)
SQLULOAD-OUT (V7) Cargar estructura de salida db2LoadOut (V8)
db2DbDirInfo (V8.2) Obtener estructura de datos siguientepara la entrada del directorio debases de datos
db2DbDirInfoV9 (V9.1)
db2DbDirNextEntryStruct(V8.2)
Obtener estructura de datos siguientepara la entrada del directorio debases de datos
db2DbDirNextEntryStructV9 (V9.1)
db2gDbDirNextEntryStruct(V8.2)
Obtener estructura de datos siguientepara la entrada del directorio debases de datos
db2gDbDirNextEntryStrV9 (V9.1)
sqlbctsq Cerrar una consulta de espacio detablas
Funciones de tablaMON_GET_TABLESPACE yMON_GET_CONTAINER (V9.7)
sqlbotsq Abrir una consulta de espacio detablas
Funciones de tablaMON_GET_TABLESPACE yMON_GET_CONTAINER (V9.7)
sqlbftpq Captar los datos de la consulta parafilas de un espacio de tablas
Funciones de tablaMON_GET_TABLESPACE yMON_GET_CONTAINER (V9.7)
sqlbgtss Obtener estad