Overview

Label reading and enumeration operations provide comprehensive access to label data within your graph database. These operations enable you to retrieve individual labels, fetch multiple labels by their GUIDs, read all labels in a tenant, and perform advanced enumeration with search capabilities. Understanding these operations is essential for effective label management, data analysis, and application development.

Key capabilities include:

Reading individual labels by their unique GUID
Retrieving multiple specific labels using comma-separated GUIDs
Reading all labels within a tenant for comprehensive data access
Enumerating labels with pagination support for large datasets
Advanced search and filtering capabilities for targeted label retrieval

These operations support various use cases such as label data validation, categorization analysis, bulk operations, and integration with external systems that require label information.

Read Individual Label

Read a single label using GET: /v1.0/tenants/{tenant-guid}/labels/{label-guid}. This endpoint retrieves a specific label by its unique identifier, providing complete label information including metadata and timestamps.

curl --location 'http://localhost:8701/v1.0/tenants/00000000-0000-0000-0000-000000000000/labels/00000000-0000-0000-0000-000000000000' \
--header 'Authorization: ••••••'

import { LiteGraphSdk } from "litegraphdb";

var api = new LiteGraphSdk(
  "http://localhost:8701/",
  "<Tenant-Guid>",
  "*******"
);

const readLabel = async () => {
  try {
    const data = await api.Label.read("<label-guid>");
    console.log(data, "check data");
  } catch (err) {
    console.log("err:", JSON.stringify(err));
  }
};

import litegraph

sdk = litegraph.configure(
    endpoint="http://localhost:8701",
    tenant_guid="Tenant-Guid",
    access_key="******",
)

def retrieve_label():
    label = litegraph.Label.retrieve(guid="label-guid")
    print(label)

retrieve_label()

using LiteGraph;
using LiteGraph.GraphRepositories.Sqlite;

LiteGraphClient liteGraph = new LiteGraphClient(new SqliteGraphRepository("litegraph.db"));
liteGraph.InitializeRepository();
LabelMetadata response = liteGraph.Label.ReadByGuid(Guid.Parse("<tenant-guid>"), Guid.Parse("<label-guid>"));

Response

Upon successful retrieval, the API returns a 200 OK status code with the label object in the response body.

{
  "GUID": "00000000-0000-0000-0000-000000000000",
  "TenantGUID": "00000000-0000-0000-0000-000000000000",
  "GraphGUID": "00000000-0000-0000-0000-000000000000",
  "NodeGUID": null,
  "EdgeGUID": null,
  "Label": "label",
  "CreatedUtc": "2024-12-27T18:12:38.653402Z",
  "LastUpdateUtc": "2024-12-27T18:12:38.653402Z"
}

Read Multiple Labels by GUIDs

Retrieve multiple specific labels using GET: /v1.0/tenants/{tenant-guid}/labels?guids=<label1-guid>,<label2-guid>. This endpoint allows you to fetch multiple labels in a single request by providing comma-separated GUIDs, which is efficient for retrieving specific label sets without fetching all labels.

Response

Upon successful retrieval, the API returns a 200 OK status code with an array of label objects in the response body.

curl --location 'http://localhost:8701/v1.0/tenants/00000000-0000-0000-0000-000000000000/labels?guids=00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001' \
--header 'Authorization: ••••••'

import { LiteGraphSdk } from "litegraphdb";

var api = new LiteGraphSdk(
  "http://localhost:8701/",
  "<Tenant-Guid>",
  "*******"
);

const readManyLabels = async () => {
  try {
    const data = await api.Label.readMany([labelGuid]);
    console.log(data, "check data");
  } catch (err) {
    console.log("err:", JSON.stringify(err));
  }
};

import litegraph

sdk = litegraph.configure(
    endpoint="http://localhost:8701",
    tenant_guid="Tenant-Guid",
    access_key="******",
)

def retrieve_multiple_label():
    labels = litegraph.Label.retrieve_many(guids=["label-guid-1","label-guid-2"])
    print(labels)

retrieve_multiple_label()

using LiteGraph;
using LiteGraph.GraphRepositories.Sqlite;

