Pcdsql, Pcdsql 10 – Kofax DM API User Manual

Page 127

Advertising
background image

DM API O

BJECTS

107

PCDSQL

PCDSQL

The PCDSQL object allows direct access to SQL tables that support the
DM document management system.

Caution: The PCDSQL object and the methods it supports provide a set of
powerful tools that allow you to modify the SQL database that supports your DM
system. However, with this power also comes the power to damage or destroy the
SQL database tables that DM uses to control your document management
environment. Other objects in the DM API offer some degree of protection to
safeguard against your accidental or inadvertent corruption of the SQL database
tables. By contrast, PCDSQL methods provide your custom applications complete
flexibility to modify any SQL database table in the DM library.

Unless you use SQL pass-through features correctly, you may damage your DM
document management system. Examples of damage that can occur include the
corruption of data in the SQL databases used by DM, the loss of system data
maintained by DM, and the inability of DM to recover document objects stored in
your DM repository.

Because of the inherent danger associated with the improper use of the PCDSQL
object and the methods it supports, Hummingbird recommends that you
incorporate this object into your custom applications only when other DM API
objects do not provide the program functionality you require.

Syntax

PCDSQL.

methodOrProperty

Usage

PCDSQL supports custom access to any DM libraries. The methods it
exposes allow you to submit any structured query language queries to
the SQL database. Metadata can be retrieved about that query and
various different database objects. New database objects can be created
using the tools that PCDSQL supports.

Example

The following example exercises the methods supported by the
PCDSQL object. In addition to providing several event-driven forms
and the source code behind them, you should also note that the

DocInternalClass

object has been created as an independent object

Advertising