Consulta de Las API Administrativas

DB2

DB2 Versin 9para Linux, UNIX y Windows

Consulta de las API administrativas

SC11-3192-00

DB2

DB2 Versin 9para Linux, UNIX y Windows


SC11-3192-00

Antes de utilizar esta informacin y el producto al que da soporte, asegrese de leer la informacin general incluida en el apartado Avisos.

Informacin sobre la edicin Esta publicacin es la traduccin del original ingls DB2 Version 9 for Linux, UNIX, and Windows Administrative API Reference, (SC10-4231-00). Este documento contiene informacin sobre productos patentados de IBM. Se proporciona segn un acuerdo de licencia y est protegido por la ley de la propiedad intelectual. La presente publicacin no incluye garantas del producto y las declaraciones que contiene no deben interpretarse como tales. Puede realizar pedidos de publicaciones en lnea o a travs del representante de IBM de su localidad. v Para realizar pedidos de publicaciones en lnea, vaya a IBM Publications Center en www.ibm.com/shop/ publications/order v Para encontrar el representante de IBM correspondiente a su localidad, vaya a IBM Directory of Worldwide Contacts en www.ibm.com/planetwide Para realizar pedidos de publicaciones en marketing y ventas de DB2 de los EE.UU. o de Canad, llame al nmero 1-800-IBM-4YOU (426-4968). Cuando enva informacin a IBM, otorga a IBM un derecho no exclusivo para utilizar o distribuir dicha informacin en la forma en que IBM considere adecuada, sin contraer por ello ninguna obligacin con el remitente. Copyright International Business Machines Corporation 1993, 2006. Reservados todos los derechos.

ContenidoAcerca de este manual . . . . . . . . ixQuin debe utilizar este manual . . . . . . . ix db2GetAlertCfg - Obtener los valores de configuracin de alertas para los indicadores de estado . . . . . . . . . . . . . . . . db2GetAlertCfgFree - Liberar la memoria asignada por la API db2GetAlertCfg . . . . . . . . . db2GetContactGroup - Obtener la lista de contactos de un grupo de contactos al que se puedan enviar mensajes de notificacin . . . . . . . . . . db2GetContactGroups - Obtener la lista de grupos de contactos a los que se puedan enviar mensajes de notificacin . . . . . . . . . . . . . db2GetContacts - Obtener la lista de contactos a los que se puedan enviar mensajes de notificacin . . db2GetHealthNotificationList - Obtener la lista de contactos a los que se puedan enviar notificaciones de alerta de estado . . . . . . . . . . . db2GetRecommendations - Obtener recomendaciones para resolver un indicador de estado en estado de alerta . . . . . . . . . db2GetRecommendationsFree - Liberar la memoria asignada por la API db2GetRecommendations . . db2GetSnapshot - Obtener una instantnea del estado operacional del gestor de bases de datos . . db2GetSnapshotSize - Calcular el tamao del almacenamiento intermedio de salida necesario para la API db2GetSnapshot . . . . . . . . db2GetSyncSession - Obtener un identificador de sesin de sincronizacin de satlite . . . . . . db2HADRStart - Iniciar operaciones de HADR (high availability disaster recovery) . . . . . . db2HADRStop - Detener operaciones de HADR (high availability disaster recovery) . . . . . . db2HADRTakeover - Dar instrucciones a una base de datos para que se convierta en la base de datos primaria de HADR (high availability disaster recovery) . . . . . . . . . . . . . . . db2HistoryCloseScan - Finalizar la exploracin del archivo histrico . . . . . . . . . . . . db2HistoryGetEntry - Obtener la entrada siguiente del archivo histrico . . . . . . . . . . . db2HistoryOpenScan - Iniciar una exploracin del archivo histrico . . . . . . . . . . . . db2HistoryUpdate - Actualizar una entrada de archivo histrico . . . . . . . . . . . . db2Import - Importar datos a una tabla, jerarqua, apodo o vista . . . . . . . . . . . . . Modificadores de tipo de archivo para el programa de utilidad de importacin . . . . . . . . . db2Inspect - Inspeccionar la base de datos para comprobar la integridad de la arquitectura . . . db2InstanceQuiesce - Inmovilizar instancia . . . db2InstanceStart - Iniciar instancia . . . . . . db2InstanceStop - Detener instancia . . . . . . db2InstanceUnquiesce - Movilizar instancia . . . db2LdapCatalogDatabase - Registrar la base de datos en el servidor LDAP . . . . . . . . . 101 106

Captulo 1. Las API de DB2 . . . . . . 1Las API de DB2 . . . . . . . . . . . . . 1 Archivos de inclusin para aplicaciones de las API de DB2 . . . . . . . . . . . . . . . . 22 Cmo estn organizadas las descripciones de las API . . . . . . . . . . . . . . . . . 24 db2AddContact - Aadir un contacto al que se pueden enviar mensajes de notificacin . . . . . 28 db2AddContactGroup - Aadir un grupo de contactos al que se pueden enviar mensajes de notificacin . . . . . . . . . . . . . . 30 db2AddSnapshotRequest - Aadir una peticin de instantnea . . . . . . . . . . . . . . 32 db2AdminMsgWrite - Escribir mensajes de registro de anotaciones para la funcin de administracin y duplicacin . . . . . . . . . . . . . . 34 db2ArchiveLog - Archivar el archivo de anotaciones activo . . . . . . . . . . . . . . . . 36 db2AutoConfig - Acceder al Asesor de configuracin . . . . . . . . . . . . . . 39 db2AutoConfigFreeMemory - Liberar la memoria asignada por la API db2AutoConfig . . . . . . 44 db2Backup - Hacer copia de seguridad de una base de datos o espacio de tabla . . . . . . . . . 45 db2CfgGet - Obtener los parmetros de configuracin del gestor de bases de datos o de la base de datos . . . . . . . . . . . . . . 54 db2CfgSet - Definir los parmetros de configuracin del gestor de bases de datos o de la base de datos . 58 db2ConvMonStream - Convertir la corriente de supervisor en el formato anterior a la versin 6 . . 62 db2DatabasePing - Sondear la base de datos para comprobar el tiempo de respuesta de la red . . . 65 db2DatabaseQuiesce - Inmovilizar la base de datos 67 db2DatabaseRestart - Reiniciar base de datos . . . 69 db2DatabaseUnquiesce - Movilizar base de datos . . 72 db2DbDirCloseScan - Finalizar una exploracin del directorio de bases de datos locales o del sistema . . 74 db2DbDirGetNextEntry - Obtener la entrada siguiente del directorio de bases de datos locales o del sistema . . . . . . . . . . . . . . 76 db2DbDirOpenScan - Iniciar una exploracin del directorio de bases de datos locales o del sistema . . 80 db2DropContact - Eliminar un contacto de la lista de contactos a los que se pueden enviar mensajes de notificacin . . . . . . . . . . . . . . 82 db2DropContact - Eliminar un contacto de la lista de contactos a los que se pueden enviar mensajes de notificacin . . . . . . . . . . . . . . 84 db2Export - Exportar datos de una base de datos . . 86 Modificadores de tipo de archivo para el programa de utilidad de exportacin . . . . . . . . . 95 Copyright IBM Corp. 1993, 2006

107

109 111

113

115 118 119

123 127 128 131

133 135 137 140 145 149 164 175 182 185 191 195 197

iii

db2LdapCatalogNode - Proporcionar un alias para el nombre de nodo en el servidor LDAP . . . . db2LdapDeregister - Desregistrar el servidor DB2 y bases de datos del servidor LDAP . . . . . . db2LdapRegister - Registrar el servidor DB2 en el servidor LDAP . . . . . . . . . . . . . db2LdapUncatalogDatabase - Desregistrar base de datos del servidor LDAP . . . . . . . . . db2LdapUncatalogNode - Suprimir un alias del nombre de nodo en el servidor LDAP . . . . . db2LdapUpdate - Actualizar los atributos del servidor DB2 en el servidor LDAP . . . . . . db2LdapUpdateAlternateServerForDB - Actualizar el servidor alternativo de la base de datos en el servidor LDAP . . . . . . . . . . . . . db2Load - Cargar datos en una tabla . . . . . Modificadores de tipo de archivo para el programa de utilidad de carga . . . . . . . . . . . Restricciones de los delimitadores para mover datos . . . . . . . . . . . . . . . . db2LoadQuery - Obtener el estado de una operacin de carga . . . . . . . . . . . db2MonitorSwitches - Obtener o actualizar los valores de los conmutadores del supervisor . . . db2Prune - Suprimir las entradas del archivo histrico o los archivos de anotaciones de la va de acceso del archivo de anotaciones activo . . . . db2QuerySatelliteProgress - Obtener el estado de una sesin de sincronizacin de un satlite . . . db2ReadLog - Extrae registros del archivo de anotaciones cronolgicas . . . . . . . . . db2ReadLogNoConn - Leer los archivos de anotaciones de la base de datos sin una conexin a la base de datos . . . . . . . . . . . . db2ReadLogNoConnInit - Inicializar la lectura de los archivos de anotaciones de la base de datos sin una conexin a la base de datos . . . . . . . db2ReadLogNoConnTerm - Terminar la lectura de los archivos de anotaciones de la base de datos sin una conexin a la base de datos . . . . . . . db2Recover - Restaurar y avanzar una base de datos . . . . . . . . . . . . . . . . db2Reorg - Reorganizar un ndice o una tabla . . db2ResetAlertCfg - Restaurar la configuracin de alerta de los indicadores de estado . . . . . . db2ResetMonitor - Restaurar los datos del supervisor del sistema de base de datos . . . . db2Restore - Restaurar una base de datos o espacio de tabla . . . . . . . . . . . . . . . db2Rollforward - Avance de una base de datos . . db2Runstats - Actualizar estadsticas para tablas e ndices . . . . . . . . . . . . . . . API db2SelectDB2Copy - Seleccionar la copia de DB2 que la aplicacin utiliza . . . . . . . . db2SetSyncSession - Establecer sesin de sincronizacin de satlite . . . . . . . . . db2SetWriteForDB - Suspender o reanudar las escrituras de E/S para la base de datos . . . . . API db2SpmListIndTrans - Listar transacciones dudosas SPM . . . . . . . . . . . . .

200 202 204 208 210 212

215 217 239 252 254 262

266 269 271

276

280

283 284 291 299 301 304 318 329 340 342 344 346

