db.insert

function

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

Declaration

define external function db.insert
  into  value     db.table  table
  from  read-only stream    values
  null  value     string    null   optional

Argument definitions

table: is an open db.table object.

values: is a stream shelf containing the values to insert.

null: is an optional string to represent a NULL value rather than the default unattached stream.

Purpose

Use db.insert to insert a record into a table using the data values in a stream shelf.

Requirements

The database connection containing the table must be:

open (else external exception OMDB104)
in scope (else external exception OMDB103)

The table must :

exist (else external exception OMDB501)
be open (else external exception OMDB601)

The record being inserted (values) must:

contain data (else external exception OMDB606)
contain valid data for the table (else external exception OMDB501)
have item keys that match table column names (else external exception OMDB603)

Usage Notes

NULL data values may be represented as unattached streams or as an optionally defined string. The column name is identified as the key of each shelf item in the values argument.

If the record has a date, time, or timestamp field, you must represent the field's value in the OmniMark Date and Time library format. (This format returns the time with a time zone offset from UTC time, which most databases do not provide.)

Example

The following program adds two new courses to a curriculum. The table records can be added using two different methods. The first is to execute an SQL statement on the database. The second approach is to use the db.table OMX component.

  import "omdb.xmd" prefixed by db.
  
  process
      local db.database this-db
      local db.table course
      local stream SQL-insert initial
      {  "insert into Course values " ||
          " ( '503', 'Learning Through Pain'  )"
      }
      local stream course-data variable initial
      {   '504' with key 'CID',
            'What is that Sound?' with key 'CourseName'
      }
  
      ;  create the database OMX objects
      set this-db to db.open-odbc 'dbDemo'
      set course to db.open-table in this-db named 'Course'
  
      ; add record to the table (Method #1)
      db.execute-in this-db sql SQL-insert
  
      ; add record to the table (Method #2)
      db.insert into course from course-data

Related Topics

Other Library Functions