Omnis Data Access Modules

Connecting to External Databases

Omnis Data Access Modules (DAMs) plug-in to Omnis, enabling native and multi-tier connection to proprietary Database Management Systems (DBMS).

To connect to proprietary databases (other than Omnis datafiles, SQLite datafiles, MySQL and PostgreSQL) you need the Professional edition of Omnis Studio. Depending on the database vendor you may also need to install the appropriate third-party clientware on each machine that will be connecting to the database server. Two-tier DAMs use this clientware to complete the connection to the remote database server.

I want to connect from:

Select a platform...
Omnis Studio running on Windows x86/x86_64
Omnis Studio running on macOS x86_64/arm64
Omnis Studio running on Linux x86_64
Omnis JS-Wrapper running on an iOS device
Omnis JS-Wrapper running on an Android device
Other ODBC-compliant application

to:

Select a database...
MySQL 4.1 and later
PostgreSQL 8.1 and later
Oracle 8i and later
Microsoft SQLServer 2000 and later
SAP Sybase ASE 11 and ASA 9 and later
SQLite data file (format 3)
IBM-DB2 v5.x and later
Frontbase DB v 4.x and later
MariaDB v10.6 and later
Omnis Studio data file
Other ODBC-compliant database software

Select the connection you want to make

For a summary view, use the options above to select the type of connection you want to make. For a list of supported connections on a given platform, please refer to the DAMs Connectivity page, or for a list of recommended clientware please refer to the DAMs Configuration page.

Alternatively, read a Summary of all the connection types supported by the Omnis Studio DAMs.

Recommended: Use the Omnis ODBC Driver

Omnis ODBC Driver

The Omnis ODBC Driver provides third-party ODBC-compliant applications with read-only access to your Omnis data files.

This allows ODBC-compliant third-party applications; such as Microsoft Query to read data from Omnis data files using SQL SELECT statements, showing them as tables that use standard SQL data types. We provide separate ODBC drivers for macOS and Windows, and for Unicode and non-Unicode Omnis datafiles. (Datafiles used with Omnis Studio 5.0 and later are automatically converted to support Unicode).

Recommended: Use the Sync Server with the MySQL DAM

Develop your app using Omnis JavaScript Client and use the Sync Server connected to your MySQL database. You may need to use the MySQL DAM with an external client library if you are connecting to the latest MySQL database versions.

Recommended: Use the Sync Server with the PostgreSQL DAM

Develop your app using Omnis JavaScript Client and use the Sync Server connected to your PostgreSQL database. You will need to use the PostgreSQL DAM with an external client library if you require OpenSSL support.

Recommended: Use the Sync Server with the Oracle DAM

Develop your app using Omnis JavaScript Client and use the Sync Server connected to your Oracle database. You will need to install Oracle Instant Client on the SyncServer machine to complete the connection to your Oracle database.

Recommended: Use the Sync Server with the ODBC DAM

Develop your app using Omnis JavaScript Client and use the Sync Server connected to your SQLServer database. You may need to install the Microsoft ODBC Driver for SQL Server and configure an ODBC DSN on the SyncServer machine to complete the connection.

Recommended: Use the Sync Server with the Sybase DAM

Develop your app using Omnis JavaScript Client and use the Sync Server connected to your Sybase ASE or ASA database. If connecting to Sybase ASE, you may need to install Sybase Open Client on the SyncServer machine to complete the connection. If connecting to Sybase ASA, you may need to install the Sybase ASA ODBC Driver and configure an ODBC DSN on the SyncServer machine to complete the connection.

Recommended: Use the Sync Server with the SQLite DAM

Develop your app using Omnis JavaScript Client and use the Sync Server connected to your SQLite data file. If desktop clients will also need access to the SQLite database, use the SQLite Databridge to complete the connection.

Recommended: Use the Sync Server on Windows or Linux with the DB2 DAM

Develop your app using Omnis JavaScript Client and use the Sync Server connected to your DB2 or DB2-Express database. If the SyncServer will be running on an macOS machine, you can complete the connection to DB2 using the ODBC Databridge and a suitably configured ODBC DSN.

Recommended: Use the Sync Server with the Frontbase DAM

