InterSystems IRIS client artifacts

This repository lists the client libraries and drivers InterSystems offers for connecting applications to InterSystems IRIS, organized by programming language, and describes how to install them or use them in your projects.

• Java, including JDBC
• Python, including DB-API
• .NET
• Node.js
• ODBC

For general documentation on how to use these artifacts, see the official InterSystems documentation on connecting to InterSystems IRIS.

[!IMPORTANT]
These client artifacts are currently still included in regular installations of InterSystems IRIS, in some subdirectory of install-dir/dev/, but this delivery model will be phased out by the end of 2027. From that point on, the client artifacts will only be available through the direct distribution channels described below.

[!NOTE]
Previous versions of this repository included copies of several additional client artifacts. These are now available through secure, direct distribution channels as described below, including the latest versions compatible with your IRIS server version.
We are no longer maintaining copies of such artifacts on this page.

Java

Java client artifacts are published to Maven Central under the com.intersystems group ID.

Artifacts

Installing Maven

These artifacts are normally consumed through Apache Maven, a build tool that downloads dependencies for you. If you don’t have it yet:

• Download Maven
• Installation instructions
• Maven in 5 minutes

Check your installation with mvn -version.

Adding the artifacts to your project

Copy the dependency you need into the <dependencies> section of your pom.xml. Check the Maven Central pages linked above for the latest version of each artifact.

JDBC driver

    com.intersystems
    intersystems-jdbc
    3.11.0

XEP driver

    com.intersystems
    intersystems-xep
    TBC

Document API

    com.intersystems
    intersystems-document
    1.0.3

Downloading a jar file from the command line

To fetch a library as a plain jar file without setting up a project, use the Maven dependency plugin. This example downloads the JDBC driver into the current directory:

mvn dependency:copy -Dartifact=com.intersystems:intersystems-jdbc:3.11.0 -DoutputDirectory=.

Change the coordinates to download the XEP driver or the Document API instead.

Hibernate

InterSystems IRIS is supported by Hibernate ORM starting with Hibernate 7.4. This support is part of Hibernate itself and is not available as a separate artifact. See Hibernate API in the InterSystems documentation.

Python

Artifacts

Installation

Both packages are available from PyPI and install with pip:

pip install intersystems-irispython
pip install sqlalchemy-intersystems-iris

You can also add these artifact names (one per line) to a requirements.txt file and install using

pip install -r requirements.txt

We recommend installing into a virtual environment.

.NET

.NET artifacts are published on NuGet.

Artifacts

[!IMPORTANT]
InterSystems recommends using Entity Framework or ADO.NET for building Object-oriented applications in .NET.
The .NET Binding option previously included with Caché and Ensemble is discontinued on IRIS, and available for compatibility purposes only, with support on a best-effort basis. Documentation for the .NET binding is only available in the Caché and Ensemble documentation library.

Installation

Install a package with the .NET CLI:

dotnet add package InterSystems.Data.IRISClient

or from the Visual Studio Package Manager Console:

Install-Package InterSystems.Data.IRISClient

Replace the package name with any of the packages listed above.

Node.js

Artifacts

Installing npm

npm is the package manager that comes with Node.js. If you don’t have it yet:

• Download and install Node.js and npm

Check your installation with node -v and npm -v.

Installation

npm install @intersystems/intersystems-iris-native

ODBC

There is no specific standard repository for distributing ODBC drivers. We recommend downloading them from the InterSystems download portal. See the InterSystems Documentation for more about establishing ODBC connections.

[!NOTE]
We occasionally make recent copies of the ODBC driver available through this repository for users of our community edition or cloud services that do not yet have an InterSystems SSO account.
This is on a courtesy basis only and not a commitment.