The InterSystems IRIS Native API Module. Tutorials: Tutorial for Node.js Native API Classes Connection Iris IRISGlobalNode IRISList IRISObject IRISReference Iterator Methods # (static) connect(connectionInfo, callbackopt) → {module:"intersystems-iris".Connection} Function alias for createConnection class. Parameters: Name Type Attributes Description connectionInfo connectionInfo Object containing connection arguments host, port, namespace, user, password, logfile and sharedmemory callback onConnectionCallback <optional> A callback to call when the connection is established. When provided, the createConnection becomes asynchronous. Throws: If invalid hostname (length 0 or above 255) If invalid port number (port < 0 || port > 65536) If invalid namespace (length 0 or above 255) If timeout < 0 If logfile length > 255 If sslconfig file length > 255 If it failed to connect to server If it failed to send a message to the server If server protocol is below 61 (min version) If unsupported server locale If access is denied Returns: Type module:"intersystems-iris".Connection # (static) createConnection(connectionInfo, callbackopt) → {module:"intersystems-iris".Connection} An IRIS Native function to establish a connection to an InterSystems IRIS Server instance. This method returns an instance of Connection class. Parameters: Name Type Attributes Description connectionInfo connectionInfo Object containing connection arguments host, port, namespace, user, password, logfile and sharedmemory callback onConnectionCallback <optional> A callback to call when the connection is established. When provided, the createConnection becomes asynchronous. Throws: If invalid hostname (length 0 or above 255) If invalid port number (port < 0 || port > 65536) If invalid namespace (length 0 or above 255) If timeout < 0 If logfile length > 255 If sslconfig file length > 255 If it failed to connect to server If it failed to send a message to the server If server protocol is below 61 (min version) If unsupported server locale If access is denied Returns: Type module:"intersystems-iris".Connection Type Definitions # connectionInfo The object that describes a connection and is passed as an argument to createConnection function. Type: Object Properties Name Type Description host string the host address of the IRIS instance port number the port number (integer value expected) of the IRIS instance ns string the IRIS Namespace user string user name pwd string password logfile string the logging file of the communication with the IRIS instance timeout number connection timeout (seconds) (integer value expected) sharedmemory boolean use shared memory if available, default is true sslconfig boolean | string whether or not to establish this connection with an ssl context, default is false. If a string provided then this is the name of the ssl configuration to use for the secure connection from the ones defined in SSLDefs.ini (Unix only) # onConnectionCallback(error, connection) Callback called when a connection to the IRIS instance is established. Parameters: Name Type Description error Error connection module:"intersystems-iris".Connection