db2SyncSatellite - Iniciar la sincronizacin de satlite . . . . . . . . . . . . . . . db2SyncSatelliteStop - Pausar sincronizacin de satlites . . . . . . . . . . . . . . . db2SyncSatelliteTest - Probar si se puede sincronizar un satlite . . . . . . . . . . db2UpdateAlertCfg - Actualizar los valores de configuracin de alertas para los indicadores de estado . . . . . . . . . . . . . . . . db2UpdateAlternateServerForDB - Actualizar el servidor alternativo para un alias de base de datos en el directorio de bases de datos del sistema . . db2UpdateContact - Actualizar los atributos de un contacto . . . . . . . . . . . . . . . db2UpdateContactGroup - Actualizar los atributos de un grupo de contactos . . . . . . . . . db2UpdateHealthNotificationList - Actualizar la lista de contactos a los que se puedan enviar notificaciones de alerta de estado . . . . . . . db2UtilityControl - Establecer el nivel de prioridad de los programas de utilidad en ejecucin . . . . db2XaGetInfo - Obtener informacin para un gestor de recursos . . . . . . . . . . . . API db2XaListIndTrans - Listar transacciones dudosas . . . . . . . . . . . . . . . sqlabndx - Programa de aplicacin de vinculacin para crear un paquete . . . . . . . . . . sqlaintp - Obtener mensaje de error . . . . . . sqlaprep - Precompilar programa de aplicacin . . sqlarbnd - Volver a vincular paquete . . . . . sqlbctcq - Cerrar una consulta de contenedor de espacio de tablas . . . . . . . . . . . . sqlbctsq - Cerrar una consulta de espacio de tablas sqlbftcq - Recuperar los datos de la consulta para filas de un contenedor de espacio de tablas . . . sqlbftpq - Recuperar los datos de la consulta para filas de un espacio de tablas . . . . . . . . sqlbgtss - Obtener estadsticas de utilizacin del espacio de tablas . . . . . . . . . . . . sqlbmtsq - Obtener los datos de la consulta para todos los espacios de tabla . . . . . . . . . sqlbotcq - Abrir una consulta de contenedor de espacio de tablas . . . . . . . . . . . . sqlbotsq - Abrir una consulta de espacio de tablas sqlbstpq - Obtener informacin sobre un espacio de tablas individual . . . . . . . . . . . . sqlbstsc - Definir contenedores de espacio de tablas sqlbtcq - Obtener los datos de la consulta para todos los contenedores de espacio de tablas . . . sqlcspqy - Listar transacciones dudosas DRDA . . sqle_activate_db - Activar base de datos . . . . sqle_deactivate_db - Desactivar base de datos . . sqleaddn - Aadir un servidor de particiones de base de datos al entorno de bases de datos particionado . . . . . . . . . . . . . . sqleatcp - Conectar a instancia y cambiar contrasea . . . . . . . . . . . . . . sqleatin - Conectar a instancia . . . . . . . . sqleAttachToCtx - Enlazar a contexto . . . . . sqleBeginCtx - Crear y enlazar a un contexto de aplicacin . . . . . . . . . . . . . .

350 351 352

353

359 361 363

365 367 369 370 376 379 382 385 389 390 391 393 395 397 399 401 404 406 409 411 413 416

418 421 424 427 428

iv


sqlecadb - Catalogar una base de datos del directorio de bases de datos del sistema . . . . sqlecran - Crear una base de datos en un servidor de particiones de base de datos . . . . . . . sqlecrea - Crear una base de datos . . . . . . sqlectnd - Catalogar una entrada en el directorio de nodos . . . . . . . . . . . . . . . . sqledcgd - Cambiar un comentario de base de datos en el directorio de bases de datos locales o del sistema . . . . . . . . . . . . . . sqleDetachFromCtx - Desenlazar de contexto . . . sqledpan - Eliminar una base de datos en un servidor de particiones de base de datos . . . . sqledrpd - Eliminar base de datos . . . . . . sqledrpn - Comprobar si se puede eliminar un servidor de particiones de base de datos . . . . sqledtin - Desconectar de instancia . . . . . . sqleEndCtx - Desenlazar de un contexto de aplicacin y liberar la memoria asociada a l . . . sqlefmem - Liberar la memoria asignada por las API sqlbtcq y sqlbmtsq . . . . . . . . . . sqlefrce - Desconectar usuarios y aplicaciones del sistema . . . . . . . . . . . . . . . sqlegdad - Catalogar una base de datos en el directorio de DCS (servicios de conexin de base de datos) . . . . . . . . . . . . . . . sqlegdcl - Finalizar una exploracin del directorio de DCS (servicios de conexin de base de datos) . sqlegdel - Descatalogar una base de datos del directorio de DCS (servicios de conexin de base de datos) . . . . . . . . . . . . . . . sqlegdge - Obtener una entrada especfica del directorio de DCS (servicios de conexin de base de datos) . . . . . . . . . . . . . . . sqlegdgt - Obtener entradas del directorio de DCS (servicios de conexin de base de datos) . . . . sqlegdcl - Iniciar una exploracin del directorio de DCS (servicios de conexin de base de datos) . . sqleGetCurrentCtx - Obtener contexto actual . . . sqlegins - Obtener instancia actual . . . . . . sqleInterruptCtx - Interrumpir contexto . . . . . sqleintr - Interrumpir peticiones de aplicaciones sqleisig - Instalar gestor de seales . . . . . . sqlemgdb - Migrar versin anterior de base de datos DB2 a la versin actual . . . . . . . . sqlencl - Finalizar una exploracin del directorio de nodos . . . . . . . . . . . . . . . . sqlengne - Obtener la entrada siguiente del directorio de nodos . . . . . . . . . . . sqlenops - Iniciar una exploracin del directorio de nodos . . . . . . . . . . . . . . . . sqleqryc - Consultar valores de conexin del cliente sqleqryi - Consultar informacin sobre el cliente sqlesact - Establecer informacin de contabilidad sqlesdeg - Establecer el nivel o grado mximo de paralelismo de intraparticin para la ejecucin de sentencias SQL . . . . . . . . . . . . . sqlesetc - Definir valores de conexin del cliente sqleseti - Definir informacin sobre el cliente . . . sqleSetTypeCtx - Definir tipo de contexto de aplicacin . . . . . . . . . . . . . .

430 436 438 446

450 453 454 456 459 461 462 464 465

sqleuncd - Descatalogar una base de datos del directorio de bases de datos del sistema . . . . sqleuncn - Descatalogar una entrada del directorio de nodos . . . . . . . . . . . . . . . sqlgaddr - Obtener la direccin de una variable sqlgdref - Eliminar la referencia de una direccin sqlgmcpy - Copiar datos de una rea de memoria a otra . . . . . . . . . . . . . . . . sqlogstt - Obtener el mensaje de SQLSTATE . . . sqluadau - Obtener autorizaciones del usuario actual . . . . . . . . . . . . . . . . sqludrdt - Redistribuir datos entre un grupo de particiones de base de datos . . . . . . . . sqlugrpn - Obtener el nmero de servidor de particiones de base de datos para una fila . . . . sqlugtpi - Obtener informacin de distribucin para una tabla . . . . . . . . . . . . . sqluvqdp - Inmovilizar espacios de tabla para una tabla . . . . . . . . . . . . . . . . sqlxhfrg - Olvidar estado de transaccin . . . . sqlxphcm - Confirmar una transaccin dudosa . . sqlxphrl - Retrotraer una transaccin dudosa . . .

513 515 517 518 519 520 522 525 529 533 535 539 540 542

468 471

Captulo 2. Estructuras de datos utilizadas por mltiples API . . . . . 545db2HistoryData . . . . sql_authorizations . . . . sql_dir_entry . . . . . SQLB_TBS_STATS . . . . SQLB_TBSCONTQRY_DATA SQLB_TBSPQRY_DATA . . SQLCA . . . . . . . sqlchar . . . . . . . SQLCA . . . . . . . sqldcol . . . . . . . sqle_addn_options . . . . sqle_client_info . . . . . sqle_conn_setting . . . . sqle_node_cpic . . . . . sqle_node_ipxspx . . . . sqle_node_local . . . . . sqle_node_netb . . . . . sqle_node_npipe . . . . sqle_node_struct . . . . sqle_node_tcpip . . . . sqledbdesc . . . . . . sqledbdescext . . . . . sqledbterritoryinfo . . . . sqleninfo . . . . . . . Estructura de datos . . . sqllob . . . . . . . . sqlma . . . . . . . . sqlopt . . . . . . . . SQLU_LSN . . . . . . sqlu_media_list . . . . . SQLU_RLOG_INFO . . . sqlupi . . . . . . . . SQLXA_XID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 545 552 554 556 558 560 565 566 567 569 572 574 577 581 582 583 584 585 586 588 589 596 604 605 608 615 616 620 622 623 628 629 631

472

475 477 479 481 482 484 485 487 489 491 492 495 497 499 501

503 505 508 511

Contenido

v

Captulo 3. Plugins de sistemas de base de datos DB2 para personalizar la gestin de bases de datos . . . . 633Plugins de sistemas de base de datos DB2 para personalizar la gestin de bases de datos . . . . Plugins de seguridad . . . . . . . . . . . Plugins de seguridad . . . . . . . . . . Desarrollo de plugins de seguridad . . . . . Las API de plugins de seguridad . . . . . . Plugins de copia de seguridad y restauracin para dispositivos de almacenamiento de proveedor . . Las API de DB2 para hacer copias de seguridad y restauraciones en gestores de almacenamiento . sqluvint - Inicializar y enlazar con un dispositivo de proveedor . . . . . . . . sqluvget - Leer datos de un dispositivo de proveedor . . . . . . . . . . . . . sqluvpt - Escribir datos en un dispositivo de proveedor . . . . . . . . . . . . . sqluvend - Desenlazar un dispositivo de proveedor y liberar sus recursos . . . . . . sqluvdel - Suprimir sesin comprometida . . . db2VendorQueryApiVersion - Obtener el nivel soportado de la API de almacenamiento de proveedor . . . . . . . . . . . . . db2VendorGetNextObj - Obtener el objeto siguiente en el dispositivo . . . . . . . . DB2_info . . . . . . . . . . . . . . Vendor_info . . . . . . . . . . . . . Init_input . . . . . . . . . . . . . Init_output . . . . . . . . . . . . . Data . . . . . . . . . . . . . . . Return_code . . . . . . . . . . . . . Plugins de compresin para copia de seguridad y restauracin . . . . . . . . . . . . . . Las API de DB2 para utilizar la compresin con las operaciones de copia de seguridad y restauracin . . . . . . . . . . . . . InitCompression - Inicializar la biblioteca de compresin . . . . . . . . . . . . . GetSavedBlock - Obtener el proveedor del bloque de datos para la imagen de copia de seguridad . . . . . . . . . . . . . Compress - Comprimir un bloque de datos . . GetMaxCompressedSize - Calcular el tamao mximo posible del almacenamiento intermedio . TermCompression - Detener la biblioteca de compresin . . . . . . . . . . . . . InitDecompression - Inicializar la biblioteca de descompresin . . . . . . . . . . . . Decompress - Descomprimir un bloque de datos TermDecompression - Detener la biblioteca de descompresin . . . . . . . . . . . . COMPR_DB2INFO . . . . . . . . . . COMPR_PIINFO . . . . . . . . . . . COMPR_CB . . . . . . . . . . . . . 633 634 634 657 670 718 718 728 734 736 738 740