Recommended: Use the Sync Server with the MySQL DAM

Develop your app using Omnis JavaScript Client and use the Sync Server connected to your MySQL database. You will need to use the MySQL DAM with an external client library to support connection to MariaDB.

Recommended: Use the Sync Server with the OmnisSQL DAM

If desktop clients will also need access to the Omnis data file, use the Omnis Databridge to complete the connection.

Recommended: Use the Sync Server with the ODBC DAM

If your database software supports connection via ODBC then you can install and configure an ODBC DSN on the SyncServer machine to complete the connection. If the SyncServer is running on macOS or Linux and a compatible ODBC Driver is not available, you can forward and ODBC connection to Windows using the ODBC Databridge.

Mobile client devices rely on their local cache of the remote "consolidated database" when not in range of the host network. When in range, devices can "sync" with the SyncServer, uploading any Inserts, Updates & Deletes as well as downloading any changes to the cached tables. Client synchronisation is largely database-independent since iOS and Android devices use an internal SQLite datafile for their database storage. Refer to the JavaScript Client documentation for details on the built-in SQL Object.

Recommended: Use the MySQL DAM

Use the MySQL DAM to connect directly to a MySQL database.

The MySQL DAM contains an embedded MySQL client library allowing direct connection to MySQL 5.x and 6.x database servers. To connect to more recent servers, or to enable an encrypted/SSL connection you can apply an external SSL-enabled MySQL client library (libmysql.dll). (Technote TNSQ0039 explains usage).

Prior to Omnis Studio10.2*, the MySQL DAM contains an embedded MySQL client library allowing direct connection to MySQL 5.x and 6.x database servers. To connect to more recent servers, or to enable an encrypted/SSL connection you can apply an external SSL-enabled MySQL client library (libmysqlclient.dylib) (Technote TNSQ0039 explains usage).

Owing to compatibility issues, the MySQL DAM in Studio 10.2* and later no longer contains an embedded client libary. We recommend installing the SSL-enabled MySQL client libary from a standard MySQL binary distribution, or alternatively using Homebrew as discussed in technote TNSQ0039.

The MySQL DAM contains an embedded MySQL client library allowing direct connection to MySQL 5.x and 6.x database servers. To connect to more recent servers, or to enable an encrypted/SSL connection you can apply an external SSL-enabled MySQL client library (libmysqlclient.so). (Technote TNSQ0039 explains usage).

For server-specific documentation on the MySQL DAM, please refer to the Omnis Programming manual.

*Applies to Omnis Studio 10.2 revisions > 30204

Recommended: Use the PostgreSQL DAM

Use the PostgreSQL DAM to connect directly to a PostgreSQL database.

We supply a dynamic PostgreSQL client library (libpq.dll) for standard connections to PostgreSQL 8.x (and later) databases. To enable an encrypted/SLL connection, you can replace the client library with an SSL-enabled DLL from a PostgreSQL binary distribution. (Technote TNSQ0031 explains usage).

We supply a dynamic PostgreSQL client library (libpq.dylib) for standard connections to PostgreSQL 8.x (and later) databases. To enable an encrypted/SLL connection, you can replace the client library with an SSL-enabled DLL from a PostgreSQL binary distribution. (Technote TNSQ0031 explains usage).

We supply a dynamic PostgreSQL client library (libpq.so) for standard connections to PostgreSQL 8.x (and later) databases. To enable an encrypted/SLL connection, you can replace the client library with an SSL-enabled DLL from a PostgreSQL binary distribution. (Technote TNSQ0031 explains usage).

For server-specific documentation on the postgreSQL DAM, please refer to the Omnis Programming manual.

Recommended: Use the Oracle DAM & Oracle Instant Client

Use the Oracle DAM to connect directly to an Oracle database (Oracle 8i and later).

To use the Oracle DAM, you will need to download and install "Oracle Instant Client" (version 11.1.0.7 or later) available separately for 32 & 64-bit systems. For help configuring and connecting to Oracle databases, please refer to the Technotes section.

To use the Oracle DAM, you will need to download and install "Oracle Instant Client" (version 11.2.0.3 or later). For help configuring and connecting to Oracle databases, please refer to the Technotes section.

