IBM Books

Image, Audio, and Video Extenders Administration and Programming

DBiEnableTable


Image Audio Video
X    

Enables a table for images (DB2Image data). This API is called once per table. It creates metadata tables to store and manage attributes for image columns in a table. To avoid the possibility of locking, the application should commit transactions before calling this API. Before calling this API, the application must be connected to a database.

Authorization

Control, Alter, SYSADM, DBADM

Library file
OS/2 and Windows AIX, HP-UX, and Solaris
dmbimage.lib libdmbimage.a (AIX)

libdmbimage.sl (HP-UX)

libdmbimage.so (Solaris)

Include file

dmbimage.h

Syntax

long DBiEnableTable(
      char *tableSpace,
      char *tableName
      );

Parameters

tableSpace (in)
The name of the table space, which is a collection of containers into which administrative tables are stored. The table space specification has three parts as follows: datats, indexts, longts, where datats is the table space in which metadata tables are created; indexts is the table space in which indexes on the metadata tables are created; and longts is the table space in which values of long columns in the metadata tables (such as those that contain LONG VARCHAR and LOB data types) are stored. If you provide a null value for any part of the table space specification, the default table space for that part is used.

If you provide a null value for any part of the table space specification, the default table space for that part is used.

EEE Only: The tablespace specified should be in the same nodegroup as the user table.

tableName (in)
The name of the table that will contain an image column.

Error codes

MMDB_SUCCESS
API call processed successfully.

MMDB_RC_NO_AUTH
Caller does not have the proper access authority.

MMDB_WARN_ALREADY_ENABLED
Table is already enabled.

MMDB_RC_NOT_CONNECTED
Application does not have valid connection to a database.

MMDB_RC_TABLE_DOESNOT_EXIST
Table does not exist.

MMDB_RC_TABLESPACE_NOT_SAME_NODEGROUP
Tablespace specified is not in the same nodegroup as the user table. (EEE Only)

Examples

Enable the employee table for images (DB2Image data) in the table space MYTS. Use defaults for the index and long table spaces:

#include <dmbimage.h>
 
rc = DBiEnableTable("myts,,",
       "employee");

Enable the employee table for images (DB2Image data). Use default table spaces:

#include <dmbimage.h>
 
rc = DBiEnableTable(NULL,
       "employee");


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]