Apndice B. Registros de anotaciones de DB2 . . . . . . . . . . . . . . 777Cabecera del gestor de anotaciones . . . . . . Registros de anotaciones del gestor de datos . . . Inicializar tabla . . . . . . . . . . . . Importar sustitucin (Truncar) . . . . . . . Activacin no registrada inicialmente . . . . Retrotraer insercin . . . . . . . . . . Reorganizar tabla . . . . . . . . . . . Registros de anotaciones de crear ndice, eliminar ndice . . . . . . . . . . . . Registros de anotaciones para crear tabla, eliminar tabla, retrotraer creacin de tabla, retrotraer eliminacin de tabla . . . . . . . Atributo de alterar tabla . . . . . . . . . Adicin de columnas por alteracin de tabla, retrotraer adicin de columnas . . . . . . Atributo de alterar columna . . . . . . . Atributo de deshacer alteracin de columna . . Insertar registro, retrotraer supresin de registro, retrotraer actualizacin de registro . . . . . Registro de datos de usuario formateado para una tabla sin VALUE COMPRESSION . . . . Registro de datos de usuario formateado para una tabla con VALUE COMPRESSION . . . . Insertar registro en pgina vaca, suprimir registro en pgina vaca, retrotraer supresin de registro en pgina vaca, retrotraer insercin de registro en pgina vaca . . . . . . . . . Actualizar registro . . . . . . . . . . . Registro de anotaciones de renombramiento de una tabla o un esquema . . . . . . . . . Registro de anotaciones de deshacer renombramiento de una tabla o un esquema . . Registros de anotaciones del gestor de campos largos . . . . . . . . . . . . . . . . Registro de adicin/supresin/no actualizacin de campo largo . . . . . . . . . . . . Registros de anotaciones del gestor de transacciones . . . . . . . . . . . . . Confirmacin normal . . . . . . . . . . Confirmacin heurstica . . . . . . . . . Confirmacin de coordinador MPP . . . . . Confirmacin de subordinador MPP . . . . . Cancelacin normal . . . . . . . . . . Cancelacin heurstica . . . . . . . . . Lista pendiente local . . . . . . . . . . Lista pendiente global . . . . . . . . . Preparacin de XA . . . . . . . . . . Preparacin de subordinador MPP . . . . . Preparacin de TM . . . . . . . . . . Libre de retrotraccin . . . . . . . . . . Registros de anotaciones del gestor de programas de utilidad . . . . . . . . . Migracin de aplicaciones . . . . . . . . API de REXX . . . . . . . . . . . . Informacin tcnica sobre DB2 Database . . . Avisos . . . . . . . . . . . . . . . 779 781 784 785 786 786 786 787

787 788 788 789 790 790 791 793

742 743 745 749 751 753 754 755 755

794 794 795 795 796 797 798 798 799 799 800 800 801 801 801 802 803 803 804 805 807 811 813 822

755 759

760 761 763 764 765 766 768 769 771 773

Apndice A. Las API de personalizacin de precompilador . . 775 vi

ndice . . . . . . . . . . . . . . . 827


Cmo ponerse en contacto con IBM

837

Contenido

vii

viii


Acerca de este manualEste manual proporciona informacin sobre cmo utilizar las interfaces de programacin de aplicaciones (API) para ejecutar funciones administrativas de las bases de datos. Presenta informacin detallada acerca del uso de llamadas a la API del gestor de bases de datos en aplicaciones escritas en los siguientes lenguajes de programacin: v C v C++ v COBOL v FORTRAN v REXX. Para un lenguaje compilado, es necesario que est disponible un precompilador para procesar las sentencias. Se proporcionan precompiladores para todos los lenguajes soportados.

Quin debe utilizar este manualSe supone que el lector tiene conocimientos sobre la programacin de aplicaciones y la administracin de bases de datos, as como conocimientos sobre: v Structured Query Language (SQL) v El lenguaje de programacin C, C++, COBOL, FORTRAN o REXX v El diseo de programas de aplicacin.

Copyright IBM Corp. 1993, 2006

ix

x


Captulo 1. Las API de DB2En esta seccin se describen las interfaces de programacin de aplicaciones DB2 en orden alfabtico. Las API habilitan la mayora de las funciones administrativas desde dentro del programa de aplicaciones. Nota: Las barras inclinadas (/) que aparecen en las vas de acceso de directorio son especficas de los sistemas basados en UNIX, y son equivalentes a las barras inclinadas invertidas (\) en las vas de acceso de directorio en los sistemas operativos Windows.

Las API de DB2Las tablas siguientes muestran las API de DB2 con los programas de ejemplo de DB2. La primera tabla lista las API de DB2 agrupadas segn la categora funcional, sus respectivos archivos de inclusin y los programas de ejemplo que muestran su utilizacin (consulte la nota incluida a continuacin de la tabla para obtener ms informacin sobre los archivos de inclusin). La segunda tabla lista los programas de ejemplo de C/C++ y muestra las API de DB2 ejemplificadas en cada programa de C/C++. La tercera tabla muestra los programas de ejemplo de COBOL y las API de DB2 ejemplificadas en cada programa COBOL. Las API de DB2, archivos de inclusin y programas de ejemplo Tabla 1. Programas de ejemplo de C/C++ con las API de DB2 Tabla 2 en la pgina 14. Programas de ejemplo COBOL con las API de DB2 Tabla 3 en la pgina 17.Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemploTipo de API API de DB2 Archivo de inclusin db2ApiDf Programas de ejemplo n/d

Las API de API db2DatabaseQuiesce - Inmovilizar la control de bases base de datos de datos Las API de API db2DatabaseUnquiesce - Movilizar control de bases base de datos de datos Las API de API db2DatabaseRestart - Reiniciar la control de bases base de datos de datos Las API de API sqlecrea - Crear base de datos control de bases de datos Las API de API sqlecran - Crear una base de datos control de bases en un servidor de particiones de base de de datos datos Las API de API sqledrpd - Eliminar base de datos control de bases de datos Las API de API sqledpan - Descartar una base de control de bases datos en un servidor de particiones de de datos base de datos

db2ApiDf

n/d

db2ApiDf

C: dbconn.sqc C++: dbconn.sqC

sqlenv

C: dbcreate.c dbrecov.sqc dbsample.sqc C++: dbcreate.C dbrecov.sqC COBOL: db_udcs.cbl dbconf.cbl ebcdicdb.cbl n/d

sqlenv

sqlenv

C: dbcreate.c C++: dbcreate.C COBOL: dbconf.cbl n/d

sqlenv

Copyright IBM Corp. 1993, 2006

1

Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API API de DB2 Archivo de inclusin sqlenv Programas de ejemplo C: dbmigrat.c C++: dbmigrat.C COBOL: migrate.cbl n/d

Las API de API sqlemgdb - Migrar versin anterior control de bases de base de datos DB2 a versin actual de datos Las API de API db2XaListIndTrans - Listar control de bases transacciones dudosas de datos Las API de API sqle_activate_db - Activar base de control de bases datos de datos Las API de API sqle_deactivate_db - Desactivar base control de bases de datos de datos Las API de API sqlcspqy - Listar transacciones control de bases dudosas de DRDA de datos Las API de API db2SetWriteForDB - Suspender o control de bases reanudar las escrituras de E/S para la de datos base de datos Las API de API sqlefrce - Obligar a los usuarios y las control de bases aplicaciones a salir del sistema de datos Las API de control de instancias Las API de control de instancias Las API de control de instancias Las API de control de instancias Las API de control de instancias Las API de control de instancias Las API de control de instancias Las API de control de instancias Las API de control de instancias Las API de control de instancias API db2InstanceStart - Iniciar instancia

db2ApiDf

sqlenv

n/d

sqlenv

n/d

sqlxa

n/d

db2ApiDf

n/d

sqlenv

C: dbconn.sqc dbsample.sqc instart.c C++: dbconn.sqC instart.C COBOL: dbstop.cbl C: instart.c C++: instart.C

db2ApiDf

API db2InstanceStop - Detener instancia

db2ApiDf

C: instart.c C++: instart.C

API db2InstanceQuiesce - Inmovilizar instancia API db2InstanceUnquiesce - Movilizar instancia API sqleatin - Enlazar con instancia

db2ApiDf

n/d

db2ApiDf

n/d

sqlenv

C: inattach.c utilapi.c C++: inattach.C utilapi.C COBOL: dbinst.cbl C: inattach.c C++: inattach.C COBOL: dbinst.cbl C: inattach.c utilapi.c C++: inattach.C utilapi.C COBOL: dbinst.cbl C: ininfo.c C++: ininfo.C COBOL: dbinst.cbl

API sqleatcp - Enlazar con instancia y cambiar contrasea API sqledtin - Desenlazar de instancia

sqlenv

sqlenv

API sqlegins - Obtener instancia actual

sqlenv

API sqluadau - Obtener las autorizaciones del usuario actual API db2UtilityControl - Establecer el nivel de prioridad de los programas de utilidad en ejecucin

sqlutil

n/d

db2ApiDf

n/d

2


Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API Las API del gestor de bases de datos y de configuracin de bases de datos Las API del gestor de bases de datos y de configuracin de bases de datos Las API del gestor de bases de datos y de configuracin de bases de datos Las API del gestor de bases de datos y de configuracin de bases de datos Las API de supervisin de bases de datos Las API de supervisin de bases de datos Las API de supervisin de bases de datos Las API de supervisin de bases de datos Las API de supervisin de bases de datos Las API de supervisin de bases de datos Las API de supervisin de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos API de DB2 API db2CfgGet - Obtener los parmetros de configuracin de la base de datos o del gestor de bases de datos Archivo de inclusin db2ApiDf Programas de ejemplo C: dbinfo.c dbrecov.sqc inauth.sqc ininfo.c tscreate.sqc C++: dbinfo.C dbrecov.sqC inauth.sqC ininfo.C tscreate.sqC

API db2CfgSet - Establecer los parmetros de configuracin de la base de datos o del gestor de bases de datos

db2ApiDf

C: dbinfo.c dbrecov.sqc ininfo.c C++: dbinfo.C dbrecov.sqC ininfo.C

API db2AutoConfig - Acceder al Asesor de configuracin

db2AuCfg

C: dbcfg.sqc C++: dbcfg.sqC

API db2AutoConfigFreeMemory - Liberar db2AuCfg la memoria asignada por la API db2AutoConfig

C: dbcfg.sqc C++: dbcfg.sqC

API db2GetSnapshotSize - Calcular el tamao del almacenamiento intermedio necesario para la API db2GetSnapshot API db2AddSnapshotRequest - Aadir una peticin de instantnea API db2MonitorSwitches - Obtener o actualizar los valores de conmutacin de supervisin API db2GetSnapshot - Obtener una instantnea del estado operativo del gestor de bases de datos

db2ApiDf

n/d

db2ApiDf

n/d

db2ApiDf

C: utilsnap.c C++: utilsnap.C

db2ApiDf


API db2ResetMonitor - Restablecer los db2ApiDf datos de supervisin del sistema de bases de datos API db2ConvMonStream - Convertir la corriente de supervisin al formato anterior a la versin 6 API db2Inspect - Inspeccionar integridad de arquitectura de base de datos db2ApiDf

n/d

n/d

db2ApiDf

n/d

API db2AddContact - Aadir un contacto db2ApiDf al que enviar los mensajes de notificacin