LiteGraphClient liteGraph = new LiteGraphClient(new SqliteGraphRepository("litegraph.db"));
liteGraph.InitializeRepository();
IEnumerable<LabelMetadata> response = liteGraph.Label.ReadByGuids(Guid.Parse("<tenant-guid>"), 
                                                                  new List<Guid>()
                                                                  {
                                                                      Guid.Parse("<label-guid-1>"),
                                                                      Guid.Parse("<label-guid-2>"),
                                                                  });

[
  {
    "GUID": "00000000-0000-0000-0000-000000000000",
    "TenantGUID": "00000000-0000-0000-0000-000000000000",
    "GraphGUID": "00000000-0000-0000-0000-000000000000",
    "NodeGUID": null,
    "EdgeGUID": null,
    "Label": "label",
    "CreatedUtc": "2024-12-27T18:12:38.653402Z",
    "LastUpdateUtc": "2024-12-27T18:12:38.653402Z"
  },
  {
    "GUID": "00000000-0000-0000-0000-000000000001",
    "TenantGUID": "00000000-0000-0000-0000-000000000000",
    "GraphGUID": "00000000-0000-0000-0000-000000000000",
    "NodeGUID": null,
    "EdgeGUID": null,
    "Label": "label2",
    "CreatedUtc": "2024-12-27T18:12:38.653402Z",
    "LastUpdateUtc": "2024-12-27T18:12:38.653402Z"
  }
]

Read All Labels

Retrieve all labels within a tenant using GET: /v1.0/tenants/{tenant-guid}/labels. This endpoint provides comprehensive access to all label data in your tenant, useful for data analysis, backup operations, and complete label inventory management.

curl --location 'http://localhost:8701/v1.0/tenants/00000000-0000-0000-0000-000000000000/labels' \
--header 'Authorization: ••••••'

import { LiteGraphSdk } from "litegraphdb";

var api = new LiteGraphSdk(
  "http://localhost:8701/",
  "<Tenant-Guid>",
  "*******"
);

const readAllLabels = async () => {
  try {
    const data = await api.Label.readAll();
    console.log(data, "check data");
  } catch (err) {
    console.log("err:", JSON.stringify(err));
  }
};

import litegraph

sdk = litegraph.configure(
    endpoint="http://localhost:8701",
    tenant_guid="Tenant-Guid",
    access_key="******",
)

def retrieve_all_label():
    labels = litegraph.Label.retrieve_all()
    print(labels)

retrieve_all_label()

using LiteGraph;
using LiteGraph.GraphRepositories.Sqlite;

LiteGraphClient liteGraph = new LiteGraphClient(new SqliteGraphRepository("litegraph.db"));
liteGraph.InitializeRepository();
IEnumerable<LabelMetadata> response = liteGraph.Label.ReadMany(Guid.Parse("<tenant-guid>"), 
                                                               Guid.Parse("<graph-guid>"),
                                                               Guid.Parse("<node-guid>"),
                                                               Guid.Parse("<edge-guid>"),
                                                               label:"label");

Response

Upon successful retrieval, the API returns a 200 OK status code with an array of all label objects in the response body.

[
  {
    "GUID": "00000000-0000-0000-0000-000000000000",
    "TenantGUID": "00000000-0000-0000-0000-000000000000",
    "GraphGUID": "00000000-0000-0000-0000-000000000000",
    "NodeGUID": null,
    "EdgeGUID": null,
    "Label": "label",
    "CreatedUtc": "2024-12-27T18:12:38.653402Z",
    "LastUpdateUtc": "2024-12-27T18:12:38.653402Z"
  }
]

Read All Label In Tenant

Retrieves all label metadata within a tenant using GET: /v1.0/tenants/{tenant-guid}/labels/all. Returns a list of all label metadata objects in the specified tenant, with support for ordering and pagination.

import { LiteGraphSdk } from "litegraphdb";

var api = new LiteGraphSdk(
  "http://localhost:8701/",
  "<Tenant-Guid>",
  "*******"
);

const LabelReadAllInTenant = async () => {
  try {
    const data = await api.Label.readAllInTenant();
    console.log(data, 'chk data');
  } catch (err) {
    console.log('err:', JSON.stringify(err));
  }
};