Administrative API Reference

Using the DB2 Library

Partial Table-of-Contents

  • DB2 PDF Files and Printed Books
  • DB2 Information
  • Printing the PDF Books
  • Ordering the Printed Books
  • DB2 Online Documentation
  • Accessing Online Help
  • Viewing Information Online
  • Using DB2 Wizards
  • Setting Up a Document Server
  • Searching Information Online
  • The DB2 Universal Database library consists of online help, books (PDF and HTML), and sample programs in HTML format. This section describes the information that is provided, and how you can access it.

    To access product information online, you can use the Information Center. For more information, see Accessing Information with the Information Center. You can view task information, DB2 books, troubleshooting information, sample programs, and DB2 information on the Web.

    DB2 PDF Files and Printed Books

    DB2 Information

    The following table divides the DB2 books into four categories:

    DB2 Guide and Reference Information
    These books contain the common DB2 information for all platforms.

    DB2 Installation and Configuration Information
    These books are for DB2 on a specific platform. For example, there are separate Quick Beginnings books for DB2 on OS/2, Windows, and UNIX-based platforms.

    Cross-platform sample programs in HTML
    These samples are the HTML version of the sample programs that are installed with the Application Development Client. The samples are for informational purposes and do not replace the actual programs.

    Release notes
    These files contain late-breaking information that could not be included in the DB2 books.

    The installation manuals, release notes, and tutorials are viewable in HTML directly from the product CD-ROM. Most books are available in HTML on the product CD-ROM for viewing and in Adobe Acrobat (PDF) format on the DB2 publications CD-ROM for viewing and printing. You can also order a printed copy from IBM; see Ordering the Printed Books. The following table lists books that can be ordered.

    On OS/2 and Windows platforms, you can install the HTML files under the sqllib\doc\html directory. DB2 information is translated into different languages; however, all the information is not translated into every language. Whenever information is not available in a specific language, the English information is provided

    On UNIX platforms, you can install multiple language versions of the HTML files under the doc/%L/html directories, where %L represents the locale. For more information, refer to the appropriate Quick Beginnings book.

    You can obtain DB2 books and access information in a variety of ways:


    Table 144. DB2 Information
    Name Description Form Number

    PDF File Name

    HTML Directory
    DB2 Guide and Reference Information
    Administration Guide Administration Guide: Planning provides an overview of database concepts, information about design issues (such as logical and physical database design), and a discussion of high availability.

    Administration Guide: Implementation provides information on implementation issues such as implementing your design, accessing databases, auditing, backup and recovery.

    Administration Guide: Performance provides information on database environment and application performance evaluation and tuning.

    You can order the three volumes of the Administration Guide in the English language in North America using the form number SBOF-8934.


    SC09-2946
    db2d1x70







    SC09-2944
    db2d2x70






    SC09-2945
    db2d3x70



    db2d0
    Administrative API Reference Describes the DB2 application programming interfaces (APIs) and data structures that you can use to manage your databases. This book also explains how to call APIs from your applications. SC09-2947

    db2b0x70

    db2b0
    Application Building Guide Provides environment setup information and step-by-step instructions about how to compile, link, and run DB2 applications on Windows, OS/2, and UNIX-based platforms. SC09-2948

    db2axx70

    db2ax
    APPC, CPI-C, and SNA Sense Codes Provides general information about APPC, CPI-C, and SNA sense codes that you may encounter when using DB2 Universal Database products.

    Available in HTML format only.

    No form number

    db2apx70

    db2ap
    Application Development Guide Explains how to develop applications that access DB2 databases using embedded SQL or Java (JDBC and SQLJ). Discussion topics include writing stored procedures, writing user-defined functions, creating user-defined types, using triggers, and developing applications in partitioned environments or with federated systems. SC09-2949

    db2a0x70

    db2a0
    CLI Guide and Reference Explains how to develop applications that access DB2 databases using the DB2 Call Level Interface, a callable SQL interface that is compatible with the Microsoft ODBC specification. SC09-2950

    db2l0x70

    db2l0
    Command Reference Explains how to use the Command Line Processor and describes the DB2 commands that you can use to manage your database. SC09-2951

    db2n0x70

    db2n0
    Connectivity Supplement Provides setup and reference information on how to use DB2 for AS/400, DB2 for OS/390, DB2 for MVS, or DB2 for VM as DRDA application requesters with DB2 Universal Database servers. This book also details how to use DRDA application servers with DB2 Connect application requesters.

    Available in HTML and PDF only.

    No form number

    db2h1x70

    db2h1
    Data Movement Utilities Guide and Reference Explains how to use DB2 utilities, such as import, export, load, AutoLoader, and DPROP, that facilitate the movement of data. SC09-2955

    db2dmx70

    db2dm
    Data Warehouse Center Administration Guide Provides information on how to build and maintain a data warehouse using the Data Warehouse Center. SC26-9993

    db2ddx70

    db2dd
    Data Warehouse Center Application Integration Guide Provides information to help programmers integrate applications with the Data Warehouse Center and with the Information Catalog Manager. SC26-9994

    db2adx70

    db2ad
    DB2 Connect User's Guide Provides concepts, programming, and general usage information for the DB2 Connect products. SC09-2954

    db2c0x70

    db2c0
    DB2 Query Patroller Administration Guide Provides an operational overview of the DB2 Query Patroller system, specific operational and administrative information, and task information for the administrative graphical user interface utilities. SC09-2958

    db2dwx70

    db2dw
    DB2 Query Patroller User's Guide Describes how to use the tools and functions of the DB2 Query Patroller. SC09-2960

    db2wwx70

    db2ww
    Glossary Provides definitions for terms used in DB2 and its components.

    Available in HTML format and in the SQL Reference.

    No form number

    db2t0x70

    db2t0
    Image, Audio, and Video Extenders Administration and Programming Provides general information about DB2 extenders, and information on the administration and configuration of the image, audio, and video (IAV) extenders and on programming using the IAV extenders. It includes reference information, diagnostic information (with messages), and samples. SC26-9929

    dmbu7x70

    dmbu7
    Information Catalog Manager Administration Guide Provides guidance on managing information catalogs. SC26-9995

    db2dix70

    db2di
    Information Catalog Manager Programming Guide and Reference Provides definitions for the architected interfaces for the Information Catalog Manager. SC26-9997

    db2bix70

    db2bi
    Information Catalog Manager User's Guide Provides information on using the Information Catalog Manager user interface. SC26-9996

    db2aix70

    db2ai
    Installation and Configuration Supplement Guides you through the planning, installation, and setup of platform-specific DB2 clients. This supplement also contains information on binding, setting up client and server communications, DB2 GUI tools, DRDA AS, distributed installation, the configuration of distributed requests, and accessing heterogeneous data sources. GC09-2957

    db2iyx70

    db2iy
    Message Reference Lists messages and codes issued by DB2, the Information Catalog Manager, and the Data Warehouse Center, and describes the actions you should take.

    You can order both volumes of the Message Reference in the English language in North America with the form number SBOF-8932.


    Volume 1
    GC09-2978

    db2m1x70



    Volume 2
    GC09-2979

    db2m2x70

    db2m0
    OLAP Integration Server Administration Guide Explains how to use the Administration Manager component of the OLAP Integration Server. SC27-0787

    db2dpx70

    n/a
    OLAP Integration Server Metaoutline User's Guide Explains how to create and populate OLAP metaoutlines using the standard OLAP Metaoutline interface (not by using the Metaoutline Assistant). SC27-0784

    db2upx70

    n/a
    OLAP Integration Server Model User's Guide Explains how to create OLAP models using the standard OLAP Model Interface (not by using the Model Assistant). SC27-0783

    db2lpx70

    n/a
    OLAP Setup and User's Guide Provides configuration and setup information for the OLAP Starter Kit. SC27-0702

    db2ipx70

    db2ip
    OLAP Spreadsheet Add-in User's Guide for Excel Describes how to use the Excel spreadsheet program to analyze OLAP data. SC27-0786

    db2epx70

    db2ep
    OLAP Spreadsheet Add-in User's Guide for Lotus 1-2-3 Describes how to use the Lotus 1-2-3 spreadsheet program to analyze OLAP data. SC27-0785

    db2tpx70

    db2tp
    Replication Guide and Reference Provides planning, configuration, administration, and usage information for the IBM Replication tools supplied with DB2. SC26-9920

    db2e0x70

    db2e0
    Spatial Extender User's Guide and Reference Provides information about installing, configuring, administering, programming, and troubleshooting the Spatial Extender. Also provides significant descriptions of spatial data concepts and provides reference information (messages and SQL) specific to the Spatial Extender. SC27-0701

    db2sbx70

    db2sb
    SQL Getting Started Introduces SQL concepts and provides examples for many constructs and tasks. SC09-2973

    db2y0x70

    db2y0
    SQL Reference, Volume 1 and Volume 2 Describes SQL syntax, semantics, and the rules of the language. This book also includes information about release-to-release incompatibilities, product limits, and catalog views.

    You can order both volumes of the SQL Reference in the English language in North America with the form number SBOF-8933.

    Volume 1 SC09-2974

    db2s1x70


    Volume 2 SC09-2975

    db2s2x70

    db2s0
    System Monitor Guide and Reference Describes how to collect different kinds of information about databases and the database manager. This book explains how to use the information to understand database activity, improve performance, and determine the cause of problems. SC09-2956

    db2f0x70

    db2f0
    Text Extender Administration and Programming Provides general information about DB2 extenders and information on the administration and configuring of the text extender and on programming using the text extenders. It includes reference information, diagnostic information (with messages) and samples. SC26-9930

    desu9x70

    desu9
    Troubleshooting Guide Helps you determine the source of errors, recover from problems, and use diagnostic tools in consultation with DB2 Customer Service. GC09-2850

    db2p0x70

    db2p0
    What's New Describes the new features, functions, and enhancements in DB2 Universal Database, Version 7. SC09-2976

    db2q0x70

    db2q0
    DB2 Installation and Configuration Information
    DB2 Connect Enterprise Edition for OS/2 and Windows Quick Beginnings Provides planning, migration, installation, and configuration information for DB2 Connect Enterprise Edition on the OS/2 and Windows 32-bit operating systems. This book also contains installation and setup information for many supported clients. GC09-2953

    db2c6x70

    db2c6
    DB2 Connect Enterprise Edition for UNIX Quick Beginnings Provides planning, migration, installation, configuration, and task information for DB2 Connect Enterprise Edition on UNIX-based platforms. This book also contains installation and setup information for many supported clients. GC09-2952

    db2cyx70

    db2cy
    DB2 Connect Personal Edition Quick Beginnings Provides planning, migration, installation, configuration, and task information for DB2 Connect Personal Edition on the OS/2 and Windows 32-bit operating systems. This book also contains installation and setup information for all supported clients. GC09-2967

    db2c1x70

    db2c1
    DB2 Connect Personal Edition Quick Beginnings for Linux Provides planning, installation, migration, and configuration information for DB2 Connect Personal Edition on all supported Linux distributions. GC09-2962

    db2c4x70

    db2c4
    DB2 Data Links Manager Quick Beginnings Provides planning, installation, configuration, and task information for DB2 Data Links Manager for AIX and Windows 32-bit operating systems. GC09-2966

    db2z6x70

    db2z6
    DB2 Enterprise - Extended Edition for UNIX Quick Beginnings Provides planning, installation, and configuration information for DB2 Enterprise - Extended Edition on UNIX-based platforms. This book also contains installation and setup information for many supported clients. GC09-2964

    db2v3x70

    db2v3
    DB2 Enterprise - Extended Edition for Windows Quick Beginnings Provides planning, installation, and configuration information for DB2 Enterprise - Extended Edition for Windows 32-bit operating systems. This book also contains installation and setup information for many supported clients. GC09-2963

    db2v6x70

    db2v6
    DB2 for OS/2 Quick Beginnings Provides planning, installation, migration, and configuration information for DB2 Universal Database on the OS/2 operating system. This book also contains installation and setup information for many supported clients. GC09-2968

    db2i2x70

    db2i2
    DB2 for UNIX Quick Beginnings Provides planning, installation, migration, and configuration information for DB2 Universal Database on UNIX-based platforms. This book also contains installation and setup information for many supported clients. GC09-2970

    db2ixx70

    db2ix
    DB2 for Windows Quick Beginnings Provides planning, installation, migration, and configuration information for DB2 Universal Database on Windows 32-bit operating systems. This book also contains installation and setup information for many supported clients. GC09-2971

    db2i6x70

    db2i6
    DB2 Personal Edition Quick Beginnings Provides planning, installation, migration, and configuration information for DB2 Universal Database Personal Edition on the OS/2 and Windows 32-bit operating systems. GC09-2969

    db2i1x70

    db2i1
    DB2 Personal Edition Quick Beginnings for Linux Provides planning, installation, migration, and configuration information for DB2 Universal Database Personal Edition on all supported Linux distributions. GC09-2972

    db2i4x70

    db2i4
    DB2 Query Patroller Installation Guide Provides installation information about DB2 Query Patroller. GC09-2959

    db2iwx70

    db2iw
    DB2 Warehouse Manager Installation Guide Provides installation information for warehouse agents, warehouse transformers, and the Information Catalog Manager. GC26-9998

    db2idx70

    db2id
    Cross-Platform Sample Programs in HTML
    Sample programs in HTML Provides the sample programs in HTML format for the programming languages on all platforms supported by DB2. The sample programs are provided for informational purposes only. Not all samples are available in all programming languages. The HTML samples are only available when the DB2 Application Development Client is installed.

    For more information on the programs, refer to the Application Building Guide.

    No form number
    db2hs

    Release Notes
    DB2 Connect Release Notes Provides late-breaking information that could not be included in the DB2 Connect books. See note #2. db2cr
    DB2 Installation Notes Provides late-breaking installation-specific information that could not be included in the DB2 books. Available on product CD-ROM only.
    DB2 Release Notes Provides late-breaking information about all DB2 products and features that could not be included in the DB2 books. See note #2. db2ir

    Notes:

    1. The character x in the sixth position of the file name indicates the language version of a book. For example, the file name db2d0e70 identifies the English version of the Administration Guide and the file name db2d0f70 identifies the French version of the same book. The following letters are used in the sixth position of the file name to indicate the language version:
      Language Identifier

      Brazilian Portuguese b

      Bulgarian u

      Czech x

      Danish d

      Dutch q

      English e

      Finnish y

      French f

      German g

      Greek a

      Hungarian h

      Italian i

      Japanese j

      Korean k

      Norwegian n

      Polish p

      Portuguese v

      Russian r

      Simp. Chinese c

      Slovenian l

      Spanish z

      Swedish s

      Trad. Chinese t

      Turkish m

    2. Late breaking information that could not be included in the DB2 books is available in the Release Notes in HTML format and as an ASCII file. The HTML version is available from the Information Center and on the product CD-ROMs. To view the ASCII file:

    Printing the PDF Books

    If you prefer to have printed copies of the books, you can print the PDF files found on the DB2 publications CD-ROM. Using the Adobe Acrobat Reader, you can print either the entire book or a specific range of pages. For the file name of each book in the library, see Table 144.

    You can obtain the latest version of the Adobe Acrobat Reader from the Adobe Web site at http://www.adobe.com.

    The PDF files are included on the DB2 publications CD-ROM with a file extension of PDF. To access the PDF files:

    1. Insert the DB2 publications CD-ROM. On UNIX-based platforms, mount the DB2 publications CD-ROM. Refer to your Quick Beginnings book for the mounting procedures.
    2. Start the Acrobat Reader.
    3. Open the desired PDF file from one of the following locations:

    You can also copy the PDF files from the CD-ROM to a local or network drive and read them from there.

    Ordering the Printed Books

    You can order the printed DB2 books either individually or as a set (in North America only) by using a sold bill of forms (SBOF) number. To order books, contact your IBM authorized dealer or marketing representative, or phone 1-800-879-2755 in the United States or 1-800-IBM-4YOU in Canada. You can also order the books from the Publications Web page at http://www.elink.ibmlink.ibm.com/pbl/pbl.

    Two sets of books are available. SBOF-8935 provides reference and usage information for the DB2 Warehouse Manager. SBOF-8931 provides reference and usage information for all other DB2 Universal Database products and features. The contents of each SBOF are listed in the following table:

    Table 145. Ordering the printed books
    SBOF Number Books Included
    SBOF-8931
    • Administration Guide: Planning
    • Administration Guide: Implementation
    • Administration Guide: Performance
    • Administrative API Reference
    • Application Building Guide
    • Application Development Guide
    • CLI Guide and Reference
    • Command Reference
    • Data Movement Utilities Guide and Reference
    • Data Warehouse Center Administration Guide
    • Data Warehouse Center Application Integration Guide
    • DB2 Connect User's Guide
    • Installation and Configuration Supplement
    • Image, Audio, and Video Extenders Administration and Programming
    • Message Reference, Volumes 1 and 2

    • OLAP Integration Server Administration Guide
    • OLAP Integration Server Metaoutline User's Guide
    • OLAP Integration Server Model User's Guide
    • OLAP Integration Server User's Guide
    • OLAP Setup and User's Guide
    • OLAP Spreadsheet Add-in User's Guide for Excel
    • OLAP Spreadsheet Add-in User's Guide for Lotus 1-2-3
    • Replication Guide and Reference
    • Spatial Extender Administration and Programming Guide
    • SQL Getting Started
    • SQL Reference, Volumes 1 and 2
    • System Monitor Guide and Reference
    • Text Extender Administration and Programming
    • Troubleshooting Guide
    • What's New

    SBOF-8935
    • Information Catalog Manager Administration Guide
    • Information Catalog Manager User's Guide
    • Information Catalog Manager Programming Guide and Reference

    • Query Patroller Administration Guide
    • Query Patroller User's Guide

    DB2 Online Documentation

    Accessing Online Help

    Online help is available with all DB2 components. The following table describes the various types of help.
    Type of Help Contents How to Access...
    Command Help Explains the syntax of commands in the command line processor. From the command line processor in interactive mode, enter:
       ? command 
    

    where command represents a keyword or the entire command.

    For example, ? catalog displays help for all the CATALOG commands, while ? catalog database displays help for the CATALOG DATABASE command.

    Client Configuration Assistant Help

    Command Center Help

    Control Center Help

    Data Warehouse Center Help

    Event Analyzer Help

    Information Catalog Manager Help

    Satellite Administration Center Help

    Script Center Help

    Explains the tasks you can perform in a window or notebook. The help includes overview and prerequisite information you need to know, and it describes how to use the window or notebook controls. From a window or notebook, click the Help push button or press the F1 key.
    Message Help Describes the cause of a message and any action you should take. From the command line processor in interactive mode, enter:
        ? XXXnnnnn
    

    where XXXnnnnn represents a valid message identifier.

    For example, ? SQL30081 displays help about the SQL30081 message.

    To view message help one screen at a time, enter:

       ? XXXnnnnn | more
    

    To save message help in a file, enter:

       ? XXXnnnnn > filename.ext
    

    where filename.ext represents the file where you want to save the message help.

    SQL Help Explains the syntax of SQL statements. From the command line processor in interactive mode, enter:
       help statement
    

    where statement represents an SQL statement.

    For example, help SELECT displays help about the SELECT statement.
    Note:SQL help is not available on UNIX-based platforms.

    SQLSTATE Help Explains SQL states and class codes. From the command line processor in interactive mode, enter:
       ? sqlstate or ? class code
    

    where sqlstate represents a valid five-digit SQL state and class code represents the first two digits of the SQL state.

    For example, ? 08003 displays help for the 08003 SQL state, while ? 08 displays help for the 08 class code.

    Viewing Information Online

    The books included with this product are in Hypertext Markup Language (HTML) softcopy format. Softcopy format enables you to search or browse the information and provides hypertext links to related information. It also makes it easier to share the library across your site.

    You can view the online books or sample programs with any browser that conforms to HTML Version 3.2 specifications.

    To view online books or sample programs:

    Installing the Netscape Browser

    If you do not already have a Web browser installed, you can install Netscape from the Netscape CD-ROM found in the product boxes. For detailed instructions on how to install it, perform the following:

    1. Insert the Netscape CD-ROM.
    2. On UNIX-based platforms only, mount the CD-ROM. Refer to your Quick Beginnings book for the mounting procedures.
    3. For installation instructions, refer to the CDNAVnn.txt file, where nn represents your two character language identifier. The file is located at the root directory of the CD-ROM.

    Accessing Information with the Information Center

    The Information Center provides quick access to DB2 product information. The Information Center is available on all platforms on which the DB2 administration tools are available.

    You can open the Information Center by double-clicking the Information Center icon. Depending on the system you are using, the icon is in the Information folder in the main product folder or the Windows Start menu.

    You can also access the Information Center by using the toolbar and the Help menu on the DB2 Windows platform.

    The Information Center provides six types of information. Click the appropriate tab to look at the topics provided for that type.

    Tasks
    Key tasks you can perform using DB2.

    Reference
    DB2 reference information, such as keywords, commands, and APIs.

    Books
    DB2 books.

    Troubleshooting
    Categories of error messages and their recovery actions.

    Sample Programs
    Sample programs that come with the DB2 Application Development Client. If you did not install the DB2 Application Development Client, this tab is not displayed.

    Web
    DB2 information on the World Wide Web. To access this information, you must have a connection to the Web from your system.

    When you select an item in one of the lists, the Information Center launches a viewer to display the information. The viewer might be the system help viewer, an editor, or a Web browser, depending on the kind of information you select.

    The Information Center provides a find feature, so you can look for a specific topic without browsing the lists.

    For a full text search, follow the hypertext link in the Information Center to the Search DB2 Online Information search form.

    The HTML search server is usually started automatically. If a search in the HTML information does not work, you may have to start the search server using one of the following methods:

    On Windows
    Click Start and select Programs --> IBM DB2 --> Information --> Start HTML Search Server.

    On OS/2
    Double-click the DB2 for OS/2 folder, and then double-click the Start HTML Search Server icon.

    Refer to the release notes if you experience any other problems when searching the HTML information.
    Note:The Search function is not available in the Linux, PTX, and Silicon Graphics IRIX environments.

    Using DB2 Wizards

    Wizards help you complete specific administration tasks by taking you through each task one step at a time. Wizards are available through the Control Center and the Client Configuration Assistant. The following table lists the wizards and describes their purpose.
    Note:The Create Database, Create Index, Configure Multisite Update, and Performance Configuration wizards are available for the partitioned database environment.

    Wizard Helps You to... How to Access...
    Add Database Catalog a database on a client workstation. From the Client Configuration Assistant, click Add.
    Backup Database Determine, create, and schedule a backup plan. From the Control Center, right-click the database you want to back up and select Backup --> Database Using Wizard.
    Configure Multisite Update Configure a multisite update, a distributed transaction, or a two-phase commit. From the Control Center, right-click the Databases folder and select Multisite Update.
    Create Database Create a database, and perform some basic configuration tasks.

    From the Control Center, right-click the Databases folder and select Create --> Database Using Wizard.

    Create Table Select basic data types, and create a primary key for the table. From the Control Center, right-click the Tables icon and select Create --> Table Using Wizard.
    Create Table Space Create a new table space. From the Control Center, right-click the Table Spaces icon and select Create --> Table Space Using Wizard.
    Create Index Advise which indexes to create and drop for all your queries. From the Control Center, right-click the Index icon and select Create --> Index Using Wizard.
    Performance Configuration Tune the performance of a database by updating configuration parameters to match your business requirements. From the Control Center, right-click the database you want to tune and select Configure Performance Using Wizard.

    For the partitioned database environment, from the Database Partitions view, right-click the first database partition you want to tune and select Configure Performance Using Wizard.

    Restore Database Recover a database after a failure. It helps you understand which backup to use, and which logs to replay. From the Control Center, right-click the database you want to restore and select Restore --> Database Using Wizard.

    Setting Up a Document Server

    By default, the DB2 information is installed on your local system. This means that each person who needs access to the DB2 information must install the same files. To have the DB2 information stored in a single location, perform the following steps:

    1. Copy all files and subdirectories from \sqllib\doc\html on your local system to a Web server. Each book has its own subdirectory that contains all the necessary HTML and GIF files that make up the book. Ensure that the directory structure remains the same.
    2. Configure the Web server to look for the files in the new location. For information, refer to the NetQuestion Appendix in the Installation and Configuration Supplement.
    3. If you are using the Java version of the Information Center, you can specify a base URL for all HTML files. You should use the URL for the list of books.
    4. When you are able to view the book files, you can bookmark commonly viewed topics. You will probably want to bookmark the following pages:

    For information about how you can serve the DB2 Universal Database online documentation files from a central machine, refer to the NetQuestion Appendix in the Installation and Configuration Supplement.

    Searching Information Online

    To find information in the HTML files, use one of the following methods:


    [ Top of Page | Previous Page | Next Page ]