n/d

API db2AddContactGroup - Aadir un grupo de contactos a los que enviar los mensajes de notificacin API db2DropContact - Eliminar un contacto de la lista de contactos a los que enviar los mensajes de notificacin

db2ApiDf

n/d

db2ApiDf

n/d

Captulo 1. Las API de DB2

3

Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos API de DB2 Archivo de inclusin Programas de ejemplo n/d

API db2DropContactGroup - Eliminar un db2ApiDf grupo de contactos de la lista de contactos a los que enviar los mensajes de notificacin API db2GetAlertCfg - Obtener los valores db2ApiDf de configuracin de alerta para los indicadores de salud API db2GetAlertCfgFree - Liberar la memoria asignada por la API db2GetAlertCfg db2ApiDf

n/d

n/d

API db2GetContactGroup - Obtener la db2ApiDf lista de contactos de un solo grupo de contactos a los que enviar los mensajes de notificacin API db2GetContactGroups - Obtener la lista de grupos de contactos a los que enviar los mensajes de notificacin db2ApiDf

n/d

n/d

API db2GetContacts - Obtener la lista de db2ApiDf contactos a los que enviar los mensajes de notificacin API db2GetHealthNotificationList Obtener la lista de contactos a los que enviar las notificaciones de alerta de salud db2ApiDf

n/d

n/d

API db2ResetAlertCfg - Restablecer la db2ApiDf configuracin de alerta de los indicadores de salud API db2UpdateAlertCfg - Actualizar los valores de configuracin de alerta de los indicadores de salud API db2UpdateContact - Actualizar los atributos de un contacto db2ApiDf

n/d

n/d

db2ApiDf

n/d

API db2UpdateContactGroup - Actualizar db2ApiDf los atributos de un grupo de contactos

n/d

API db2UpdateHealthNotificationList Actualizar la lista de contactos a los que enviar las notificaciones de alerta de salud API db2GetSnapshot - Obtener una instantnea del estado operativo del gestor de bases de datos API db2GetSnapshotSize - Calcular el tamao del almacenamiento intermedio necesario para la API db2GetSnapshot

db2ApiDf

n/d

db2ApiDf


db2ApiDf

n/d

4


Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API Las API de supervisin de estado de bases de datos Las API de supervisin de estado de bases de datos Las API de traslado de datos Las API de traslado de datos Las API de traslado de datos Las API de traslado de datos Las API de traslado de datos Las API de recuperacin Las API de recuperacin Las API de recuperacin Las API de recuperacin Las API de recuperacin Las API de recuperacin Las API de recuperacin Las API de recuperacin API de DB2 API db2GetRecommendations - Obtener recomendaciones para resolver un indicador de salud en estado de alerta API db2GetRecommendationsFree Liberar la memoria asignada por la API db2GetRecommendations API db2Export - Exportar datos de una base de datos API db2Import - Importar datos en una tabla, jerarqua, apodo o vista API db2Load - Cargar datos en una tabla Archivo de inclusin db2ApiDf Programas de ejemplo n/d

db2ApiDf

n/d

sqlutil

C: tbmove.sqc C++: tbmove.sqC COBOL: expsamp.sqb impexp.sqb tload.sqb C: dtformat.sqc tbmove.sqc C++: tbmove.sqC COBOL: expsamp.sqb impexp.sqb C: dtformat.sqc tbload.sqc tbmove.sqc C++: tbmove.sqC C: tbmove.sqc C++: tbmove.sqC COBOL: loadqry.sqb n/d

db2ApiDf

db2ApiDf

API db2LoadQuery - Obtener el estado de una operacin de carga

db2ApiDf

API sqludrdt - Redistribuir datos entre un sqlutil grupo de particiones de base de datos API db2Backup - Realizar una copia de seguridad de una base de datos o un espacio de tabla API db2Restore - Restaurar una base de datos o un espacio de tablas API db2Recover - Restaurar y avanzar una base de datos API db2Rollforward - Avanzar una base de datos API db2HistoryOpenScan - Iniciar una exploracin del archivo histrico API db2HistoryGetEntry - Obtener la entrada siguiente del archivo histrico API db2HistoryCloseScan - Finalizar la exploracin del archivo histrico API db2Prune - Suprimir las entradas del archivo histrico o los archivos de anotaciones cronolgicas de la va de acceso de anotaciones cronolgicas activas API db2HistoryUpdate - Actualizar una entrada del archivo histrico API db2ArchiveLog - Archivar el archivo de anotaciones cronolgicas activo API db2HADRStart - Iniciar operaciones de Recuperacin de catstrofes de alta disponibilidad (HADR) db2ApiDf

C: dbrecov.sqc C++: dbrecov.sqC

db2ApiDf db2ApiDf db2ApiDf db2ApiDf db2ApiDf db2ApiDf db2ApiDf

C: dbrecov.sqc C++: dbrecov.sqC n/d C: dbrecov.sqc C++: dbrecov.sqC C: dbrecov.sqc C++: dbrecov.sqC C: dbrecov.sqc C++: dbrecov.sqC C: dbrecov.sqc C++: dbrecov.sqC C: dbrecov.sqc C++: dbrecov.sqC

Las API de recuperacin Las API de recuperacin Las API de HADR (High Availability Disaster Recovery)

db2ApiDf db2ApiDf db2ApiDf

C: dbrecov.sqc C++: dbrecov.sqC n/d n/d


5

Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API Las API de HADR (High Availability Disaster Recovery) Las API de HADR (High Availability Disaster Recovery) API de DB2 Archivo de inclusin Programas de ejemplo n/d

API db2HADRStop - Detener operaciones db2ApiDf de Recuperacin de catstrofes de alta disponibilidad (HADR)

API db2HADRTakeover - Indicar a una base de datos que debe tomar el control como base de datos primaria de Recuperacin de desastres de alta disponibilidad (HADR)

db2ApiDf

n/d

Las API de API sqlecadb - Catalogar una base de gestin de datos en el directorio de bases de datos directorios de del sistema bases de datos y de DCS Las API de API sqleuncd - Descatalogar una base de gestin de datos del directorio de bases de datos del directorios de sistema bases de datos y de DCS Las API de API sqlegdad - Catalogar una base de gestin de datos en el directorio de servicios de directorios de conexin de bases de datos (DCS) bases de datos y de DCS Las API de API sqlegdel - Descatalogar una base de gestin de datos del directorio de servicios de directorios de conexin de bases de datos (DCS) bases de datos y de DCS

sqlenv

C: ininfo.c C++: ininfo.C COBOL: dbcat.cbl

sqlenv

C: ininfo.c C++: ininfo.C COBOL: dbcat.cbl

sqlenv

C: ininfo.c C++: ininfo.C COBOL: dcscat.cbl

sqlenv


Las API de API sqledcgd - Cambiar un comentario sqlenv gestin de de base de datos en el directorio de bases directorios de de datos local o del sistema bases de datos y de DCS Las API de API db2DbDirOpenScan - Iniciar una gestin de exploracin del directorio de bases de directorios de datos local o del sistema bases de datos y de DCS Las API de API db2DbDirGetNextEntry - Obtener la gestin de entrada siguiente del directorio de bases directorios de de datos local o del sistema bases de datos y de DCS Las API de API db2DbDirCloseScan - Terminar una gestin de exploracin del directorio de bases de directorios de datos local o del sistema bases de datos y de DCS db2ApiDf

C: ininfo.c C++: ininfo.C COBOL: dbcmt.cbl

C: ininfo.c C++: ininfo.C COBOL: dbcat.cbl dbcmt.cbl

db2ApiDf


db2ApiDf


Las API de API sqlegdsc - Iniciar una exploracin del sqlenv gestin de directorio de servicios de conexin de directorios de bases de datos (DCS) bases de datos y de DCS


6


Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API API de DB2 Archivo de inclusin sqlenv Programas de ejemplo C: ininfo.c C++: ininfo.C COBOL: dcscat.cbl

Las API de API sqlegdgt - Obtener entradas del gestin de directorio de servicios de conexin de directorios de bases de datos (DCS) bases de datos y de DCS

Las API de API sqlegdcl - Terminar una exploracin sqlenv gestin de del directorio de servicios de conexin de directorios de bases de datos (DCS) bases de datos y de DCS Las API de API sqlegdge - Obtener una entrada gestin de concreta del directorio de servicios de directorios de conexin de bases de datos (DCS) bases de datos y de DCS Las API de gestin de directorios de bases de datos y de DCS Las API de gestin de cliente/servidor Las API de gestin de cliente/servidor Las API de gestin de cliente/servidor Las API de gestin de cliente/servidor Las API de gestin de cliente/servidor Las API de gestin de cliente/servidor Las API de gestin de cliente/servidor Las API de gestin de cliente/servidor API db2UpdateAlternateServerForDB Actualizar el servidor alternativo para un alias de base de datos en el directorio de bases de datos del sistema API sqleqryc - Consultar valores de conexin de cliente API sqleqryi - Consultar informacin de cliente API sqlesetc - Establecer valores de conexin de cliente API sqleseti - Establecer informacin de cliente API sqlesact - Establecer serie de contabilidad API db2DatabasePing - Sondear la base de datos para probar el tiempo de respuesta de la red API sqleisig - Instalar manejador de seales API sqleintr - Interrumpir peticiones de aplicacin sqlenv



db2ApiDf

n/d

sqlenv

C: cli_info.c C++: cli_info.C COBOL: client.cbl C: cli_info.c C++: cli_info.C

sqlenv

sqlenv

C: cli_info.c dbcfg.sqc dbmcon.sqc C++: cli_info.C dbcfg.sqC dbmcon.sqC COBOL: client.cbl C: cli_info.c C++: cli_info.C

sqlenv

sqlenv

COBOL: setact.cbl

db2ApiDf

n/d

sqlenv

COBOL: dbcmt.cbl

sqlenv

n/d

Las API de API db2LdapRegister - Registrar el gestin de servidor DB2 UDB en el servidor LDAP directorios de LDAP (Lightweight Directory Access Protocol) Las API de API db2LdapUpdate - Actualizar los gestin de atributos del servidor DB2 UDB en el directorios de servidor LDAP LDAP (Lightweight Directory Access Protocol)

db2ApiDf

n/d

db2ApiDf

n/d


7

Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API API de DB2 Archivo de inclusin db2ApiDf Programas de ejemplo n/d

Las API de API db2LdapDeregister - Desregistrar el gestin de servidor DB2 y las bases de datos directorios de catalogadas del servidor LDAP LDAP (Lightweight Directory Access Protocol) Las API de API db2LdapCatalogNode - Proporcionar gestin de un alias para el nombre de nodo en el directorios de servidor LDAP LDAP (Lightweight Directory Access Protocol)

db2ApiDf

n/d

