Home

Getting Started

Utilities

Indexing

Omnidex

Development

Tutorials

Quick Links

 

Development

OmniAccess API

 

 

OmniAccess API

Programming Basics

Managing Data

Functions

 

Development

Functions

oaassignvalues
oaassignvalues is used to pass criteria values to an active select statement.

oabegin
Marks the beginning of an update transaction for oacommit and oarollback. It is one of four routines that support transaction management from within OmniAccess.

Presently, transaction management applies only to oainsertindex, oadeleteindex, and oaupdateindex.

oabind
oabind establishes how data is returned for subsequent oafetch, oafetchkeys, or oaexport calls within a specified cursor. It determines the data type and length of each select item, and allows data to be returned to a separate memory address per select item.

oaclosecursor
oaclosecursor terminates a cursor and releases resources associated with the cursor, depending how caching was set through oaconnect. Omnidex Client applications should always call oaclosecursor when they are finished with a cursor, to free up the memory used by the cursor.

oacommand
Use oacommand to execute an operating system command from within an Omnidex application. Unlike most other OmniAccess routines, oacommand can be called without being connected to an environment.

oacommit
oacommit marks the end of an indexing transaction. It commits all updates to the indexes that occurred since the last call to oabegin.

Presently, transaction management applies only to oainsertindex, oadeleteindex, and oaupdateindex.

oaconnect
oaconnect opens an Omnidex Environment Catalog, TurboImage database, or client/server data source file. Some key configuration options such as cache settings, read/write access, etc..., can also be set through oaconnect.

oadebug
Enables or disables diagnostic messages from within an application.

oadelete
Deletes the current row for the cursor and, unless index updates are disabled, updates the Omnidex indexes to reflect the deletion.

oadeleteindex
Deletes the current row’s key values from any Omnidex indexes, without deleting the data from the database.

oadeletewhere
Deletes a set of rows based on specified criteria, and, unless index updates are disabled, updates the Omnidex indexes to reflect the deletion.

oadescribe
Returns detailed information about the selection items specified in the preceding oaselect, through the selectitemlist parameter, and prepares these structures for subsequent calls to oabind.

oadisconnect
Terminates the catalog connection and closes the environment established by oaconnect, automatically closing any open cursors.

oaerror
Returns an error message for an error returned by the last API call.

oaexecsql
Provides a SQL interface to many of the OmniAccess capabilities. This routine supports most SQL DML statements, as well as additional statements exclusively to support OmniAccess functionality such as index qualification.

oaexport
Retrieves data from rows selected by a preceding call to oaselect, oaqualify, or oajoin, then writes them to a specified file.

oaexternal
Allows user-written routines to be called either locally or remotely from an Omnidex application, allowing Omnidex applications to distribute processing on the server. It also permits Omnidex Client applications to indirectly call such OmniAccess routines as oainsertindex that are not directly available to Omnidex Client applications.

oafetch
oafetch retrieves rows selected by oaselect.

oafetchkeys
Returns key values (row IDs or unique keys) or the actual keywords stored in the Omnidex indexes, from rows qualified with the previous call to oaqualify.

oainsert
Adds a row to a table and, unless index updates are disabled, automatically updates the Omnidex indexes to reflect the new row.

oainsertindex
Updates the Omnidex indexes to include any key values corresponding to the row identified by rowid.

oajoin
Provides joined access to data across tables following and preceding calls to oaqualify.

oamessage
Returns the message as defined in the message statement of the Environment Catalog.

oaopencursor
Opens a cursor for performing retrieval, update, and delete operations.

oaqualify
Qualifies rows in a table by searching an Omnidex index specified in column, using the specified search criteria.

oarollback
Rolls back an indexing transaction that involves oadeleteindex, oainsertindex, or oaupdateindex, to the most recent call to oabegin, or to a savepoint set in a call to oasavepoint.

Presently, transaction management applies only to oainsertindex, oadeleteindex, and oaupdateindex.

oasavepoint
Marks a place in an update transaction for oarollback.

Presently, transaction management applies only to oainsertindex, oadeleteindex, and oaupdateindex.

oaselect
Defines tables, columns and selection criteria for later retrieval by oafetch or transfer by oaexport.

oastatementinfo
Returns information after each call to oaexecsql indicating information about the statement just processed.

oaupdate
Updates the current row and, unless index updates are disabled, automatically updates the Omnidex indexes to reflect the change.

oaupdateindex
Updates the key values for the specified table in the Omnidex indexes.

oaupdatewhere
Updates a set of rows based on criteria supplied through the criteria parameter and, unless index updates are disabled, automatically updates the Omnidex indexes to reflect the change.

oaversion
Returns Omnidex software version information.

 

Top