jobs

Creates, updates, deletes, gets or lists a jobs resource.

Overview

Name	jobs
Type	Resource
Id	cloudflare.r2.jobs

Fields

The following fields are returned by SELECT queries:

get

Job details

Name	Datatype	Description
id	string
createdAt	string
finishedAt	string
overwrite	boolean
source	object	(title: S3SourceResponseSchema)
status	string	(running, paused, aborted, completed)
target	object	(title: R2TargetResponseSchema)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, job_id		Retrieves detailed status and configuration for a specific R2 Super Slurper migration job.
create	insert	account_id		Creates a new R2 Super Slurper migration job to transfer objects from a source bucket (e.g. S3, GCS, R2) to R2.
abort_all	replace	account_id		Cancels all running R2 Super Slurper migration jobs for the account. Any objects in the middle of a transfer will finish, but no new objects will start transferring.
slurper_delete_job	delete	account_id, job_id		Deletes a completed, aborted, or errored R2 Super Slurper migration job. Active jobs cannot be deleted.
abort	exec	account_id, job_id		Cancels a specific R2 Super Slurper migration job. Any objects in the middle of a transfer will finish, but no new objects will start transferring.
pause	exec	account_id, job_id		Pauses a running R2 Super Slurper migration job. The job can be resumed later to continue transferring.
resume	exec	account_id, job_id		Resumes a paused R2 Super Slurper migration job, continuing the transfer from where it stopped.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
job_id	string	The job ID.

SELECT examples

get

Retrieves detailed status and configuration for a specific R2 Super Slurper migration job.

SELECT
id,
createdAt,
finishedAt,
overwrite,
source,
status,
target
FROM cloudflare.r2.jobs
WHERE account_id = '{{ account_id }}' -- required
AND job_id = '{{ job_id }}' -- required
;

INSERT examples

create

Creates a new R2 Super Slurper migration job to transfer objects from a source bucket (e.g. S3, GCS, R2) to R2.

INSERT INTO cloudflare.r2.jobs (
overwrite,
source,
target,
account_id
)
SELECT 
{{ overwrite }},
'{{ source }}',
'{{ target }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: jobs
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the jobs resource.
  - name: overwrite
    value: {{ overwrite }}
    default: true
  - name: source
    value:
      bucket: "{{ bucket }}"
      endpoint: "{{ endpoint }}"
      keys:
        - "{{ keys }}"
      pathPrefix: "{{ pathPrefix }}"
      region: "{{ region }}"
      secret:
        accessKeyId: "{{ accessKeyId }}"
        secretAccessKey: "{{ secretAccessKey }}"
      vendor: "{{ vendor }}"
      jurisdiction: "{{ jurisdiction }}"
  - name: target
    value:
      bucket: "{{ bucket }}"
      jurisdiction: "{{ jurisdiction }}"
      secret:
        accessKeyId: "{{ accessKeyId }}"
        secretAccessKey: "{{ secretAccessKey }}"
      vendor: "{{ vendor }}"

REPLACE examples

abort_all

Cancels all running R2 Super Slurper migration jobs for the account. Any objects in the middle of a transfer will finish, but no new objects will start transferring.

REPLACE cloudflare.r2.jobs
SET 
-- No updatable properties
WHERE 
account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

slurper_delete_job

Deletes a completed, aborted, or errored R2 Super Slurper migration job. Active jobs cannot be deleted.

DELETE FROM cloudflare.r2.jobs
WHERE account_id = '{{ account_id }}' --required
AND job_id = '{{ job_id }}' --required
;

Lifecycle Methods

abort

Cancels a specific R2 Super Slurper migration job. Any objects in the middle of a transfer will finish, but no new objects will start transferring.

EXEC cloudflare.r2.jobs.abort 
@account_id='{{ account_id }}' --required, 
@job_id='{{ job_id }}' --required
;

pause

Pauses a running R2 Super Slurper migration job. The job can be resumed later to continue transferring.

EXEC cloudflare.r2.jobs.pause 
@account_id='{{ account_id }}' --required, 
@job_id='{{ job_id }}' --required
;

resume

Resumes a paused R2 Super Slurper migration job, continuing the transfer from where it stopped.

EXEC cloudflare.r2.jobs.resume 
@account_id='{{ account_id }}' --required, 
@job_id='{{ job_id }}' --required
;