Las API de API db2LdapUncatalogNode - Suprimir db2ApiDf gestin de alias para el nombre de nodo del servidor directorios de LDAP LDAP (Lightweight Directory Access Protocol) Las API de API db2LdapCatalogDatabase - Registrar gestin de la base de datos en el servidor LDAP directorios de LDAP (Lightweight Directory Access Protocol) Las API de API db2LdapUncatalogDatabase gestin de Eliminar del registro la base de datos del directorios de servidor LDAP LDAP (Lightweight Directory Access Protocol) Las API de gestin de directorios de LDAP (Lightweight Directory Access Protocol) Las API de programacin y preparacin de aplicaciones Las API de programacin y preparacin de aplicaciones Las API de programacin y preparacin de aplicaciones Las API de programacin y preparacin de aplicaciones API db2LdapUpdateAlternateServerForDB Actualizar el servidor alternativo para la base de datos en el servidor LDAP db2ApiDf

n/d

n/d

db2ApiDf

n/d

db2ApiDf

n/d

API sqlaintp - Obtener mensaje de error

sql

C: dbcfg.sqc utilapi.c C++: dbcfg.sqC utilapi.C COBOL: checkerr.cbl

API sqlogstt - Obtener el mensaje SQLSTATE

sql

C: utilapi.c C++: utilapi.C COBOL: checkerr.cbl

API sqleisig - Instalar manejador de seales

sqlenv

COBOL: dbcmt.cbl

API sqleintr - Interrumpir peticiones de aplicacin

sqlenv

n/d

8


Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API Las API de programacin y preparacin de aplicaciones Las API de programacin y preparacin de aplicaciones Las API de programacin y preparacin de aplicaciones Las API especficas de aplicaciones COBOL, FORTRAN y REXX Las API especficas de aplicaciones COBOL, FORTRAN y REXX Las API especficas de aplicaciones COBOL, FORTRAN y REXX Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas API de DB2 API sqlaprep - Precompilar el programa de aplicaciones Archivo de inclusin sql Programas de ejemplo C: dbpkg.sqc C++: dbpkg.sqC

API sqlabndx - Vincular programa de aplicaciones para crear un paquete

sql

C: dbpkg.sqc dbsample.sqc C++: dbpkg.sqC

API sqlarbnd - Volver a vincular paquete

sql

C: dbpkg.sqc C++: dbpkg.sqC COBOL: rebind.sqb

API sqlgaddr - Obtener la direccin de una variable

sqlutil

n/d

API sqlgdref - Eliminar la referencia de una direccin

sqlutil

n/d

API sqlgmcpy - Copiar datos de un rea de memoria a otra

sqlutil

n/d

API sqlbtcq - Obtener los datos de consulta para todos los contenedores de espacios de tabla

sqlutil

C: dbrecov.sqc tsinfo.sqc C++: dbrecov.sqC tsinfo.sqC COBOL: tabscont.sqb tspace.sqb

API sqlbotcq - Abrir una consulta de contenedor de espacio de tabla

sqlutil

C: tsinfo.sqc C++: tsinfo.sqC COBOL: tabscont.sqb tspace.sqb

API sqlbftcq - Captar en los datos de consulta filas de un contenedor de espacio de tabla

sqlutil


API sqlbctcq - Cerrar una consulta de contenedor de espacio de tabla

sqlutil


API sqlbstsc - Establecer contenedores de espacios de tablas

sqlutil

C: dbrecov.sqc C++: dbrecov.sqC COBOL: tabscont.sqb tspace.sqb


9

Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de espacios de tabla y gestin de tablas Las API de gestin de directorios de nodos Las API de gestin de directorios de nodos API de DB2 API sqlbmtsq - Obtener los datos de consulta para todos los espacios de tabla Archivo de inclusin sqlutil Programas de ejemplo C: dbrecov.sqc tsinfo.sqc C++: dbrecov.sqC tsinfo.sqC COBOL: tabspace.sqb tspace.sqb

API sqlbstpq - Obtener informacin sobre sqlutil un solo espacio de tablas

C: tsinfo.sqc C++: tsinfo.sqC COBOL: tabspace.sqb tspace.sqb

API sqlbotsq - Abrir una consulta de espacios de tabla

sqlutil


API sqlbftpq - Captar en los datos de consulta filas de un espacio de tabla

sqlutil


API sqlbctsq - Cerrar una consulta de espacio de tabla

sqlutil


API sqlbgtss - Obtener las estadsticas de uso de espacio de tablas

sqlutil


API sqluvqdp - Inmovilizar espacios de tabla para una tabla

sqlutil

C: tbmove.sqc C++: tbmove.sqC COBOL: tload.sqb

API db2Runstats - Actualizar las estadsticas para tablas e ndices

db2ApiDf

C: tbreorg.sqc C++: tbreorg.sqC COBOL: dbstat.sqb

API db2Reorg - Reorganizar un ndice o una tabla

db2ApiDf

C: tbreorg.sqc C++: tbreorg.sqC COBOL: dbstat.sqb

API sqlefmem - Liberar la memoria asignada por las API sqlbtcq y sqlbmtsq

sqlenv

C: dbrecov.sqc tsinfo.sqc C++: dbrecov.sqC tsinfo.sqC COBOL: tabscont.sqb tabspace.sqb tspace.sqb

API sqlectnd - Catalogar una entrada en el directorio de nodos

sqlenv

C: ininfo.c C++: ininfo.C COBOL: nodecat.cbl

API sqleuncn - Descatalogar una entrada del directorio de nodos

sqlenv


10


Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API Las API de gestin de directorios de nodos Las API de gestin de directorios de nodos Las API de gestin de directorios de nodos Las API de gestin de directorios de nodos Las API de sincronizacin de satlites Las API de sincronizacin de satlites Las API de sincronizacin de satlites Las API de sincronizacin de satlites Las API de sincronizacin de satlites Las API de sincronizacin de satlites Las API de archivos de anotaciones de lectura Las API de archivos de anotaciones de lectura Las API de archivos de anotaciones de lectura Las API de archivos de anotaciones de lectura Las API de gestin de transacciones dudosas API de DB2 API sqlenops - Iniciar una exploracin del directorio de nodos Archivo de inclusin sqlenv Programas de ejemplo C: ininfo.c C++: ininfo.C COBOL: nodecat.cbl

API sqlengne - Obtener la entrada siguiente del directorio de nodos

sqlenv


API sqlencls - Finalizar una exploracin del directorio de nodos

sqlenv


API db2UpdateAlternateServerForDB Actualizar el servidor alternativo para un alias de base de datos en el directorio de bases de datos del sistema API db2GetSyncSession - Obtener un identificador de sesin de sincronizacin de satlite API db2QuerySatelliteProgress - Obtener el estado de una sesin de sincronizacin de satlite

db2ApiDf

n/d

db2ApiDf

n/d

db2ApiDf

n/d

API db2SetSyncSession - Establecer sesin db2ApiDf de sincronizacin de satlite API db2SyncSatellite - Iniciar sincronizacin de satlite API db2SyncSatelliteStop - Pausar sincronizacin de satlite API db2SyncSatelliteTest - Probar si un satlite puede sincronizarse API db2ReadLog - Extraer registros de anotaciones cronolgicas db2ApiDf

n/d

n/d

db2ApiDf

n/d

db2ApiDf

n/d

db2ApiDf

C: dbrecov.sqc C++: dbrecov.sqC

API db2ReadLogNoConn - Leer las anotaciones cronolgicas de la base de datos sin una conexin con la base de datos API db2ReadLogNoConnInit - Inicializar la lectura de las anotaciones cronolgicas de la base de datos sin una conexin con la base de datos API db2ReadLogNoConnTerm - Finalizar la lectura de las anotaciones cronolgicas de la base de datos sin una conexin con la base de datos API db2XaListIndTrans - Listar transacciones dudosas

db2ApiDf

n/d

db2ApiDf

n/d

db2ApiDf

n/d

db2ApiDf

n/d


11

Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API Las API de gestin de transacciones dudosas Las API de gestin de transacciones dudosas Las API de gestin de transacciones dudosas Las API de gestin de transacciones dudosas Las API para obtener acceso simultneo a una base de datos Las API para obtener acceso simultneo a una base de datos Las API para obtener acceso simultneo a una base de datos Las API para obtener acceso simultneo a una base de datos Las API para obtener acceso simultneo a una base de datos Las API para obtener acceso simultneo a una base de datos Las API para obtener acceso simultneo a una base de datos Las API de gestin de particiones de base de datos Las API de gestin de particiones de base de datos API de DB2 API sqlxhfrg - Olvidar estado de transaccin Archivo de inclusin sqlxa Programas de ejemplo n/d

API sqlxphcm - Comprometer una transaccin dudosa

sqlxa

n/d

API sqlxphrl - Retrotraer una transaccin dudosa

sqlxa

n/d

API sqlcspqy - Listar transacciones dudosas de DRDA

sqlxa

n/d

API sqleAttachToCtx - Enlazar con contexto

sql

C: dbthrds.sqc C++: dbthrds.sqC

API sqleBeginCtx - Crear y enlazar con un contexto de aplicacin

sql


API sqleDetachFromCtx - Desenlazar del contexto

sql


API sqleEndCtx - Desenlazar y liberar la memoria asociada con un contexto de aplicacin

sql

n/d

API sqleGetCurrentCtx - Obtener contexto actual

sql

n/d

API sqleInterruptCtx - Interrumpir contexto

sql

n/d

API sqleSetTypeCtx - Establecer tipo de contexto de aplicacin

sql


API sqleaddn - Aadir un servidor de particiones de base de datos al entorno de bases de datos particionadas API sqledrpn - Comprobar si puede eliminarse un servidor de bases de datos particionadas

sqlenv

n/d

sqlenv

n/d

12


Las API de DB2Tabla 1. Las API de DB2, archivos de inclusin y programas de ejemplo (continuacin)Tipo de API Las API de gestin de particiones de base de datos Las API de gestin de particiones de base de datos Las API de gestin de particiones de base de datos Las API de gestin de particiones de base de datos Las API de gestin de particiones de base de datos Las API de gestin de particiones de base de datos APIs diversas API de DB2 API sqlecran - Crear una base de datos en un servidor de particiones de base de datos API sqledpan - Descartar una base de datos en un servidor de particiones de base de datos Archivo de inclusin sqlenv Programas de ejemplo n/d

sqlenv

n/d

API sqlesdeg - Establecer el grado o nivel sqlenv de paralelismo intraparticin mximo en tiempo de ejecucin para las sentencias SQL API sqlugtpi - Obtener informacin de distribucin de tabla sqlutil

C: ininfo.c C++: ininfo.C

n/d

API sqlugrpn - Obtener el nmero de servidor de particiones de base de datos para una fila

sqlutil

n/d

API sqludrdt - Redistribuir datos entre un sqlutil grupo de particiones de base de datos

n/d

API db2AdminMsgWrite - Escribir mensajes de anotaciones cronolgicas para la funcin de administracin y rplica API db2XaGetInfo - Obtener informacin sobre un gestor de recursos

db2ApiDf

n/d

APIs diversas

sqlxa

n/d

Nota: Las extensiones de los archivos de inclusin varan segn el lenguaje de programacin. Los archivos de inclusin de C/C++ tienen la extensin de archivo .h. Los archivos de inclusin de COBOL tienen la extensin de archivo .cbl. Los archivos de inclusin 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