To use the Oracle DAM, you will need to download and install "Oracle Instant Client" (version 11.1.0.6 or later). For help configuring and connecting to Oracle databases, please refer to the Technotes section.

For server-specific documentation on the Oracle DAM, please refer to the Omnis Programming manual.

Recommended: Use the ODBC DAM with the Microsoft ODBC Driver for SQLServer

Use the ODBC DAM with a recommended ODBC Driver connect to a SQL Server database (SQL Server 2000 and later).

We recommend using the latest Microsoft "SQL Server" or "SQL Server Native Client" ODBC Driver (or the minimum driver version that is recommended for use with your database server).

Other Options: Use the Sybase DAM

Use the Sybase DAM to connect directly to a Microsoft SQL Server database.

The Sybase DAM in Omnis Studio 10 and later supports the FreeTDS dynamic client library (libct.dll) which can be used in place of Sybase Open Client. Technote TNSQ0036 explains usage.

Recommended: Use the ODBC DAM with the Microsoft ODBC Driver for SQLServer

Download and install the Microsoft ODBC Driver for SQL Server. Technote TNSQ0036 explains usage.

For server-specific documentation on the ODBC DAM, please refer to the Omnis Programming manual.

Other Options: Use the Sybase DAM

Use the Sybase DAM to connect directly to a Microsoft SQL Server database.

The Sybase DAM in Omnis Studio 10 and later supports the FreeTDS dynamic client library (libct.dylib) which can be used in place of Sybase Open Client. Technote TNSQ0036 explains usage.

Other Options: Use the Sybase DAM

Use the Sybase DAM to connect directly to a Microsoft SQL Server database.

The Sybase DAM in Omnis Studio 10 and later supports the FreeTDS dynamic client library (libct.so) which can be used in place of Sybase Open Client. Technote TNSQ0036 explains usage.

Other Options: Use the ODBC Databridge

In the absence of a proprietary ODBC Driver on the macOS/Linux client machine, it is possible to route a connection using the ODBC DAM to connect to the ODBC databridge running on a Windows PC. From there, use the Microsoft SQL Server ODBC Driver to connect to your SQL Server database.

Recommended: Use the Sybase DAM with Sybase Open Client

Use the Sybase DAM to connect directly to a Sybase/SAP ASE or ASA database (ASE 12.5 and later, ASA 9.0 and later).

To use the Sybase DAM, you will need to download and install Sybase Open Client (or use the version that accompanies your database software). The Sybase DAM requires Open client 12.5 or later, 15 or later is recommended.

Other Options: Use the FreeTDS Client Library

The Sybase DAM in Omnis Studio 10 and later supports the FreeTDS dynamic client library (libct.dll) which can be used in place of Sybase Open Client. Technote TNSQ0036 explains usage.

Recommended: Use the Sybase DAM with the FreeTDS Client Library

Use the FreeTDS client library on macOS to connect directly for Microsoft SQL Server, SAP-Sybase ASE and ASA databases.

The Sybase DAM in Omnis Studio 10 and later supports the FreeTDS dynamic client library (libct.dylib) which simulates functionality previously provided by Sybase Open Client. Technote TNSQ0036 explains usage.

Recommended: Use the Sybase DAM with Sybase Open Client

Use the Sybase DAM to connect directly to a Sybase/SAP ASE database (ASE 12.5 and later).

To use the Sybase DAM, you will need to download and install Sybase Open Client (or use the version that accompanies your database software). The Sybase DAM requires Open client 15 or later.

Other Options: Use the FreeTDS Client Library

The Sybase DAM in Omnis Studio 10 and later supports the FreeTDS dynamic client library (libct.dll) which can be used in place of Sybase Open Client. Technote TNSQ0036 explains usage.

For server-specific documentation on the Sybase DAM, please refer to the Omnis Programming manual.

Recommended: Use the SQLite DAM

Use the SQLite DAM to connect directly to a SQLite data file (SQLite format 3)

The SQLite DAM contains an embedded SQLite client library so can connect directly to a SQLite data file on your local file system.

For server-specific documentation on the Sybase DAM, please refer to the Omnis Programming manual.

Other Options: Use the SQLite Databridge

