Library: Database access (OMDB legacy) Include: omdb.xin

Return type: dbDatabase Returns: A dbDatabase object for the opened database connection.

Declaration

define external dbDatabase function dbOpenOCI8
          value string database-name

or

define external dbDatabase function dbOpenOCI8
          value string database-name
     user value string user-name
 password value string password

Argument definitions

database-name

is the name of the Oracle database to which you want to connect.

user-name

is the user name that will be supplied to the database when the connection is made.

password

is the password that will be supplied to the database when the connection is made.

Use dbOpenOCI8 to create a connection to an Oracle 8 (or higher) database. The function returns a dbDatabase OMX component.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omdb.xin"

You must have an Oracle 8 (or higher) client installed on your machine, with SQL*NET configured to locate your Oracle 8 (or higher) server.

database-name must:

• exist
• refer to an Oracle 8 (or higher) database
• be accessible via Oracle SQL*NET

user-name and password are optional with default values of an empty string. Check what access requirements are needed for the specified database.

Usage Notes

You must have declared an OMX dbDatabase variable (either global or local) to reuse a database connection in other omdb functions.

This function will throw external exception OMDB501 if there are any OCI errors. The exception will include any error numbers and descriptive text generated by the OCI. Consult your Oracle documentation for further details on the error condition.

Example #1:

Create a connection to an Oracle 8 (or higher) database named "DatabaseDemo" via OCI using username "charley" and password "chaplin". This connection can be reused in other omdb functions.

  include "omdb.xin"
  
  process
     local dbDatabase my-database
                  .  .  .
     set my-database to dbOpenOCI8 "DatabaseDemo" user "charley" password "chaplin"

Other Library Functions dbClose dbCommit dbDatabase dbExecute dbField dbFieldPrepare dbFieldSink dbFieldValue dbIsVersionCompatible dbLibraryVersion dbLibraryVersionOCI8 dbLibraryVersionOCI8i dbLibraryVersionODBC dbOpenOCI8 dbOpenOCI8i dbOpenODBC dbProcedure dbProcedureClose dbProcedureExecute dbProcedureOpen dbQuery dbRecordExists dbRecordMove dbRecordMoveDynamic dbRecordSetMove dbRollback dbSetTransactionType dbStatement dbStatementCompile dbStatementDiscard dbStatementExecute dbStatementStreamingExecute dbTable dbTableClose dbTableDelete dbTableInsert dbTableOpen dbTableUpdate

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