volume_instance_backup_schedules

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

Overview

Name	volume_instance_backup_schedules
Type	Resource
Id	railway.storage.volume_instance_backup_schedules

Fields

The following fields are returned by SELECT queries:

list

One row per VolumeInstanceBackupSchedule.

Name	Datatype	Description
id	string
name	string
created_at	string (date-time)
cron	string
kind	string	(DAILY, MONTHLY, WEEKLY)
retention_seconds	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	volume_instance_id		List backups schedules of a volume instance. Backed by the Railway GraphQL query volumeInstanceBackupScheduleList.
update	update	kinds, volume_instance_id		Manage schedule for backups of a volume instance. Backed by the Railway GraphQL mutation volumeInstanceBackupScheduleUpdate.

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
volume_instance_id	string	The id of the volume instance to list the schedules of.
kinds	array	The frequency/retention of the backups.

SELECT examples

list

List backups schedules of a volume instance. Backed by the Railway GraphQL query volumeInstanceBackupScheduleList.

SELECT
id,
name,
created_at,
cron,
kind,
retention_seconds
FROM railway.storage.volume_instance_backup_schedules
WHERE volume_instance_id = '{{ volume_instance_id }}' -- required
;

UPDATE examples

update

Manage schedule for backups of a volume instance. Backed by the Railway GraphQL mutation volumeInstanceBackupScheduleUpdate.

UPDATE railway.storage.volume_instance_backup_schedules
SET 

WHERE 
kinds = '{{ kinds }}' --required
AND volume_instance_id = '{{ volume_instance_id }}' --required
RETURNING
result;