irisnative Reference¶
IRIS Native API for Python.
This module provides highly efficient and lightweight access to the IRIS Global Module from Python.
Classes
connection |
A connection to an IRIS instance. |
iris |
A way to execute basic ObjectScript commands on an IRIS server. |
iterator |
An iterator over the immediate children of a global node. |
Methods
createConnection |
Return a new open connection to an IRIS instance. |
createIris |
Return a new irisnative.iris object that uses the given connection. |
-
irisnative.
createConnection
()¶ Return a new open connection to an IRIS instance.
- createConnection(hostname,port,namespace,username,password,
- timeout,sharedmemory,logfile)
- createConnection(connectionstr,username,password,
- timeout,sharedmemory,logfile)
Parameters may be passed by position or keyword.
Parameters: - hostname (Unicode string) – IRIS instance URL
- port (int/long) – IRIS superserver port number
- namespace (Unicode string) – IRIS namespace
- username (Unicode string) – IRIS user
- password (Unicode string) – IRIS user password
- timeout (int/long, optional) – maximum number of milliseconds to wait while attempting the connection. defaults to 10000
- sharedmemory (bool, optional) – set to True to attempt a shared memory connection when the hostname is localhost or 127.0.0.1. set to false to force a connection over TCP/IP. defaults to True.
- logfile (Unicode string, optional) – client-side log file path. the maximum path length is 255 ASCII characters.
- connectionstr (Unicode string, optional) – “hostname:port/namespace”. use this instead of the hostname, port, and namespace
Returns: A new client connection to an IRIS server
Return type:
-
irisnative.
createIris
()¶ Return a new irisnative.iris object that uses the given connection.
createIris(conn)
Throw an exception if the connection is closed.
Parameters: conn (irisnative.connection) – connection object to use Returns: A new iris object that uses the given connection. Return type: irisnative.iris