13

Las API de DB2Tabla 2. Programas de ejemplo de C/C++ con las API de DB2 Programa de ejemplo cli_info.c, cli_info.C Las API incluidas v API sqlesetc - Definir valores de conexin del cliente v API sqleseti - Definir informacin sobre el cliente v API sqleqryc - Consultar valores de conexin del cliente v API sqleqryi - Consultar informacin sobre el cliente dbauth.sqc, dbauth.sqC dbcfg.sqc, dbcfg.sqC v API sqluadau - Obtener autorizaciones del usuario actual v API db2AutoConfig - Acceder al Asesor de configuracin v API db2AutoConfigFreeMemory - Liberar la memoria asignada por la API db2AutoConfig v API sqlesetc - Definir valores de conexin del cliente v API sqlaintp - Obtener mensaje de error dbconn.sqc, dbconn.sqC dbcreate.c, dbcreate.C dbinfo.c, dbinfo.C v API db2DatabaseRestart- Reiniciar base de datos v API sqlefrc - Desconectar usuarios y aplicaciones del sistema v API sqlecrea - Crear base de datos v API sqledrpd - Eliminar base de datos v API db2CfgGet - Obtener parmetros de configuracin del gestor de bases de datos o de la base de datos v API db2CfgSet - Definir parmetros de configuracin del gestor de bases de datos o de la base de datos dbmcon.sqc, dbmcon.sqC dbmigrat.c, dbmigrat.C dbpkg.sqc, dbpkg.sqC v API sqlesetc - Definir valores de conexin del cliente v API sqlemgdb - Migrar versin anterior de base de datos DB2 a la versin actual v API sqlaprep - Precompilar programa de aplicacin v API sqlabndx - Vincular programa de aplicacin para crear un paquete v API sqlarbnd - Volver a vincular paquete

14


Las API de DB2Tabla 2. Programas de ejemplo de C/C++ con las API de DB2 (continuacin) Programa de ejemplo dbrecov.sqc, dbrecov.sqC Las API incluidas v API db2HistoryCloseScan - Finalizar la exploracin del archivo histrico v API db2HistoryGetEntry - Obtener la entrada siguiente del archivo histrico v API db2HistoryOpenScan - Iniciar una exploracin del archivo histrico v API db2HistoryUpdate - Actualizar una entrada de archivo histrico v API db2Prune - Suprimir las entradas del archivo histrico o archivos de anotaciones de la va de acceso del archivo de anotaciones activo v API db2CfgGet - Obtener parmetros de configuracin del gestor de bases de datos o de la base de datos v API db2CfgSet - Definir parmetros de configuracin del gestor de bases de datos o de la base de datos v API sqlbmtsq - Obtener los datos de la consulta para todos los espacios de tabla v API sqlbstsc - Definir contenedores de espacio de tabla v API sqlbtcq - Obtener los datos de la consulta para todos los contenedores de espacio de tabla v API sqlecrea - Crear base de datos v API sqledrpd - Eliminar base de datos v API sqlefmem - Liberar la memoria asignada por las API sqlbtcq y sqlbmtsq v API db2Backup - Hacer copia de seguridad de una base de datos o espacio de tabla v API db2Restore - Restaurar una base de datos o espacio de tabla v API db2ReadLog - Lectura asncrona de archivo de anotaciones v API db2ReadLogNoConn - Leer archivo de anotaciones sin una conexin de base de datos v API db2Rollforward - Retrotraer una base de datos dbsample.sqc v API db2DatabaseRestart- Reiniciar base de datos v API sqlecrea - Crear base de datos v API sqlefrc - Desconectar usuarios y aplicaciones del sistema v API sqlabndx - Vincular programa de aplicacin para crear un paquete dbthrds.sqc, dbthrds.sqC v API sqleAttachToCtx - Asociar a contexto v API sqleBeginCtx - Crear y asociar a un contexto de aplicacin v API sqleDetachFromCtx - Separar del contexto v API sqleSetTypeCtx - Definir tipo de contexto de aplicacin dtformat.sqc v API db2Load - Cargar datos en una tabla v API db2Import - Importar datos a una tabla, jerarqua, apodo o vista inattach.c, inattach.C v API sqleatcp - Conectar a instancia y cambiar contrasea v API sqleatin - Conectar a instancia v API sqledtin - Desconectar de instancia


15

Las API de DB2Tabla 2. Programas de ejemplo de C/C++ con las API de DB2 (continuacin) Programa de ejemplo inauth.sqc, inauth.sqC Las API incluidas v API db2CfgGet - Obtener parmetros de configuracin del gestor de bases de datos o de la base de datos v API sqluadau - Obtener autorizaciones del usuario actual ininfo.c, ininfo.C v API db2CfgGet - Obtener parmetros de configuracin del gestor de bases de datos o de la base de datos v API db2CfgSet - Definir parmetros de configuracin del gestor de bases de datos o de la base de datos v API sqlegins - Obtener instancia actual v API sqlectnd - Catalogar una entrada en el directorio de nodos v API sqlenops - Iniciar una exploracin del directorio de nodos v API sqlengne - Obtener la entrada siguiente del directorio de nodos v API sqlencl - Finalizar una exploracin del directorio de nodos v API sqleuncn - Descatalogar una entrada del directorio de nodos v API sqlecadb - Catalogar una base de datos del directorio de bases de datos del sistema v API db2DbDirOpenScan - Iniciar una exploracin del directorio de bases de datos locales o del sistema v API db2DbDirGetNextEntry - Obtener la entrada siguiente del directorio de bases de datos locales o del sistema v API sqledcgd - Cambiar un comentario de base de datos en el directorio de bases de datos locales o del sistema v API db2DbDirCloseScan - Finalizar una exploracin del directorio de bases de datos locales o del sistema v API sqleuncd - Descatalogar una base de datos del directorio de bases de datos del sistema v API sqlegdad - Catalogar una base de datos en el directorio de DCS (servicios de conexin de base de datos) v API sqlegdcl - Iniciar una exploracin del directorio de DCS (servicios de conexin de base de datos) v API sqlegdge - Obtener una entrada especfica del directorio de DCS (servicios de conexin de base de datos) v API sqlegdgt - Obtener entradas del directorio de DCS (database connection services) v API sqlegdcl - Finalizar una exploracin del directorio de DCS (servicios de conexin de base de datos) v API sqlegdel - Descatalogar una base de datos del directorio de DCS (servicios de conexin de base de datos) v API sqlesdeg - Establecer el nivel o grado mximo de paralelismo de intraparticin para la ejecucin de sentencias de SQL instart.c, instart.C v API sqlefrc - Desconectar usuarios y aplicaciones del sistema v API db2InstanceStart - Iniciar instancia v API db2InstanceStop - Detener instancia

16


Las API de DB2Tabla 2. Programas de ejemplo de C/C++ con las API de DB2 (continuacin) Programa de ejemplo tbmove.sqc, tbmove.sqC Las API incluidas v API db2Export - Exportar datos de una base de datos v API db2Import - Importar datos a una tabla, jerarqua, apodo o vista v API sqluvqdp - Inmovilizar espacios de tabla para una tabla v API db2Load - Cargar datos en una tabla v API db2LoadQuery - Obtener el estado de una operacin de carga tbreorg.sqc, tbreorg.sqC v API db2Reorg - Reorganizar un ndice o tabla v API db2Runstats - Actualizar estadsticas sobre las caractersticas de una tabla e ndices asociados v API db2CfgGet - Obtener parmetros de configuracin del gestor de bases de datos o de la base de datos v API sqlbstpq - Obtener informacin sobre un espacio de tablas individual v API sqlbgtss - Obtener estadsticas de utilizacin del espacio de tabla v API sqlbmtsq - Obtener los datos de la consulta para todos los espacios de tabla v API sqlefmem - Liberar la memoria asignada por las API sqlbtcq y sqlbmtsq v API sqlbotsq - Abrir una consulta de espacio de tabla v API sqlbftpq - Recuperar los datos de la consulta para filas de un espacio de tabla v API sqlbctsq - Cerrar una consulta de espacio de tabla v API sqlbtcq - Obtener los datos de la consulta para todos los contenedores de espacio de tabla v API sqlbotcq - Abrir una consulta de contenedor espacio de tabla v API sqlbftcq - Recuperar los datos de la consulta para filas de un contenedor de espacio de tabla v API sqlbctcq - Cerrar una consulta de contenedor de espacio de tabla utilapi.c, utilapi.C v API sqlaintp - Obtener mensaje de error v API sqlogstt - Obtener el mensaje de SQLSTATE v API sqleatin - Conectar a instancia v API sqledtin - Desconectar de instancia utilsnap.c, utilsnap.C v API db2GetSnapshot - Obtener una instantnea del estado operacional del gestor de bases de datos v API db2MonitorSwitches - Obtener o actualizar los valores de los conmutadores del supervisor Tabla 3. Programas de ejemplo COBOL con las API de DB2 Programa de ejemplo checkerr.cbl Las API incluidas v API sqlaintp - Obtener mensaje de error v API sqlogstt - Obtener el mensaje de SQLSTATE

tscreate.sqc, tscreate.sqC tsinfo.sqc, tsinfo.sqC


17

Las API de DB2Tabla 3. Programas de ejemplo COBOL con las API de DB2 (continuacin) Programa de ejemplo client.cbl Las API incluidas v API sqleqryc - Consultar valores de conexin del cliente v API sqlesetc - Definir valores de conexin del cliente db_udcs.cbl v API sqleatin - Conectar a instancia v API sqlecrea - Crear base de datos v API sqledrpd - Eliminar base de datos dbcat.cbl v API sqlecadb - Catalogar una base de datos del directorio de bases de datos del sistema v API db2DbDirCloseScan - Finalizar una exploracin del directorio de bases de datos locales o del sistema v API db2DbDirGetNextEntry - Obtener la entrada siguiente del directorio de bases de datos locales o del sistema v API db2DbDirOpenScan - Iniciar una exploracin del directorio de bases de datos locales o del sistema v API sqleuncd - Descatalogar una base de datos del directorio de bases de datos del sistema dbcmt.cbl v API sqledcgd - Cambiar un comentario de base de datos en el directorio de bases de datos locales o del sistema v API db2DbDirCloseScan - Finalizar una exploracin del directorio de bases de datos locales o del sistema v API db2DbDirGetNextEntry - Obtener la entrada siguiente del directorio de bases de datos locales o del sistema v API db2DbDirOpenScan - Iniciar una exploracin del directorio de bases de datos locales o del sistema v API sqleisi - Instalar gestor de seales dbinst.cbl v API sqleatcp - Conectar a instancia y cambiar contrasea v API sqleatin - Conectar a instancia v API sqledtin - Desconectar de instancia v API sqlegins - Obtener instancia actual dbstat.sqb v API db2Reorg - Reorganizar un ndice o tabla v API db2Runstats - Actualizar estadsticas sobre las caractersticas de una tabla e ndices asociados dcscat.cbl v API sqlegdad - Catalogar una base de datos en el directorio de DCS (servicios de conexin de base de datos) v API sqlegdcl - Finalizar una exploracin del directorio de DCS (servicios de conexin de base de datos) v API sqlegdel - Descatalogar una base de datos del directorio de DCS (servicios de conexin de base de datos) v API sqlegdge - Obtener una entrada especfica del directorio de DCS (servicios de conexin de base de datos) v API sqlegdgt - Obtener entradas del directorio de DCS (database connection services) v API sqlegdcl - Iniciar una exploracin del directorio de DCS (servicios de conexin de base de datos)

