cron README

The project's README from github.com/robfig/cron. As one markdown file: README.md.

GoDoc Build Status

cron

Cron V3 has been released!

To download the specific tagged release, run:

go get github.com/robfig/cron/[email protected]

Import it in your program as:

import "github.com/robfig/cron/v3"

It requires Go 1.11 or later due to usage of Go Modules.

Refer to the documentation here: http://godoc.org/github.com/robfig/cron

The rest of this document describes the the advances in v3 and a list of breaking changes for users that wish to upgrade from an earlier version.

Upgrading to v3 (June 2019)

cron v3 is a major upgrade to the library that addresses all outstanding bugs, feature requests, and rough edges. It is based on a merge of master which contains various fixes to issues found over the years and the v2 branch which contains some backwards-incompatible features like the ability to remove cron jobs. In addition, v3 adds support for Go Modules, cleans up rough edges like the timezone support, and fixes a number of bugs.

New features:

It is backwards incompatible with both v1 and v2. These updates are required:

// Seconds field, required
cron.New(cron.WithSeconds())

// Seconds field, optional
cron.New(cron.WithParser(cron.NewParser(
	cron.SecondOptional | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
)))
cron.New(cron.WithChain(
  cron.Recover(logger),  // or use cron.DefaultLogger
))
cron.New(
  cron.WithLogger(cron.VerbosePrintfLogger(logger)))

Background - Cron spec format

There are two cron spec formats in common usage:

The original version of this package included an optional "seconds" field, which made it incompatible with both of these formats. Now, the "standard" format is the default format accepted, and the Quartz format is opt-in.

cron (robfig/cron)

Searching Database…

14.2K ·GitHub
Что это такое?Это библиотека на Go, которая реализует планирование задач в стиле cron и позволяет запускать функции по расписанию прямо внутри Go-программы, а не полагаться на системный демон cron.
Это отдельное приложение-планировщик или то, что я импортирую в свой код?Это библиотека на Go, которую вы импортируете непосредственно в свою программу; это не отдельный сервис и не самостоятельный исполняемый файл.
Как добавить её в свой Go-проект?Импортируйте её как github.com/robfig/cron/v3 и создайте экземпляр Cron, чтобы регистрировать задачи с помощью строки спецификации cron.
Нужна ли определённая версия Go?Да, требуется Go 1.11 или новее, так как библиотека использует Go Modules.
Будет ли мой существующий код v1/v2 продолжать работать после обновления?Нет, v3 не совместима с предыдущими версиями: она убирает нестандартное поле «секунды» по умолчанию, переходит на функциональные опции для настройки и больше не перехватывает паники в задачах по умолчанию.
Кто будет этим пользоваться?Разработчики на Go, которым нужны задачи, выполняемые по расписанию внутри процесса (периодические задачи, задачи обслуживания, регулярные рабочие процессы), без вызова системного cron через ОС.
Какой формат спецификации cron используется по умолчанию?Используется стандартный пятипольный формат cron (минута час день-месяца месяц день-недели), как описано на странице Cron в Википедии, а не нестандартный формат из v1, где секунды указываются первыми.
Можно ли использовать выражения cron в стиле Quartz с секундами?Да, разбор поля секунд, совместимого с Quartz, включается по выбору через пользовательский парсер, однако необязательное поле года Quartz не поддерживается.
Для чего нужны Chain и JobWrapper?Chain и JobWrapper позволяют оборачивать задачи сквозной логикой: перехват паник, пропуск или отложенный запуск перекрывающихся выполнений, логирование вызовов и уведомления о завершении.
Как задать часовой пояс для конкретного расписания?Добавьте перед спецификацией cron префикс CRON_TZ= (старый префикс TZ= тоже поддерживается), чтобы выполнять это расписание в нужном часовом поясе.
What are similar projects?bull, rq, crawlab, xxl-job, celery, tork, temporal, gjson
Creator
robfig
Size
0.2 MB
Stars
14.2K
Updated
CommitJan 06
Age
14y
Commits · 90 Days