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

Return type: String sink Returns: An external output to which data can be written for the parameter currently being streamed in to the database.

Declaration

define external string sink function db.writer
  of   value       db.field  insert-handle

Argument definitions

insert-handle

is the db.field passed as the "with" parameter to the previous db.streaming-execute

Use db.writer to obtain an external output object for the current parameter of a db.streaming-execute operation.

Requirements

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

This function can only be called once following each call to db.prepare (else external exception OMDB307).

The streaming execute operation must not have been completed (else external exception OMDB711).

Usage Notes

After db.prepare returns TRUE, this function can be called to get an external output object for the parameter which is currently being requested. Any data written to the external output is then streamed in to the database.

To indicate a NULL value, either do not call this function or do not write any data to the returned external output.

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

Related Topics Using the OMDB library

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

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