18


Las API de DB2Tabla 3. Programas de ejemplo COBOL con las API de DB2 (continuacin) Programa de ejemplo ebcdicdb.cbl Las API incluidas v API sqleatin - Conectar a instancia v API sqlecrea - Crear base de datos v API sqledrpd - Eliminar base de datos expsamp.sqb v API db2Export - Exportar datos de una base de datos v API db2Import - Importar datos a una tabla, jerarqua, apodo o vista impexp.sqb v API db2Export - Exportar datos de una base de datos v API db2Import - Importar datos a una tabla, jerarqua, apodo o vista loadqry.sqb migrate.cbl nodecat.cbl v API db2LoadQuery - Obtener el estado de una operacin de carga v API sqlemgdb - Migrar versin anterior de base de datos DB2 a la versin actual v API sqlectnd - Catalogar una entrada en el directorio de nodos v API sqlencl - Finalizar una exploracin del directorio de nodos v API sqlengne - Obtener la entrada siguiente del directorio de nodos v API sqlenops - Iniciar una exploracin del directorio de nodos v API sqleuncn - Descatalogar una entrada del directorio de nodos rebind.sqb tabscont.sqb v API sqlarbnd - Volver a vincular paquete v API sqlbctcq - Cerrar una consulta de contenedor de espacio de tabla v API sqlbftcq - Recuperar los datos de la consulta para filas de un contenedor de espacio de tabla v API sqlbotcq - Abrir una consulta de contenedor espacio de tabla v API sqlbtcq - Obtener los datos de la consulta para todos los contenedores de espacio de tabla v API sqlefmem - Liberar la memoria asignada por las API sqlbtcq y sqlbmtsq tabspace.sqb v API sqlbctsq - Cerrar una consulta de espacio de tabla v API sqlbftpq - Recuperar los datos de la consulta para filas de un espacio de tabla v API sqlbgtss - Obtener estadsticas de utilizacin del espacio de tabla v API sqlbmtsq - Obtener los datos de la consulta para todos los espacios de tabla v API sqlbotsq - Abrir una consulta de espacio de tabla v sqlbstpq API - Obtener informacin sobre un espacio de tablas individual v API sqlefmem - Liberar la memoria asignada por las API sqlbtcq y sqlbmtsq tload.sqb v API db2Export - Exportar datos de una base de datos v API sqluvqdp - Inmovilizar espacios de tabla para una tabla


19

Las API de DB2Tabla 3. Programas de ejemplo COBOL con las API de DB2 (continuacin) Programa de ejemplo tspace.sqb Las API incluidas v API sqlbctcq - Cerrar una consulta de contenedor de espacio de tabla v API sqlbctsq - Cerrar una consulta de espacio de tabla v API sqlbftcq - Recuperar los datos de la consulta para filas de un contenedor de espacio de tabla v API sqlbftpq - Recuperar los datos de la consulta para filas de un espacio de tabla v API sqlbgtss - Obtener estadsticas de utilizacin del espacio de tabla v API sqlbmtsq - Obtener los datos de la consulta para todos los espacios de tabla v API sqlbotcq - Abrir una consulta de contenedor espacio de tabla v API sqlbotsq - Abrir una consulta de espacio de tabla v API sqlbstpq - Obtener informacin sobre un espacio de tablas individual v API sqlbstsc - Definir contenedores de espacio de tabla v API sqlbtcq - Obtener los datos de la consulta para todos los contenedores de espacio de tabla v API sqlefmem - Liberar la memoria asignada por las API sqlbtcq y sqlbmtsq setact.cbl v API sqlesact - Establecer informacin de contabilidad

Conceptos relacionados: v Llamada a las API DB2 en REXX en la pgina 811 Tareas relacionadas: v Creacin de aplicaciones en C o C++ utilizando el script de creacin de ejemplo (UNIX) en Desarrollo de aplicaciones de SQL incorporado v Creacin de aplicaciones de SQL incorporado y de API de DB2 para C o C++ utilizando los archivos de configuracin (AIX) en Desarrollo de aplicaciones de SQL incorporado v Creacin de aplicaciones IBM COBOL en AIX en Desarrollo de aplicaciones de SQL incorporado v Creacin de aplicaciones Micro Focus COBOL para UNIX en Desarrollo de aplicaciones de SQL incorporado Informacin relacionada: v Ejemplos de COBOL en Temas de ejemplos v Opciones de compilacin y enlace de aplicaciones C de HP-UX en Desarrollo de aplicaciones de SQL incorporado v Opciones de compilacin y enlace de aplicaciones IBM COBOL de AIX en Desarrollo de aplicaciones de SQL incorporado v Opciones de compilacin y enlace de aplicaciones Micro Focus COBOL de AIX en Desarrollo de aplicaciones de SQL incorporado v Ejemplos de C en Temas de ejemplos

20


Las API de DB2v Opciones de compilacin y enlace para aplicaciones de SQL incorporado en C y aplicaciones de la API de DB2 en AIX en Desarrollo de aplicaciones de SQL incorporado v Opciones de compilacin y enlace para aplicaciones de SQL incorporado en C ++ y aplicaciones de la API administrativa de DB2 en AIX en Desarrollo de aplicaciones de SQL incorporado v Opciones de compilacin y enlace de aplicaciones C++ de HP-UX en Desarrollo de aplicaciones de SQL incorporado v Archivos de inclusin para aplicaciones de las API de DB2 en la pgina 22 v Opciones de compilacin y enlace de aplicaciones Micro Focus COBOL de HP-UX en Desarrollo de aplicaciones de SQL incorporado v Archivos include para las aplicaciones de SQL incorporado para C++ en Desarrollo de aplicaciones de SQL incorporado v Archivos include para las aplicaciones de SQL incorporado para COBOL en Desarrollo de aplicaciones de SQL incorporado v Opciones de compilacin y enlace de aplicaciones C de Linux en Desarrollo de aplicaciones de SQL incorporado v Opciones de compilacin y enlace de aplicaciones C++ de Linux en Desarrollo de aplicaciones de SQL incorporado v Opciones de compilacin y enlace de aplicaciones Micro Focus COBOL de Linux en Desarrollo de aplicaciones de SQL incorporado v Ejemplos de REXX en Temas de ejemplos v Opciones de compilacin y enlace de aplicaciones C de Solaris en Desarrollo de aplicaciones de SQL incorporado v Opciones de compilacin y enlace de aplicaciones C++ de Solaris en Desarrollo de aplicaciones de SQL incorporado v Opciones de compilacin y enlace de aplicaciones Micro Focus COBOL de Solaris en Desarrollo de aplicaciones de SQL incorporado


21

Las API de DB2

Archivos de inclusin para aplicaciones de las API de DB2A continuacin se describen los archivos de inclusin que estn pensados para ser utilizados en aplicaciones C, C++, COBOL y FORTRAN del usuario para invocar las API de DB2: Archivos de inclusin para C y C++ DB2APIDF (db2ApiDf.h) Este archivo define estructuras, constantes y prototipos para casi todas las API de DB2 cuyos nombres comienzan por db2. DB2AUCFG (db2AuCfg.h) Este archivo define estructuras, constantes y prototipos para las API de DB2, db2AutoConfig y db2AutoConfigFreeMemory. DB2SECPLUGIN (db2secPlugin.h) Este archivo define estructuras, constantes y prototipos para las API utilizadas para desarrollar plugins de seguridad personalizados con fines de autentificacin y bsqueda de miembros de grupos. SQL (sql.h) Este archivo incluye prototipos especficos del lenguaje para el vinculador, el precompilador y las API de recuperacin de mensajes de error. Tambin define constantes del sistema.

SQLAPREP (sqlaprep.h) Este archivo contiene definiciones necesarias para escribir su propio precompilador. SQLENV (sqlenv.h) Este archivo define llamadas especficas del lenguaje para las API del entorno de bases de datos y las estructuras, constantes y cdigos de retorno correspondientes a dichas interfaces. SQLMON (sqlmon.h) Este archivo define llamadas especficas del lenguaje para las API del supervisor del sistema de bases de datos y las estructuras, constantes y cdigos de retorno correspondientes a dichas interfaces. SQLUTIL (sqlutil.h) Este archivo define las llamadas especficas del lenguaje correspondientes a las API de programas de utilidad y las estructuras, constantes y cdigos necesarios para dichas interfaces. SQLUVEND (sqluvend.h) Este archivo define estructuras, constantes y prototipos correspondientes a las API que utilizarn los proveedores de gestin de almacenamiento. SQLXA (sqlxa.h) Este archivo contiene prototipos y constantes de funciones utilizados por las aplicaciones que usan la Interfaz XA de X/Open. Archivos de inclusin para COBOL SQL (sql.cbl) Este archivo incluye prototipos especficos del lenguaje para el vinculador, el precompilador y las API de recuperacin de mensajes de error. Tambin define constantes del sistema.

22


Las API de DB2SQLAPREP (sqlaprep.cbl) Este archivo contiene definiciones necesarias para escribir su propio precompilador. SQLENV (sqlenv.cbl) Este archivo define llamadas especficas del lenguaje para las API del entorno de bases de datos y las estructuras, constantes y cdigos de retorno correspondientes a dichas interfaces. SQLMON (sqlmon.cbl) Este archivo define llamadas especficas del lenguaje para las API del supervisor del sistema de bases de datos y las estructuras, constantes y cdigos de retorno correspondientes a dichas interfaces. SQLMONCT (sqlmonct.cbl) Este archivo contiene definiciones de constantes y definiciones de estructuras de datos locales necesarias para llamar a las API del Supervisor del sistema de bases de datos. SQLUTIL (sqlutil.cbl) Este archivo define las llamadas especficas del lenguaje correspondientes a las API de programas de utilidad y las estructuras, constantes y cdigos necesarios para dichas interfaces. Archivos de inclusin para FORTRAN SQL (sql.f) Este archivo incluye prototipos especficos del lenguaje para el vinculador, el precompilador y las API de recuperacin de mensajes de error. Tambin define constantes del sistema.

SQLAPREP (sqlaprep.f) Este archivo contiene definiciones necesarias para escribir su propio precompilador. SQLENV (sqlenv.f) Este archivo define llamadas especficas del lenguaje para las API del entorno de bases de datos y las estructuras, constantes y cdigos de retorno correspondientes a dichas interfaces. SQLMON (sqlmon.f) Este archivo define llamadas especficas del lenguaje para las API del supervisor del sistema de bases de datos y las estructuras, constantes y cdigos de retorno correspondientes a dichas interfaces. SQLUTIL (sqlutil.f) Este archivo define las llamadas especficas del lenguaje correspondientes a las API de programas de utilidad y las estructuras, constantes y cdigos necesarios para dichas interfaces. Informacin relacionada: v Las API de DB2 en la pgina 1


