InterSystems.Data.Document 1.1.0

InterSystems Document-Dotnet

Document-dotnet allows for interaction with IRIS using Documents (JSONObjects and JSONArrays).

Getting started

Install the package

Install the IRISClient library for .NET with NuGet

dotnet add package InterSystems.Data.Document

Prerequisites

You need an IRIS instance to interact with while using this package. The IRIS instance does not need to be on the same machine as the project using this package, but the project must be able to connect to the IRIS instance.

Examples

using InterSystems.Document;

// Establish IRIS connection parameters
DataSource dataSource = DataSource.CreateDataSource();
string host = "localhost";
string port = "1972";
string ns = "USER";
string user = "_system";
string pwd = "SYS";
string connectionString = $"Server={host}; Port={port}; Namespace={ns}; User ID={user}; Password={pwd}";
dataSource.SetConnectionString(connectionString);

// Create a collection object (or retrieves if it already exists)
Collection collection = Collection.GetCollection(dataSource, "MyCollection");

// Create documents from JSON data, Object or Array
string jsonString1 = "{\"firstName\":\"John\",\"lastname\":\"Smith\",\"age\":30,\"employed\":true}";
string jsonString2 = "[\"green\",\"blue\",\"pink\"]";
Document doc1 = Document.FromJSONString(jsonString1);
Document doc2 = Document.FromJSONString(jsonString2);

// Documents can also be created directly
JSONObject obj = new JSONObject();
obj["firstName"] = "Mary";
obj["age"] = 50;

JSONArray arr = new JSONArray();
arr.Add("red");
arr.Add("blue");
arr.Add("green");

// Add the Documents to the collection
List<Document> docs = new List<Document> { doc1, doc2, obj, arr };
List<string> ids = collection.Insert(docs).GetIds();

long size = collection.Size();
Console.WriteLine($"Collection size: {size}");

// Retrieve objects and arrays from the collection using bracket notation or Get methods
JSONObject objReturned = (JSONObject)collection.Get(ids[0]);
string name = (string)objReturned["firstName"];
int? age = objReturned.GetInt32("age");
Console.WriteLine($"Object {ids[0]} has name {name} and is {age} years old");

JSONArray arrReturned = (JSONArray)collection.Get(ids[3]);
int arrSize = arrReturned.Size();
for (int i = 0; i < arrSize; i++)
{
    Console.WriteLine($"{i}: {arrReturned[i]}");
}

// Delete the collection
collection.Drop();

// Close the DataSource when finished
dataSource.Close();