Hierarchy

Methods

  • Delete instances

     await client.instances.delete([
    {
    instanceType: "node",
    externalId: "node-external-id",
    space: "node-space",
    },
    ]);

    Parameters

    • items: {
          externalId: string;
          instanceType: "node" | "edge";
          space: string;
      }[]

    Returns Promise<{}>

  • Query instances

     const response = await client.instances.query({
    with: {
    result_set_1: {
    nodes: {
    filter: {
    equals: {
    property: ['node', 'externalId'],
    value: "node-external-id",
    },
    },
    },
    },
    },
    select: {
    result_set_1: {},
    },
    });

    // With debug notices for performance analysis
    const debugResponse = await client.instances.query({
    with: {
    result_set_1: {
    nodes: {
    filter: {
    equals: { property: ['node', 'externalId'], value: 'node-external-id' },
    },
    },
    },
    },
    select: { result_set_1: {} },
    debug: {},
    });

    // Profile mode: deep analysis (requires `emitResults: false`)
    const profileResponse = await client.instances.query({
    with: { result_set_1: { nodes: {} } },
    select: { result_set_1: {} },
    debug: { emitResults: false, profile: true, timeout: 30000 },
    });

    Parameters

    Returns Promise<QueryResponse>

  • Sync instances

     const response = await client.instances.sync({
    with: {
    result_set_1: {
    nodes: {
    filter: {
    equals: {
    property: ['node', 'externalId'],
    value: "node-external-id",
    },
    },
    },
    },
    },
    select: {
    result_set_1: {},
    },
    });

    // With debug notices for performance analysis
    const debugResponse = await client.instances.sync({
    with: { result_set_1: { nodes: {} } },
    select: { result_set_1: {} },
    debug: {},
    });

    Parameters

    Returns Promise<QueryResponse>