native-api-command-line-client

Because of criticism by OEX reviewers, I have added more explanations
than usual. Experts may excuse rewriting class docu
This is the ObjectScript client for IRIS NativeAPI Command extension
It is not a click-and-run code but a draft that requires
adjustments for your special needs
You have to add

• your credentials for server access
• your level of error handling
  First,
  you make a connection to the target SuperServer Port

required parameters: server-ip, SuperServerPort, namespace, Username, User_password)
my defaults if not overloaded:
serverIP=“192.168.0.11”,serverPORT=61773,namespace=“USER”,username=”_SYSTEM”, password=“SYS”

do ##class(nacl.Client).Connect("192.168.0.99",41773)     

all required objects are now in your session ready for use
USER>ZWRITE
%rccdb=<OBJECT REFERENCE>[3@%Net.DB.Iris]
%rccon=<OBJECT REFERENCE>[2@%Net.DB.Connection]
with more ZWRITE you ma< dig deeper
USER>ZWRITE %rccdb
%rccdb=3@%Net.DB.Iris ; <OREF,refs=1>
+—————– general information —————
| oref value: 3
| class name: %Net.DB.Iris
| reference count: 1
+—————– attribute values ——————
+—————– swizzled references —————
| i%Connection = “”
| r%Connection = “2@%Net.DB.Connection”
+—————————————————–

Then you launch your command for remote execution

USER>write ##class(nacl.Client).Do(" quit $now() ")
66698,68259.396554358
USER>write ##class(nacl.Client).Do(" quit $ZV ")
IRIS for UNIX (Ubuntu Server LTS for x86-64 Containers) 2023.2 (Build 227U) Mon Jul 31 2023 18:04:28 EDT   

Prerequisites

Make sure you have git and Docker desktop installed.

On your target server, you need to install
https://github.com/rcemper/native-api-command-line-extension

Installation

Clone/git pull the repo into any local directory

git https://github.com/rcemper/native-api-command-line-client    

Run the IRIS container with your project:

docker-compose up -d --build    

How to Test it

docker-compose exec iris iris session iris    

A simple remote global lister

 gl ; list remote Global
   set global="^dc.MultiD"  ;; adjust as required    
#;   set a=%rccdb.Function("%ZX","","quit $LB($D("_global_",%rcc),%rcc)")
   set req="quit $LB($D("_global_",%rcc),%rcc)" 
   set a=%rccdb.ClassMethodValue("%ZX.nacl","x",req)  
   Write !,global," = ",$li(a,2)," $DATA = ",$li(a),!     
   if $li(a)#10 {    
     for {     
#;      set a=%rccdb.Function("%ZX","","q $LB($q(@$zr),@$ZR)")   
      set req="q $LB($q(@$zr),@$ZR)"   
      set a=%rccdb.ClassMethodValue("%ZX.nacl","x",req)    
      quit:$li(a)=""    
      write $li(a), " = ", ##class(%Utility).FormatString($li(a,2)),!    
      }    
    }    
 Write "-------done----------",!      

Article in DC