machbase-neo
Timer
Glance at Timer

Glance at Timer

Register a task

Register tasks that should run on the specified schedule.

Syntax: timer add [--autostart] <name> <timer_spec> <tql-path>

  • --autostart makes the task will start automatically when machbase-neo starts. If the task is not autostart mode, you can make it start and stop manually by timer start <name> and timer stop <name> commands.

  • <name> task’s name

  • <timer_spec> specifies when this task runs. (see below)

  • <tql-path> the tql script as a task

timer spec

There three possible examples)

0 30 * * * *           Every hour on the half hour
@every 1h30m           Every hour thirty
@daily                 Every day

CRON expression

Field nameMandatory?Allowed valuesAllowed special characters
SecondsYes0-59* / , -
MinutesYes0-59* / , -
HoursYes0-23* / , -
Day of monthYes1-31* / , - ?
MonthYes1-12 or JAN-DEC* / , -
Day of weekYes0-6 or SUN-SAT* / , - ?

  • Asterisk *
    The asterisk indicates that the cron expression will match for all values of the field; e.g., using an asterisk in the 5th field (month) would indicate every month.

  • Slash /
    Slashes are used to describe increments of ranges. For example 3-59/15 in the 1st field (minutes) would indicate the 3rd minute of the hour and every 15 minutes thereafter. The form “*/…” is equivalent to the form “first-last/…”, that is, an increment over the largest possible range of the field. The form “N/…” is accepted as meaning “N-MAX/…”, that is, starting at N, use the increment until the end of that specific range. It does not wrap around.

  • Comma ,
    Commas are used to separate items of a list. For example, using “MON,WED,FRI” in the 5th field (day of week) would mean Mondays, Wednesdays and Fridays.

  • Hyphen -
    Hyphens are used to define ranges. For example, 9-17 would indicate every hour between 9am and 5pm inclusive.

  • Question mark ?
    Question mark may be used instead of * for leaving either day-of-month or day-of-week blank.

Predefined schedules

EntryDescriptionEquivalent To
@yearly (or @annually)Run once a year, midnight, Jan. 1st0 0 0 1 1 *
@monthlyRun once a month, midnight, first of month0 0 0 1 * *
@weeklyRun once a week, midnight between Sat/Sun0 0 0 * * 0
@daily (or @midnight)Run once a day, midnight0 0 0 * * *
@hourlyRun once an hour, beginning of hour0 0 * * * *

Intervals

@every <duration> where “duration” is a string that is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as “300ms”, “-1.5h” or “2h45m”. Valid time units are “ms”, “s”, “m”, “h”.

@every 10h
@every 1h10m30s

Task Status

Syntax: timer list

  • STOP
  • RUNNING

Task Start/Stop

Syntax: timer [start | stop] <name>

Remove timer

Syntax: timer del <name>

Last updated on
Hello World?