It seems to me that for some reason this didn't make its way to the official documentation
and seems to be rather unknown though implemented already in IRIS 2020.1
Thanks to @Dan Pasco I got a hint on the classes involved.
I used the recommended sequence of how to use it.
it is all directly taken from Class Reference and I just collected it to create a first overview.
The Native API for ObjectScript follows the API used on other language platforms. It starts with a static API that allows the user to connect to an IRIS Namespace, either local or remote, using an Iris Connection. The connection interface allows the user to then instantiate the IRIS Native API class (%Net.DB.Iris). That instance can then be used to access IRIS Global Arrays, manage transactions, invoke functions and methods implemented in routines or classes, and instantiate remote iterators.
This class implements the IRIS Native API for Object Script DataSource interface.
At this time that interface consists solely of the CreateConnection method.
CreateConnection accepts url, port,namespace, user, and pwd parameters. Refer to %Net.DB.Connection for more information on these parameters. CreateConnection() returns an instance of %Net.DB.Connection.
|host||input||The host name or address, defaults to 127.0.0.1|
|port||input||The port on which to connect|
|namespace||input||The namespace to connect to|
|input||The user's name|
|timeout||input||The number of seconds to wait for the connection to be established. Optional.|
|logfile||input||The name of the file to be used for logging. If specified, connection activity will be logged to that file. Optional.|
|return||An oref referencing an instance of %Net.DB.Connection|
This class implements the IRIS Native API for Object Script Connection interface.
This class should never be instantiated directly, only through %Net.DB.DataSource using the CreateMethod() function.
The public interface for this class includes only those items specified here. All other members are internal.
|Host||property||The host specified when establishing the connection|
|Port||property||The port that this connection is connected.|
|Namespace||property||The namespace that this connection is connected.|
|Timeout||property||The timeout value specified establishing the connection|
|IsClosed||method||Returns true if this connection instance is no longer connected.|
|Close||method||Close this connection.|
|CreateIris||method||Returns an instance of %Net.DB.Iris.|
This class implements the primary set of functions IRIS Native API for Object Script.
The only other members of the IRIS Native API that are not implemented by this class
are implemented by %Net.DB.DataSource and %Net.DB.Connection.
This class should never be instantiated directly.
The proper way to instantiate this class is to invoke the CreateIris() method using an instance of %Net.DB.Connection.
Summary of methods: