This page demonstrates the process of importing data from a GraphML file into an Ultipa graphset.
Generate Configuration File
Execute the following command in your command line tool and select graphml.
./ultipa-importer --sample
The import.sample.graphml.yml file will be generated in the same directory as ultipa-importer.exe. If a import.sample.graphml.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.
# Mode options: csv/json/jsonl/rdf/graphml/bigQuery/sql/kafka/neo4j/salesforce; only one mode can be used
# SQL supports mysql/postgresSQL/sqlserver/snowflake/oracle
mode: graphml
# GraphML configurations
graphml:
# The path to the GraphML file
file: "./dataset/trading.graphml"
# The value of attr.name to be used as the schema of the Ultipa graph
schema: "myschema"
# 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 new or existing graphset where data will be imported
graphset: "trading"
# If the above graphset is new, specify the shards where it will be stored
shards: "1,2,3"
# If the above graphset is new, specify the partition function (Crc32/Crc64WE/Crc64XZ/CityHash64) used for sharding
partitionBy: "Crc32"
# Path of the certificate file for TLS (optional)
crt: ""
# Global settings
settings:
# Define the path to output the log file
logPath: "./logs"
# Number of rows included in each insertion batch
batchSize: 10000
# Import mode supports insert/overwrite/upsert
importMode: insert
# Automatically create missing end nodes for edges (applicable only when importing edges)
createNodeIfNotExist: false
# Stops the importing process when error occurs
stopWhenError: false
# The maximum threads
threads: 32
# The maximum size (in MB) of each packet
maxPacketSize: 40
# Timezone for the timestamp values
# timeZone: "+0200"
# Timestamp value unit, support ms/s
timestampUnit: s
Configuration Items
GraphML configurations
Field |
Type |
Description |
|---|---|---|
file |
String | The path to the GraphML file. |
schema |
String | The value of attr.name to be used as the schema of the Ultipa graph. |
Ultipa server configurations
Field |
Type |
Description |
|---|---|---|
host |
String | IP address or URI of the target database. |
username |
String | Database username. |
password |
String | Password of the above user. |
graphset |
String | Name of the target graphset. If the specified graphset does not exist, it will be created automatically. |
shards |
String | Specifies the shards where data will be processed. |
partitionBy |
String | Specifies the patitioning algorithm, including Crc32, Crc64WE, Crc64XZ and CityHash64. |
crt |
String | Path to the certificate (CRT) file used for TLS encryption. |
Global settings
Field |
Type |
Default |
Description |
|---|---|---|---|
logPath |
String | "./logs" | The path to save the log file. |
batchSize |
Integer | 10000 | Number of nodes or edges to insert per batch. |
importMode |
String | upsert | Specifies how the data is inserted into the graph, including overwrite, insert and upsert. When updating nodes or edges, use the upsert mode to prevent overwriting existing data. |
createNodeIfNotExist |
Bool | false | Whether missing nodes are automatically created when inserting edges:true: The system automatically creates nodes that do not exist.false: The related edges will not be imported. |
stopWhenError |
Bool | false | Whether to stop the import process when an error occurs. |
threads |
Integer | 32 | The maximum number of threads. 32 is suggested. |
maxPacketSize |
Integer | 40 | The maximum size of data packets in MB that can be sent or received. |
timestampUnit |
String | s | The unit of measurement for timestamp data. Supported units are ms (milliseconds) and s (seconds). |
Execute Import
The import process uses the configuration file specified by the -config parameter to import data from a GraphML file into the target server and display it in the Ultipa graph structure.
./ultipa-importer --config import.sample.graphml.yml