Incrementally Importing Data to a Graph (2.1.14)

Function

This API is used to import data to graphs incrementally.

To ensure successful data recovery during system restarts, do not delete any graph data stored in OBS while using the graph.
The size of a single file in the import directory or the size of a single file to be imported cannot exceed 5 GB. Or the import will fail. You are advised to split the file into multiple files smaller than 5 GB before importing.

URI

POST /v2/{project_id}/graphs/{graph_id}/import-graph

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints N/A Range The value can contain up to 64 characters. Only letters and digits are allowed. Default Value N/A
graph_id	Yes	String	Definition Graph ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It is used to obtain the permission to call APIs. For how to obtain the token, see Authentication. (The token is the value of X-Subject-Token in the response header.) Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
edgeset_path	No	String	Definition Edge file directory or name. Constraints This parameter is mandatory when vertexset_path and schema_path are both left unspecified. Range N/A Default Value N/A
edgeset_format	No	String	Definition Edge dataset format. Constraints N/A Range csv txt Default Value csv
vertexset_path	No	String	Definition Vertex file directory or name. Constraints This parameter is mandatory when edgeset_path and schema_path are both left unspecified. Range N/A Default Value N/A
vertexset_format	No	String	Definition Vertex dataset format. Constraints N/A Range csv txt Default Value csv
schema_path	No	String	Definition Path of the metadata file of the new data. Constraints This parameter is mandatory when edgeset_path and vertexset_path are both left unspecified. Range N/A Default Value N/A
log_dir	No	String	Definition Directory where logs of imported graphs are stored. It is used to store data that failed to import and the detailed causes of errors. Constraints N/A Range N/A Default Value N/A
parallel_edge	No	parallel_edge object	Definition Method for handling repetitive edges. Constraints N/A Range N/A Default Value N/A
delimiter	No	String	Definition Field delimiter for CSV files. Constraints N/A Range N/A Default Value Default value: comma (,). The default element delimiter in a field of the list/set type is semicolon (;).
trim_quote	No	String	Definition Field enclosure character for CSV files. Constraints N/A Range N/A Default Value The default value is double quotes ("). It is used to enclose a field, especially when the field contains delimiters or line breaks.
offline	No	Boolean	Definition Whether to import data into the graph offline. Constraints N/A Range true: Offline import is selected. The import speed is high, but the graph is locked and cannot be read or written during the import. false: Online import is selected. Compared with offline import, online import is slower. However, the graph can be read (cannot be written) during the import. Default Value false

**Table 4** parallel_edge
Parameter	Mandatory	Type	Description
action	No	String	Definition Handling method. Constraints N/A Range allow indicates that repetitive edges are allowed. ignore indicates that subsequent repetitive edges are ignored. override indicates that the previous repetitive edges are overwritten. Default Value allow
ignore_label	No	Boolean	Definition Whether to ignore labels on repetitive edges. Constraints N/A Range true: Indicates that the repetitive edge definition does not contain the label. That is, the <source vertex, target vertex> indicates an edge, excluding the label information. false: Indicates that the repetitive edge definition contains the label. That is, the <source vertex, target vertex, label> indicates an edge. Default Value true
sort_key_column	No	String	Definition Position of the sort key in the edge file, which can only be set to lastColumn. If the edge file does not contain a sort key, this parameter is not required. Function of the sort key: Different sort key values are configured to distinguish duplicate edges (edges with the same source vertex, end vertex, and label). This parameter is required only for database edition graphs. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
job_id	String	Definition ID of an asynchronous job. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code. Range N/A
error_msg	String	Definition System prompt. If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message. Range N/A

Example Request

Incrementally import graph data. The edge file directory is testbucket/demo_movie/edges/ and the edge data set is in CSV format. The vertex file directory is testbucket/demo_movie/vertices/ and the vertex data set is in CSV format.

POST https://{Endpoint}/v2/{project_id}/graphs/{graph_id}/import-graph

{
  "edgeset_path" : "testbucket/demo_movie/edges/",
  "edgeset_format" : "csv",
  "vertexset_path" : "testbucket/demo_movie/vertices/",
  "vertexset_format" : "csv",
  "schema_path" : "testbucket/demo_movie/incremental_data_schema.xml",
  "log_dir" : "testbucket/importlogdir",
  "parallel_edge" : {
    "action" : "override",
    "ignore_label" : true
  },
  "delimiter" : ",",
  "trim_quote" : "\"",
  "offline" : false
}

Example Response

Status code: 200

Example response for a successful request

{
  "job_id" : "b4f2e9a0-0439-4edd-a3ad-199bb523b613"
}

Status code: 400

Example response for a failed request

{
  "error_msg" : "parameter format error",
  "error_code" : "GES.8013"
}

Status Codes

Return Value	Description
400 Bad Request	Request error.
401 Unauthorized	Authorization failed.
403 Forbidden	No operation permissions.
404 Not Found	No resources found.
500 Internal Server Error	Internal server error.
503 Service Unavailable	Service unavailable.