Job

Overview

Certain GQL operations, such as schema dropping, projection creation, and algorithm writeback, are designed to run as back-end jobs. The results of some jobs, such as files generated by algorithms, are stored in the graphs on which they are executed and can be retrieved later, unless cleared.

Showing Jobs

To retrieve all jobs in the current graph:

GQL
SHOW JOB

To retrieve the job with id 83 in the current graph:

GQL
SHOW JOB 83

It returns the following information for each job:

Field	Description
`job_id`	Job ID. Some jobs have sub-jobs with ids `<jobId>_1`,`<jobId>_2`, and so on.
`graph_name`	The graph on which the job executes.
`type`	Job type, such as `CREATE_INDEX`, `CACHE`, `COMPACT` etc.
`query`	Query of the job.
`status`	Job status, which can be `FINISHED`, `RUNNING`, `STOPPING`, `STOPPED` or `FAILED`.
`err_msg`	Error message, if any, encountered during the job's execution.
`result`	Results generated by the job, such as output files or statistical summaries from an algorithm.
`start_time`	Start time of the job.
`end_time`	End time of the job.
`progress`	Progress updates for the job, such as indications that the write operation has been started.

Stopping Jobs

To stop the running job with id 83 in the current graph:

GQL
STOP JOB 83

NOTE

Certain job types cannot be stopped once they are running. These include COMPACT, CREATE_INDEX, CREATE_FULLTEXT, CREATE_CONSTRAINT, MIGRATION, and CREATE_BACKUP.

Deleting Jobs

To delete all jobs in the current graph that are not running:

GQL
DELETE JOB *

To delete the job with ID 83 in the current graph:

GQL
DELETE JOB 83

Scheduled Jobs

A scheduled job automatically executes a GQL query at recurring intervals or cron-based schedules.

Creating a Scheduled Job

Using a cron expression (standard 5-field format):

GQL
CREATE SCHEDULED JOB daily_cleanup ON GRAPH myGraph
SCHEDULE CRON '0 2 * * *'
AS 'MATCH (n:TempNode) DELETE n'

Using an interval:

GQL
CREATE SCHEDULED JOB hourly_stats ON GRAPH myGraph
SCHEDULE EVERY 1 HOUR
AS 'MATCH (n:User) RETURN count(n)'

Supported interval units: SECOND, MINUTE, HOUR, DAY.

To create a scheduled job in a disabled state:

GQL
CREATE SCHEDULED JOB my_job ON GRAPH myGraph
SCHEDULE EVERY 30 MINUTE DISABLED
AS 'MATCH (n:Log) WHERE n.created < local_datetime("2025-01-01") DELETE n'

Showing Scheduled Jobs

GQL
SHOW SCHEDULED JOB

Dropping a Scheduled Job

GQL
DROP SCHEDULED JOB daily_cleanup

Pausing and Resuming

GQL
PAUSE SCHEDULED JOB daily_cleanup
RESUME SCHEDULED JOB daily_cleanup