README

- INTRODUCTION
- PLATFORMS
- INSTALLATION
- RELEASE NOTES
- AUTHORS

# INTRODUCTION

Please see the INSTALLATION section below for build instructions.

This module provides access to the administrative functions of DB2 for Linux, Unix and Windows. The administrative functions are those functions not accessible through SQL, which normally require use of the DB2 command line processor (the ``db2'' command). IBM has been making some of these available through administrative view and the SYSPROC.ADMIN_CMD stored procedure.

Using these functions from perl is faster and can provide more detailed results than the command-line processor. For example, when reading configuration parameters, the administrative API will not just tell you which values are set to ``automatic'', but also which options support the ``automatic'' setting. In a similar manner, when loading data into a DPF database, the API returns detailed information for each node and agent, allowing far more fine-grained error handling.

The DB2 administrative function module provides the following functionality:

- Monitoring: get snapshot information and read event monitor files

- Bulk data transfer: export, import, load

- Configuration: get/set instance and database level configuration parameters

- Directory: read or modify the database, node and DCS directory

- Utilities: force applications, runstats, rebind, list history, list utilities

# PLATFORMS

This package has been known to build with the following combinations of software. Please report problems and additional platform / DB2 release combinations to the maintainer.

      Operating System        DB2 Version        Perl Version
      ================        ===========        ============
      Solaris 7               7.2                5.8
      Solaris 8               8.2                5.8
      Solaris 10              9.1                5.8
      Solaris 10              9.5                5.8
      Red Hat EL 3 (x86)      8.1                5.8
      Red Hat EL 3 (x86)      8.2                5.8
      Red Hat EL 3 (x86)      9.1                5.8
      Red Hat EL 3 (x86)      9.5                5.8
      Red Hat EL 4 (x86_64)   8.2                5.8
      Red Hat EL 4 (x86_64)   9.1                5.8
      Red Hat EL 4 (x86_64)   9.5                5.8

# INSTALLATION

This module can only be installed if you have the C compiler used to build perl itself, plus a version of DB2 with the header files installed (the developer's edition). You generally cannot build this module if you've downloaded a pre-compiled version of perl.

You need to run the test portions under a userid with DB2 system administration privileges.

As a first step, set the environment variable DB2_VERSION to the DB2 release you have installed. For example, if you're running DB2 Viper (V9.1), do:

      export DB2_VERSION=V9.1

If you're not on Linux or Solaris (or if you've installed DB2 in a different location than the Makefile.PL file expects), you also have to specify the path where the DB2 files can be found, for example:

      export DB2_PREFIX=/opt/IBM/db2/V9.1

Please report the default prefix for platforms that the author doesn't have access to (i.e. not Linux, Solaris), so the module can support them in the future.

Then do:

      perl Makefile.PL
      make

The test step requires you to create a SAMPLE database with a set of tables used for the export, import and load tests. The supplied ``create_test_db'' script will create the SAMPLE database using the IBM-supplied ``db2sampl'' utility and create some additional tables. Make sure you have sourced the DB2 environment before running the script.

      create_test_db
      make test

You can run the tests against any other database you want, but please make sure you update the CONFIG file before running the test script.

Once the test completes, you can install the module with:

      make install

# RELEASE NOTES

The CHANGES.html file has a complete, historical list of all user-visible (and some invisible) changes to this code.

# AUTHORS

The code is currently maintained and supported by:

      Hildo Biersma <Hildo.Biersma@MorganStanley.com>