Migrator

Ultipa Migrator is a cross-platform command line tool used for migrating or copying an entire graphset or portions of it across different Ultipa Graph instances or within the same instance.

Prerequisites

• A command line terminal that is compatible with your operating system:
  • Linux or MacOS: bash, zsh, tcsh.
  • Windows: PowerShell.
• A version of Ultipa Migrator (Windows/MacOS/Linux) compatible with your operating system.

Examples given in this manual are demonstrated in PowerShell on Windows.

Prepare the Configuration File

Generate the sample

Bash
./ultipa-migrator.exe -sample

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

Modify configuration file

The content of the sample config.yml file is as follows, modify it according to your needs.

config.yml
# Source server configuration
from:
  hosts: 192.168.1.xx:60061
  username: root
  password: root
  graph: SourceGraphName

# Target server configuration
to:
  hosts: 192.168.2.xx:60061
  username: root
  password: root
  graph: TargetGraphName

# Migrate data by UQL (optional)
# Supported return types: NODE, EDGE, PATH
uql: ""

# Other settings
normal:
  batchsize: 10000
  threads: 10
  # The maximum time (in seconds) allowed to copy data of one schema
  timeout: 3000
  # If true, LTE-ed properties in the source graphset will also be loaded to memory in the target graphset
  lte: true
  # If true, indexes and full-text indexes in the source graphset will also be created on disk in the target graphset
  index: true

Source server configuration

Key: from

Target server configuration

Key: to

Migrate data by UQL

Example:

config.yml
# Migrate data by UQL (optional)
# Supported returned types: NODE, EDGE, PATH
# Migrate only 100 nodes whose schema is user
uql: "find().nodes({@user}) as nodes return nodes{*} limit 100"

Note that the complete graph structure (including all schemas and properties) will still be created for the target graphset.

Other settings

Key: normal

Execute Migration

The migration runs based on the configuration file specified by the -config parameter, which is supposed to create a new graphset in the target server and copy the structure and data from the source graphset.

Migrate using a configuration file (e.g., config.yml) saved in the same directory:

Bash
./ultipa-migrator.exe -config config.yml

Migrate using a configuration file (e.g., migrate0212.yml) saved in another directory:

Bash
./ultipa-migrator.exe -config C:\Users\johndoe\Desktop\migrate0212.yml

Generate Graph and Structure Creation UQLs

Bash
./ultipa-migrator.exe -config migrate0212.yml -gen_struct_uql

A .uql file will be generated and saved in the same directory as ultipa-migrator.exe, containing all the UQL statements for creating the source graphset and its structure (schemas and properties) specified in the configuration file. Migration is not performed when using the -gen_struct_uql parameter.

Show Version

Bash
./ultipa-migrator.exe -version

Show Help

Bash
./ultipa-migrator.exe -help

Parameters