INFORMIX
DataBlade Module Development Overview
Chapter 2: Building a DataBlade Module
Home Contents Index Master Index New Book

DataBlade Developers Kit Tools

The DataBlade Developers Kit provides graphical user interfaces for creating, packaging, and registering DataBlade modules.

BladeSmith

You use BladeSmith to begin creating your DataBlade module, such as defining its contents, and generating files and source code. BladeSmith guides you through object definition with wizard pages. BladeSmith automates many of the tasks of object creation, such as writing the SQL statements necessary to define objects in the database.

Using BladeSmith, you create a project for your DataBlade module and then add or define the objects in it, such as:

Each of these objects is summarized in Chapter 1, "DataBlade Module Concepts."

After you specify the user-defined objects, imported objects, and files you want to include in your DataBlade module, use BladeSmith to generate the files you need for compiling a shared object file or dynamic link library, managing a DataBlade module in Informix Dynamic Server, testing object functionality, and creating installation packaging files. These files are described in the following table.
Type of Generated File Description

Source code

You use these files to create a shared object or dynamic link library. They include source code files, header files, and makefiles that you compile into a shared object file or dynamic link library.

SQL script

These files contain the SQL statements that support the DataBlade modules in the database system tables. They include prepare scripts that describe the DataBlade module, and object scripts that describe the DataBlade objects.

Test

You use these files to test the positive and negative operation of user-defined routines, opaque data type support routines, and casts.

Packaging

You use these files with BladePack to generate installation files and executables.

The generated source code files contain routine definitions. Overloaded versions of built-in routines, including opaque data types support routines, may not need modification, but user-defined routines need to be edited. The areas of the generated source code that need modification are marked with TO DO: comments.

When your C code is complete, you compile the source code files into the shared object file.

For instructions, see the DataBlade Developers Kit User's Guide or the tutorial in the on-line DataBlade Developers Kit InfoShelf.

BladePack

You use BladePack to create an installable DataBlade module package. BladePack uses the packaging project file created by BladeSmith as the basis for the installation package. The packaging file references the SQL scripts, shared object file, and other files required by the DataBlade module. The installation scripts ensure that all DataBlade modules created with the DataBlade Developers Kit can be installed in a similar way.

You can perform the following tasks with BladePack:

    For example, you can include documentation, on-line help, and example files.

    For example, you can include DataBlade modules that facilitate similar financial calculations into a single installation package.

    You can designate the components and subcomponents to include in typical and compact installations. You can also allow users to customize their installations by choosing the components and subcomponents they want to install. Shared components can belong to more than one component, and are always installed with components to which they belong.

    You can add custom DLL routines, dialog boxes, and programs for Windows NT InstallShield installations, and custom programs for UNIX installations. You can also include Read Me files for any type of installation.

    On UNIX platforms, an interactive installation includes install and uninstall shell scripts. On Windows, an interactive installation includes Setup and Uninstall programs created with InstallShield.

See the DataBlade Developers Kit User's Guide for more information.

BladeManager

You use BladeManager to register or unregister your DataBlade module in a database and to install or uninstall DataBlade module client files.

After you install a DataBlade module on a server, you must register it in every database that uses the module. Registration involves adding the DataBlade SQL scripts to the database system tables and making the DataBlade shared object or dynamic link library available to the server.

BladeManager checks for dependencies between DataBlade modules. If you have imported an interface from another DataBlade module, BladeManager registers your DataBlade module only after confirming that the interface is registered in the database.

If you are upgrading your DataBlade module, BladeManager automatically unregisters the previous version.

You can also unregister any module by using BladeManager. BladeManager does not allow you to unregister a DataBlade module if there is another DataBlade module that depends on it or if any of its objects are used in the database.

See the DataBlade Module Installation and Registration Guide for more information.




DataBlade Module Development Overview, version 3.6
Copyright © 1998, Informix Software, Inc. All rights reserved.