This page demonstrates the process of exporting data from an Ultipa graphset to CSV file(s).

Generate Configuration File

Execute the following command in your command line tool.

./ultipa-exporter --sample

The export.sample.yml file will be generated in the same directory as ultipa-exporter.exe. If a export.sample.yml file already exists in that directory, it will be overwritten.

Modify Configuration File

The configuration file consists of several sections. Modify the configuration file according to your needs.

If SFTP is not used, remove the section involving SFTP server configurations from the configuration file below.

# Ultipa server configurations
server:
  # Host IP/URI and port
  # If it is a cluster, separate hosts with commas, i.e., "<ip1>:<port1>,<ip2>:<port2>,<ip3>:<port3>"
  host: "10.11.22.33:1234"
  username: "admin"
  password: "admin12345"
  # The target graphset from which data will be exported
  graphset: "trading"
  # Path of the certificate file for TLS (optional)
  crt: ""

# SFTP server configurations
sftp:
  # Host IP/URI and port
  host: "10.12.23.34:4567"
  username: "yourUsername"
  password: "yourPassword"
  # SSH Key path for SFTP (if set, password will not be used)
  key: "./my_secret"  

# Node configurations
nodeConfig:
  # Specify the schema of the data to be exported. Use "*" to include all schemas with all properties
  - schema: "customer"
  # Specify the properties to be exported. If not set, all properties will be exported
    properties:
      - name: "_id"
      - name: "name"
      - name: "level"
  - schema: "merchant"

# Edge configurations
edgeConfig:
  - schema: "transaction"

# Global settings
settings:
  # Data export supports csv/json/jsonl/graphml
  fileType: csv
  # Specify whether to include a header in the file
  writeHeader: true
  # Specify the path to output the exported file. If SFTP is configured, the SFTP path will be used
  outPath: "./export/data"
  # Stops the exporting process when error occurs
  stopWhenError: true
  # The maximum threads
  threads: 32
  # The maximum size (in MB) of each packet
  maxPacketSize: 40
  # The gRPC timeout limit (in seconds) for exporting large datasets
  timeout: 1000
  # Timestamp value unit, supports ms/s
  timestampUnit: s

Configuration Items

Ultipa server configurations

SFTP server configurations

Node/Edge configurations

Global settings

Execute Import

The export process uses the configuration file specified by the -config parameter to export data from Ultipa graph database to CSV file(s).

./ultipa-exporter --config export.sample.yml