Skip to content

Commit

Permalink
DOC-1787-endpoints-36-to-38
Browse files Browse the repository at this point in the history
  • Loading branch information
Victor Lee authored and Victor Lee committed Jun 22, 2023
1 parent 9a76d08 commit 7593c1b
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions modules/API/pages/built-in-endpoints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -642,9 +642,14 @@ Response::

=== Rebuild graph engine

`GET /rebuildnow/\{graph_name}` or `POST /rebuildnow/\{graph_name}`
`GET /rebuildnow/\{graph_name}` or

In TigerGraph, when new data is being loaded into the graph (such as new vertices or edges), data is first stored in memory before it is saved to disk permanently. TigerGraph runs a rebuild of the Graph Processing Engine (GPE) to commit the data in memory to disk every 30 seconds, but you can also call this endpoint to trigger a rebuild immediately.
`POST /rebuildnow/\{graph_name}`

xref:tigergraph-server:reference:list-of-privileges.adoc[*Required privilege*]: Global-level UPDATE_DATA

When new data is being loaded into the graph (such as new vertices or edges), data is first stored in memory before it is saved to disk permanently.
TigerGraph runs a rebuild of the Graph Processing Engine (GPE) to commit the data in memory to disk every 30 seconds, but you can also call this endpoint to trigger a rebuild immediately.

==== Parameters

Expand Down Expand Up @@ -698,7 +703,9 @@ cat finished.summary.txt

=== Check deleted vertices

[.line-through]#`GET /deleted_vertex_check`#
`GET /deleted_vertex_check`

xref:tigergraph-server:reference:list-of-privileges.adoc[*Required privilege*]: Global-level DELETE_DATA

In certain rare cases, TigerGraph's Graph Processing Engine (GPE) and Graph Storage Engine (GSE) might be out of sync on vertex deletion information. When this happens, some vertices might exist on one of the components, but not the other. Even though these errors are exceedingly rare, TigerGraph provides an endpoint that allows you to check the deleted vertices on GSE and GPE to see if they are out of sync.

Expand Down Expand Up @@ -1128,7 +1135,9 @@ None.

`+POST /ddl/{graph_name}+`

This endpoint is for loading data into a graph. It submits data as an HTTP request payload, to be loaded into the graph by the DDL Loader. The data payload can be formatted as generic CSV or JSON. For more details, please see xref:gsql-ref:ddl-and-loading:system-and-language-basics.adoc[GSQL Language Reference Part 1 - Defining Graphs and Loading Data].
xref:tigergraph-server:reference:list-of-privileges.adoc[*Required privilege*]: Graph-level EXECUTE_LOADINGJOB

This endpoint is for loading data into a graph. It submits data as an HTTP request payload, to be loaded into the graph by the DDL Loader. The data payload can be formatted as generic CSV or JSON. For more details, please see xref:gsql-ref:basics:system-and-language-basics.adoc[GSQL Language Reference Part 1 - Defining Graphs and Loading Data].

If the loading job references multiple files, multiple HTTP requests are needed to complete the loading job since you can only provide data for one filename variable at a time. The loading job will skip the `LOAD` statements referencing filename variables that the request didn't provide data for.

Expand Down Expand Up @@ -3287,6 +3296,8 @@ No Parameters.

`+GET /abortquery/{graph_name}+`

xref:tigergraph-server:reference:list-of-privileges.adoc[*Required privilege*]: Graph-level DELETE_DATA

This endpoint safely aborts a selected query by ID or all queries of an endpoint by endpoint URL of a graph.

If you are running a TigerGraph cluster, this endpoint only allows you to abort a query sent to the requested node, not any query in the cluster.
Expand Down

0 comments on commit 7593c1b

Please sign in to comment.