function job_scheduler_schema in Job Scheduler 8.2

Same name and namespace in other branches

1. 6 job_scheduler.install \job_scheduler_schema()
2. 7.2 job_scheduler.install \job_scheduler_schema()
3. 7 job_scheduler.install \job_scheduler_schema()

Implements hook_schema().

File

./job_scheduler.install, line 11

Schema definitions install/update/uninstall hooks.

Code

function job_scheduler_schema() {
  $schema = [];
  $schema['job_schedule'] = [
    'description' => 'Schedule of jobs to be executed.',
    'fields' => [
      'item_id' => [
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Primary Key: Unique item ID.',
      ],
      'name' => [
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
        'description' => 'Name of the schedule.',
      ],
      'type' => [
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
        'description' => 'Type identifier of the job.',
      ],
      'id' => [
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'unsigned' => TRUE,
        'description' => 'Numeric identifier of the job.',
      ],
      'period' => [
        'type' => 'int',
        'unsigned' => TRUE,
        'default' => 0,
        'not null' => TRUE,
        'description' => 'Time period after which job is to be executed.',
      ],
      'crontab' => [
        'type' => 'varchar',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
        'description' => 'Crontab line in *NIX format.',
      ],
      'data' => [
        'type' => 'blob',
        'not null' => FALSE,
        'size' => 'big',
        'serialize' => TRUE,
        'description' => 'The arbitrary data for the item.',
      ],
      'expire' => [
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Timestamp when job expires.',
      ],
      'last' => [
        'type' => 'int',
        'unsigned' => TRUE,
        'default' => 0,
        'not null' => TRUE,
        'description' => 'Timestamp when a job was last executed.',
      ],
      'periodic' => [
        'type' => 'int',
        'size' => 'small',
        'unsigned' => TRUE,
        'default' => 0,
        'not null' => TRUE,
        'description' => 'If true job will be automatically rescheduled.',
      ],
      'next' => [
        'type' => 'int',
        'unsigned' => TRUE,
        'default' => 0,
        'not null' => TRUE,
        'description' => 'Timestamp when a job is to be executed (next = last + period), used for fast ordering.',
      ],
      'scheduled' => [
        'type' => 'int',
        'unsigned' => TRUE,
        'default' => 0,
        'not null' => TRUE,
        'description' => 'Timestamp when a job was scheduled. 0 if a job is currently not scheduled.',
      ],
    ],
    'primary key' => [
      'item_id',
    ],
    'indexes' => [
      'name_type_id' => [
        'name',
        'type',
        'id',
      ],
      'name_type' => [
        'name',
        'type',
      ],
      'next' => [
        'next',
      ],
      'scheduled' => [
        'scheduled',
      ],
    ],
  ];
  return $schema;
}