swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
      Other Library Functions  
function  

db.prepare

 
 

Library: Database access (OMDB)
Import: omdb.xmd
Return type: Switch

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
   db.advance-recordset
   db.close
   db.commit
   db.compile-statement
   db.database
   db.delete
   db.discard
   db.document-writer-sedna
   db.execute
   db.execute-in
   db.field
   db.insert
   db.is-null
   db.move-dynamic-record
   db.move-record
   db.omdb-version
   db.omdb-version-oci10g
   db.omdb-version-oci11g
   db.omdb-version-oci8i
   db.omdb-version-oci9i
   db.omdb-version-odbc
   db.omdb-version-sedna
   db.open-oci10g
   db.open-oci11g
   db.open-oci8i
   db.open-oci9i
   db.open-odbc
   db.open-procedure
   db.open-sedna
   db.open-table
   db.prepare
   db.procedure
   db.query
   db.reader
   db.record-exists
   db.rollback
   db.set-transaction-type
   db.statement
   db.streaming-execute
   db.table
   db.update
   db.writer
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.