Getting started with Devart ODBC Driver for NexusDB
To connect ODBC-compatible applications to NexusDB, you need an ODBC driver and access to the NexusDB server.
Devart ODBC Driver for NexusDB enables direct connectivity to NexusDB, allowing database tools, reporting, analytics, BI, and ETL tools to access its data using standard SQL on both 32-bit and 64-bit Windows. The Driver connects to NexusDB directly via TCP/IP and does not require additional client software.
This guide shows you how to install and activate the Driver, configure an ODBC data source (DSN), connect to NexusDB using a DSN or connection string, and troubleshoot common connection issues.
Quick start: Connect to NexusDB with ODBC
To connect to NexusDB using the Devart ODBC Driver:
- Download and install the Driver for Windows.
- Activate the Driver using your activation key, or continue with the 30-day trial.
- Create an ODBC data source (DSN) and select Devart ODBC Driver for NexusDB.
- Configure the connection by specifying the required connection parameters.
- Use the DSN in your ODBC-compatible application to connect to NexusDB and work with its data.
The following sections provide detailed installation and configuration instructions.
Prerequisites
Before you begin, make sure your environment meets the following requirements:
- Operating system: 32-bit or 64-bit Windows (including Windows Terminal Server). The Driver is compatible with all Windows versions (Windows Vista and later) that support .NET Framework 4.5.
- ODBC driver manager: Included with Windows.
- Connection details: A NexusDB database, embedded or remote, with valid credentials (for remote).
- Activation key: A purchased version of the Driver requires an activation key. For evaluation purposes, you can use the trial version, which is valid for 30 days from the date of installation.
- Administrator rights: Required to install the Driver.
For a complete list of supported database servers, operating systems, and third-party tools, see the ODBC Driver for NexusDB compatibility page.
Install the ODBC Driver
Installing the Devart ODBC Driver for NexusDB is straightforward. All you need to do is download the package for your operating system (Windows) and follow the installation instructions.
1. Download the ODBC Driver for NexusDB from the Devart website, open it, and click Next.
2. Read the License Agreement, select I accept the agreement, and click Next.
3. On the Select Destination Location page, keep the default folder or click Browse to choose another one, and click Next.
4. On the Select Components page, select the components to install, then click Next.
5. On the Select Start Menu Folder page, specify the folder for the Driver shortcuts. To skip creating a Start Menu folder, select Don't create a Start Menu folder. Click Next, then click Install.
6. On the License Information page, select Input activation key and enter your key. You can find it in the registration email or your Customer Portal. To open the Customer Portal, click Get Activation Key.
If the activation key is saved on your computer, click Load Activation Key and select the corresponding file.
To evaluate the Driver without a purchased key, select Trial evaluation.
7. Click Next, then click Finish to complete the installation.
Configure an ODBC data source
In this guide, you create a Data Source Name (DSN) for the ODBC connection and verify the connection details. A DSN stores connection settings, such as the server address and the credentials used to connect to NexusDB. Applications can also connect without a DSN by passing the same parameters in a connection string.
To configure an ODBC data source, follow the steps outlined below.
1. In Windows Search, enter ODBC Data Sources, and open the ODBC Data Source Administrator that matches the bitness of your application.
2. Go to the User DSN, System DSN, or File DSN tab, and click Add.
- User DSN — Available only to the user who creates it.
- System DSN — Available to all users on the computer.
- File DSN — Stores connection settings in a file that can be shared between computers where the required ODBC Driver is installed.
3. In the Create New Data Source dialog, select Devart ODBC Driver for NexusDB, and click Finish.
4. In the Devart ODBC Driver for NexusDB Configuration dialog, enter a Data Source Name and an optional Description.
5. The authentication process depends on the chosen NexusDB option.
If you are connecting to an embedded NexusDB:
Select Embedded in the Devart ODBC Driver for NexusDB Configuration dialog and provide the path to the database folder on your local disk. Note that you should give the full path to that directory only—don't name any file inside it.
If you are connecting to a remote NexusDB instance:
Select Remote in the Devart ODBC Driver for NexusDB Configuration dialog and provide the required connection details: the server address, the port, the database, the user ID, and the password. Optionally, select Save Password to store it.
6. Optional: Click Test Connection to verify the connection settings.
7. Click OK to save the DSN settings.
To fine-tune metadata, timeout, and compatibility behavior, use the Advanced Settings tab of the same dialog.
Connect to NexusDB using a connection string
In addition to using a DSN, you can connect to NexusDB by specifying the connection parameters directly in an ODBC connection string. This type of connection is known as a DSN-less connection.
The following table summarizes when to use each connection method.
| Connection method | How it works | Best for |
|---|---|---|
| DSN | Stores the connection settings in a configured ODBC data source. Applications connect by specifying the DSN name. | Desktop applications, BI and reporting tools, and reusable connections configured on a client computer. |
| DSN-less | Specifies the Driver, server, credentials, and other settings directly in a connection string. No DSN needs to be created beforehand. | Applications, scripts, and automated deployments where connection settings are managed programmatically. |
Use the following connection string configuration as a reference for connecting to an embedded database.
Use the following connection string configuration as a reference for connecting to a remote NexusDB database.
DRIVER={Devart ODBC Driver for NexusDB};Server=myserver;Port=myport;Database=mydatabase;User ID=myuser;Password=mypasswordReplace the placeholder values with your actual database path, connection details, and credentials for NexusDB.
For the complete list of supported options, see the NexusDB ODBC Connection String Parameters page.
Troubleshooting
If you cannot connect to NexusDB through the Devart ODBC Driver, refer to the following list of common connection issues and their solutions to troubleshoot and fix the failure.
You get a "Product is not activated or has been deactivated" error
This error occurs when the Driver has not been activated or its activation is no longer valid. Activation is required for both purchased and trial versions.
Open the DSN configuration dialog, go to the License tab, click Input Activation Key, and enter your activation key. After activation, test the connection again.
The ODBC data source is not found or the Driver is not available
If your application cannot find the DSN or the Devart ODBC Driver for NexusDB, check the application and Driver bitness.
A 32-bit application cannot use a DSN created in the 64-bit ODBC Data Source Administrator, and a 64-bit application cannot use a DSN created in the 32-bit administrator.
Make sure that:
- The DSN is created in the ODBC administrator that matches your application's bitness.
- The corresponding 32-bit or 64-bit version of the Driver is installed.
- The application is configured to use the correct DSN.
Connection fails
If the NexusDB server is reachable but authentication fails, check the connection settings and credentials.
Open the ODBC Data Source Administrator and select the DSN you have configured for the ODBC Driver for NexusDB.
Embedded NexusDB
- Check the path you entered. Make sure that it points to the right directory, and not to any specific file inside it.
- Use an absolute path. A relative path is resolved from the application's current working directory, which may differ from your initial settings.
- Check if the folder with your local NexusDB database already exists. The Driver needs read/write access to it.
- Avoid network paths and use a local disk for your embedded NexusDB database instead.
Remote NexusDB
- Make sure that you are using the correct server address and port, and that your credentials are valid.
- Ensure that the NexusDB user has the required database access rights.
Run the connection test again to verify the details.
NexusDB connection times out
If the connection to NexusDB takes too long to establish, increase Connection Timeout on the Advanced Settings tab. Also, check the network connection.
Additional resources
After you install and configure Devart ODBC Driver for NexusDB, use the following resources to continue setting up and working with your connections:
- Connection string parameters — Browse the complete list of connection options for configuring server access, timeouts, ODBC behavior, and other Driver settings.
- Supported ODBC API functions — Explore the currently supported ODBC functions.
- Using in third-party tools — Find step-by-step guides for connecting BI, reporting, analytics, and other ODBC-compatible tools to NexusDB.
- Documentation — Get full information on installing, configuring, and using the Devart ODBC Driver for NexusDB.