db.prepare

function

Library: Database access (OMDB)
Import : omdb.xmd

Returns: A boolean value which is TRUE if there is another parameter to be streamed in and FALSE otherwise.

Declaration

define external switch function db.prepare
         modifiable  db.field  insert-handle

Argument definitions

insert-handle: is the db.field passed as the "using" parameter to db.streaming-execute

Purpose

Use db.prepare to fetch the next parameter to be inserted. It returns FALSE if all parameters have been inserted, otherwise it returns TRUE.

Requirements

insert-handle must be the db.field passed as the "using" parameter to the previous db.streaming-execute call.

Usage Notes

This function is to be called repeatedly after db.streaming-execute until it returns FALSE. Each time it returns TRUE, it sets the key of insert-handle to the name of the parameter being requested, where the first parameter from the left is "1", the second is "2", and so on.

Be sure to keep calling this function until it returns FALSE since the parameters can be requested out of order by the database driver. In addition, this function performs final processing after the final parameter has been streamed in.

See the usage notes for db.streaming-execute for further details and examples.

Other Library Functions