The Omnis SQLite Databridge supports multiple concurrent connections to one or more SQLite data files over a TCP/IP network. Please refer to the accompanying documentation on making a connection using the databridge.

Recommended: Use the DB2 DAM with DB2 Express-C Client

Use the DB2 DAM to connect directly to an IBM-DB2 or DB2 Express Database.

To use the DB2 DAM, you will need to install either DB2 Runtime Client (v8 max) or DB2 Express-C Client 9.0 (or later). The Client package normally accompanies your DB2 installation media.

Recommended: Use the ODBC Databridge

The absence of any clientware for macOS prevents direct connection using the DB2 DAM. Instead, it is possible to route a connection using the ODBC DAM to connect to the ODBC databridge running on a Windows PC. From there, use the IBM/DB2 ODBC Driver to connect to your DB2 or DB2 Express database. (The DB2 ODBC driver normally accompanies your DB2 installation media).

Recommended: Use the DB2 DAM with DB2 Express-C Client

Use the DB2 DAM to connect directly to an IBM-DB2 or DB2 Express Database.

To use the DB2 DAM, you will need to install either DB2 Runtime Client Client 7.1 (or later). The Client package normally accompanies your DB2 installation media.

For server-specific documentation on the DB2 DAM, please refer to the Omnis Programming manual.

Recommended: Use the Frontbase DAM

Use the Frontbase DAM to connect directly to FrontBase 4.x (or later)

The Frontbase DAM has been developed externally and can be downloaded from the Frontbase website. The DAM contains an embedded client library so requires no additional software in order to work. Please refer to the accompanying readme for installation and usage notes.

Recommended: Use the MySQL DAM with external MySQL client library

Use the MySQL DAM to connect directly to MariaDB 10.6 (or later)

The MySQL DAM in Studio 10.2* has been modified to additionally support connection to MariaDB (an extension of MySQL). The MySQL client library embedded into the DAM is insufficient for connection to MariaDB and an external MySQL client library (libmysql.dll) should be applied. Please refer to technote TNSQ0039 for details.

The MySQL DAM in Studio 10.2* has been modified to additionally support connection to MariaDB (an extension of MySQL). The MySQL client library embedded into the DAM is insufficient for connection to MariaDB and an external MySQL client library (libmysqlclient.dylib) should be applied. Please refer to technote TNSQ0039 for details.

The MySQL DAM in Studio 10.2* has been modified to additionally support connection to MariaDB (an extension of MySQL). The MySQL client library embedded into the DAM is insufficient for connection to MariaDB and an external MySQL client library (libmysqlclient.so) should be applied. Please refer to technote TNSQ0039 for details.

For server-specific documentation on the MySQL DAM, please refer to the Omnis Programming manual.

*Applies to Omnis Studio 10.2 revisions > 30204

Recommended: Use the OmnisSQL DAM

Use the OmnisSQL DAM to connect directly to an Omnis data file. The OmnisSQLDAM uses the Omnis DML engine internally so no additional clientware is needed. Omnis Studio 5 and later uses Unicode data files. Older data files will need to be converted to Unicode before use.

Other Options: Use the Omnis Databridge

The Omnis databridge is the recommended way to provide shared access to Omnis data files and prevents locking and potential damage that can occur otherwise. The databridge also allows remote connection to data files via TCP/IP.

Other Options: Use DML Emulation

If your code uses old-style Data Manipulation Language (DML) commands such as Set main file, Find first & Next, you can convert your Omnis data file(s) to SQLite or to PostgreSQL. Once enabled for emulation, your library code executes against the SQL backend without modification. Please refer to the Data file migration documentation for more details.

Recommended: Use the ODBC DAM and a compatible ODBC Driver.

Consult the documentation for the third-party product you are using and check whether it supports ODBC connectivity. Install the ODBC driver if required and set-up an ODBC DSN that will connect to the third-party product.

For server-specific documentation on the ODBC DAM, please refer to the Omnis Programming manual.

Other Options: Customised DAMs

The Omnis Studio Component SDK provides developers with a starting point for designing custom DAMs- specialised external components that provide Omnis Studio with access to external databases.

 

Search Omnis Developer Resources

 

Hit enter to search

X