23

Cmo estn organizadas las descripciones de las API

Cmo estn organizadas las descripciones de las APIAlgunas o todas las secciones siguientes estn precedidas por una breve descripcin de cada API. mbito: mbito de operacin de la API dentro de la instancia. En un entorno de base de datos de una sola particin, el mbito es esa particin de base de datos solamente. En un entorno de base de datos particionada, el mbito puede ser el conjunto de todos los servidores de particiones lgicas de base de datos definidos en el archivo de configuracin de nodos (db2nodes.cfg) o la particin de base de datos desde la que se invoca la API. Autorizacin: Autorizacin necesaria para invocar la API satisfactoriamente. Conexin necesaria: Una de las siguientes: base de datos, instancia, ninguna o establece una conexin. Indica si la funcin necesita una conexin de base de datos, una conexin de instancia o ninguna conexin para operar satisfactoriamente. Ninguna significa que no es necesaria ninguna conexin de base de datos para que la API trabaje satisfactoriamente. Establece una conexin significa que la API establecer una conexin con la base de datos cuando se invoque la API. Puede ser necesaria una conexin explcita con la base de datos o una conexin con la instancia para poder invocar una API determinada. Las API que necesitan una conexin de base de datos o una conexin de instancia se pueden ejecutar de forma local o remota. Las API que no necesitan ninguna de las dos conexiones no se pueden ejecutar de forma remota; cuando estas API se invocan desde el cliente, afectan al entorno del cliente solamente. Archivo de inclusin de la API: Nombre del archivo de inclusin donde estn contenidos el prototipo de API, y las constantes y parmetros predefinidos que sean necesarios. Nota: Las extensiones de los archivos de inclusin varan segn el lenguaje de programacin. Los archivos de inclusin de C/C++ tienen la extensin de archivo .h. Los archivos de inclusin de COBOL tienen la extensin de archivo .cbl. Los archivos de inclusin 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

24


Cmo estn organizadas las descripciones de las APICOBOL (Windows): sqllib\include\cobol_a sqllib\include\cobol_i sqllib\include\cobol_mf Sintaxis de la API para C: Sintaxis de la llamada a la API para el lenguaje C. A partir de la Versin 6, se aplica un nuevo estndar a las API administrativas de DB2. La aplicacin de las nuevas definiciones de API se realiza de forma gradual. A continuacin sigue una breve visin general de los cambios: v Los nuevos nombres de las API contienen el prefijo db2, seguido de una serie, en maysculas y minsculas, que sea descriptiva (por ejemplo, db2LoadQuery). Las API que son afines entre s tienen nombres que permiten agruparlas segn criterios lgicos. Por ejemplo:db2HistoryCloseScan db2HistoryGetEntry db2HistoryOpenScan db2HistoryUpdate

v Las API genricas tienen nombres que contienen el prefijo db2g, seguido de una serie que coincide con el nombre de la API para C. Las estructuras de datos utilizadas por las API genricas tienen nombres que tambin contienen el prefijo db2g. v El primer parmetro dentro de la funcin, el nmero de versin, (versionNumber) representa la versin, el release o nivel de PTF para el que se debe compilar el cdigo. Este nmero de versin se utiliza para especificar el nivel de la estructura que se pasa como segundo parmetro. v El segundo parmetro dentro de la funcin es un puntero nulo que apunta a la estructura de interfaz primaria de la API. Cada elemento de la estructura es un tipo atmico (por ejemplo, db2Long32) o un puntero. Cada nombre de parmetro se ajusta a los siguientes convenios de denominacin:piCamelCase poCamelCase pioCamelCase iCamelCase ioCamelCase oCamelCase puntero para datos de entrada puntero para datos de salida puntero para datos de entrada o de salida datos de entrada datos de entrada/salida datos de salida

v El tercer parmetro es un puntero a la SQLCA, y es obligatorio. Sintaxis de la API genrica: Sintaxis de la llamada a la API para los lenguajes de programacin COBOL y FORTRAN. Atencin: Proporcione un byte adicional para cada serie transferida a una API; de lo contrario, se pueden producir errores inesperados. Este byte adicional es modificado por el gestor de bases de datos. Parmetros de la API: Descripcin de cada parmetro de la API y de sus valores. Aparecen listados los valores predefinidos junto con los smbolos apropiados. Los valores reales de los smbolos se pueden obtener a partir de los archivos de inclusin del lenguaje apropiado. Los programadores de COBOL debe utilizar un guin (-) en lugar deCaptulo 1. Las API de DB2

25

Cmo estn organizadas las descripciones de las APIun signo de subrayado (_) en todos los smbolos. Para obtener ms informacin sobre los tipos de datos de parmetros en cada lenguaje principal, consulte los programas de ejemplo. Nota: Las aplicaciones que invocan a las API del gestor de bases de datos deben comprobar debidamente si existen condiciones de error examinando cdigos de retorno y la estructura SQLCA. La mayora de las API del gestor de bases de datos devuelven el cdigo de retorno 0 cuando se ejecutan satisfactoriamente. En general, un cdigo de retorno distinto de cero indica que el mecanismo de manejo de errores secundarios, la estructura SQLCA, puede estar daado. En este caso, la API llamada no se ejecuta. Una posible razn de que se dae la estructura SQLCA es que se haya pasado una direccin no vlida para la estructura. La informacin de error se devuelve en los campos SQLCODE y SQLSTATE de la estructura SQLCA, que se actualiza despus de la mayora de las llamadas a las API del gestor de bases de datos. Los archivos fuente que invocan a las API del gestor de bases de datos pueden proporcionar una o ms estructuras SQLCA; sus nombres son arbitrarios. Un valor de SQLCODE igual a 0 significa ejecucin satisfactoria (con posibles condiciones de aviso SQLWARN). Un valor positivo significa que la sentencia se ha ejecutado satisfactoriamente, pero con un aviso, tal como el truncamiento de una variable de lenguaje principal. Un valor negativo significa que se ha producido una condicin de error. Un campo adicional, SQLSTATE, contiene un cdigo de error estandarizado que es coherente con otros productos de bases de datos de IBM y con gestores de bases de datos compatibles con SQL92. Utilice los campos SQLSTATE cuando sea necesario asegurar la portabilidad, pues los SQLSTATE son comunes a muchos gestores de bases de datos. El campo SQLWARN contiene una matriz de indicadores de aviso, incluso si SQLCODE es cero. Sintaxis de la API para REXX: Sintaxis para REXX de la llamada a la API, cuando sea apropiado. La interfaz SQLDB2 permite la invocacin de una API desde REXX. La interfaz SQLDB2 se cre para poder utilizar en REXX nuevas API o APIs que no eran compatibles anteriormente cuya nica informacin de salida es la SQLCA. Invocar un mandato mediante la interfaz SQLDB2 es sintcticamente lo mismo que invocar el mandato mediante el procesador de lnea de mandatos (CLP), excepto que el smbolo call db2 se sustituye por CALL SQLDB2. Utilizar CALL SQLDB2 desde REXX tiene las ventajas siguientes respecto a llamar directamente al CLP: v La variable compuesta SQLCA de REXX est definida v Por omisin, todos los mensajes de salida del CLP estn desactivados. Parmetros de la API para REXX: Descripcin de cada parmetro de la API para REXX y de sus valores, cuando sea apropiado. Notas de uso:

26


Cmo estn organizadas las descripciones de las APIInformacin adicional. Informacin relacionada: v Las API de DB2 en la pgina 1


27

db2AddContact - Aadir un contacto al que se pueden enviar mensajes de notificacin

db2AddContact - Aadir un contacto al que se pueden enviar mensajes de notificacinAade un contacto a la lista de contactos. Los contactos son usuarios a los que se pueden enviar mensajes de notificacin. Los contactos pueden estar definidos localmente en el sistema o en una lista global. El valor del parmetro de configuracin contact_host del servidor DAS (DB2 administration server) determina si la lista es local o global. Autorizacin: Ninguna Conexin necesaria: Ninguna Archivo de inclusin de la API:db2ApiDf.h

Sintaxis de la API y de las estructuras de datos:SQL_API_RC SQL_API_FN db2AddContact ( db2Uint32 versionNumber, void * pParmStruct, struct sqlca * pSqlca); typedef SQL_STRUCTURE db2AddContactData { char *piUserid; char *piPassword; char *piName; db2Uint32 iType; char *piAddress; db2Uint32 iMaxPageLength; char *piDescription; } db2AddContactData;

Parmetros de la API db2AddContact: versionNumber Entrada. Especifica la versin y nivel de release de la estructura transferida como segundo parmetro, pParmStruct. pParmStruct Entrada. Puntero a la estructura db2AddContactData. pSqlca Salida. Puntero a la estructura sqlca. Parmetros de la estructura de datos db2AddContactData: piUserid Entrada. Nombre del usuario. piPassword Entrada. Contrasea del ID de usuario especificado por el parmetro piUserid.

28


db2AddContact - Aadir un contacto al que se pueden enviar mensajes de notificacinpiName Entrada. Nombre del contacto. iType Entrada. Especifica el tipo de contacto. Los valores vlidos son: v DB2CONTACT_EMAIL v DB2CONTACT_PAGE

piAddress Entrada. Direccin de correo electrnico o buscapersonas del parmetro iType. iMaxPageLength Entrada. Longitud mxima del mensaje cuando el valor de iType es DB2CONTACT_PAGE. piDescription Entrada. Descripcin del contacto proporcionada por el usuario. Notas de uso: Esta API no est soportada en UNIX y Linux. No obstante, podr acceder a la misma funcin utilizando la interfaz de SQL. Tareas relacionadas: v Enabling health alert notification en System Monitor Guide and Reference Informacin relacionada: v Mandato ADD CONTACT en Consulta de mandatos v db2DropContact - Eliminar un contacto de la lista de contactos a los que se pueden enviar mensajes de notificacin en la pgina 82 v db2GetContacts - Obtener la lista de contactos a los que se puedan enviar mensajes de notificacin en la pgina 111 v db2UpdateContact - Actualizar los atributos de un contacto en la pgina 361 v SQLCA en la pgina 565 v contact_host - Location of contact list configuration parameter en Performance Guide v db2AddContactGroup - Aadir un grupo de contactos al que se pueden enviar mensajes de notificacin en la pgina 30 v Mandato ADD CONTACT utilizando el procedimiento ADMIN_CMD en Vistas y rutinas de administracin de SQL


29

db2AddContactGroup - Aadir un grupo de contactos al que se pueden enviar mensajes de notificacin

db2AddContactGroup - Aadir un grupo de contactos al que se pueden enviar mensajes de notificacinAade un nuevo grupo de contactos a la lista de grupos de contactos. Un grupo de contactos contiene una lista de usuarios a los que se pueden enviar mensajes de notificacin. Los grupos de contactos pueden estar definidos localmente en

Consulta de Las API Administrativas

Documents