Data Export

This section introduces methods for exporting nodes and edges from graphs.

export()

Exports nodes or edges from the graph.

Parameters

• exportRequest: ExportRequest: Configurations for the export request, including attributes dbType, schema, selectProperties and graph.
• listener: RequestType.ExportListener: The callback function that gets executed when data is exported.

Returns

• Void.

// Exports 'account' nodes in the graph 'miniCircle'

const exportRequest = new ExportRequest();
exportRequest.setDbType(DBType.DBNODE);
exportRequest.setSchema("account");
exportRequest.setGraph("miniCircle");
exportRequest.addSelectProperties("_id");
exportRequest.addSelectProperties("name");
exportRequest.addSelectProperties("year");
exportRequest.setLimit(100);

const allNodes: any[] = [];

await conn.export(exportRequest, {
  stream: {
    onStart: () => {
      console.log("Export started");
    },
    onData: async (data) => {
      allNodes.push(...data);
    },
    onEnd: () => {
      console.log("Export completed. Total nodes:", allNodes.length);

      if (allNodes.length === 0) {
        console.log("No data received.");
        return;
      }

      try {
        const csv = parse(allNodes);
        const filePath = "./account_nodes.csv";
        fs.writeFileSync(filePath, csv, "utf8");
        console.log(`CSV export completed: ${filePath}`);
      } catch (err) {
        console.error("Failed to write a row to CSV:", err);
      }
    },
  },
});

Export started
Export finished. Total nodes: 111
CSV export completed: ./account_nodes.csv

The file account_nodes.csv is exported to the same directory as the file you executed.

Full Example

import { UltipaDriver } from "@ultipa-graph/ultipa-driver";
import { ULTIPA } from "@ultipa-graph/ultipa-driver/dist/types";
import {
  DBType,
  ExportRequest,
} from "@ultipa-graph/ultipa-driver/src/proto/ultipa_pb";

import * as fs from "fs";
import { parse } from "json2csv";

let sdkUsage = async () => {
  // URI example: ultipaConfig.hosts: ["mqj4zouys.us-east-1.cloud.ultipa.com:60010"]
  const ultipaConfig: ULTIPA.UltipaConfig = {
    hosts: ["192.168.1.85:60061", "192.168.1.87:60061", "192.168.1.88:60061"],
    username: "<username>",
    password: "<password>"
  };

  const conn = new UltipaDriver(ultipaConfig);
  const isSuccess = await conn.test();
  console.log(`Connection succeeds: ${isSuccess}`);

  // Exports 'account' nodes in the graph 'miniCircle'

  const exportRequest = new ExportRequest();
  exportRequest.setDbType(DBType.DBNODE);
  exportRequest.setSchema("account");
  exportRequest.setGraph("miniCircle");
  exportRequest.addSelectProperties("_id");
  exportRequest.addSelectProperties("name");
  exportRequest.addSelectProperties("year");
  exportRequest.setLimit(100);

  const allNodes: any[] = [];

  await conn.export(exportRequest, {
    stream: {
      onStart: () => {
        console.log("Export started");
      },
      onData: async (data) => {
        allNodes.push(...data);
      },
      onEnd: () => {
        console.log("Export completed. Total nodes:", allNodes.length);

        if (allNodes.length === 0) {
          console.log("No data received.");
          return;
        }

        try {
          const csv = parse(allNodes);
          const filePath = "./account_nodes.csv";
          fs.writeFileSync(filePath, csv, "utf8");
          console.log(`CSV export completed: ${filePath}`);
        } catch (err) {
          console.error("Failed to write a row to CSV:", err);
        }
      },
    },
  });
};

sdkUsage().catch(console.error);