Os cron jobs são programados em intervalos recorrentes, especificados com um formato baseado em unix-cron. É possível definir uma programação para que o job seja executado várias vezes por dia ou em dias e meses específicos. Embora não seja mais recomendado usá-la, a sintaxe cron do App Engine legada ainda é compatível com os jobs atuais.
Formato do cron job
É possível usar o console do Google Cloud, a Google Cloud CLI ou a API REST do Cloud Scheduler para definir a programação.
Uma programação é definida usando o formato de string unix-cron (* * * * *
), que é um
conjunto de cinco campos em uma linha, indicando quando o job precisa ser executado.
Os campos de hora têm o seguinte formato e valores possíveis e precisam seguir esta ordem:
|------------------------------- Minute (0-59) | |------------------------- Hour (0-23) | | |------------------- Day of the month (1-31) | | | |------------- Month (1-12; or JAN to DEC) | | | | |------- Day of the week (0-6; or SUN to SAT; or 7 for Sunday) | | | | | | | | | | * * * * *
Campo | Valores válidos |
---|---|
Minuto | 0-59 |
Hora | 0-23 |
dia do mês | 1-31 |
Mês | 1-12 (ou JAN a DEZ) |
Dia da semana | 0-6 (ou SUN a SAT; ou 7 para domingo) |
Minuto: indica o momento em que o job passou da hora em que o job é executado, em minutos. Por exemplo, se o minuto for definido como
0
, o job será executado no topo da hora (porque é 0 minuto após a hora). Então, se a hora for 8h, o job será executado às 8h.Hora: indica o período em que após a meia-noite o job é executado, em horas (arredondadas para baixo para a hora mais próxima, porque os minutos restantes são indicados no campo
minute
). Meia-noite é0
e meio-dia é12
. Por exemplo, se a hora estiver definida como0
, o job será executado à meia-noite (porque é 0 hora após a meia-noite).Dia do mês:indica a data do mês. Por exemplo,
1
para o primeiro dia do mês. O Cloud Scheduler não é compatível comL
para representar o último dia do mês.Month: indica o mês. Especifique o número do mês ou as três primeiras letras do nome do mês em maiúsculas. Por exemplo,
1
para janeiro ou equivalente,JAN
.Dia da semana:indica o dia da semana. segunda-feira é
1
, terça-feira é2
e assim por diante.0
ou7
podem indicar domingo. Especifique o dia da semana por número ou pelas três primeiras letras do nome do dia da semana em maiúsculas (por exemplo,SUN
para domingo).- Esse campo é avaliado como
OR
inclusivo com o campoday of the month
, a menos que um deles esteja marcado como não restrito pelo asterisco (*
). Por exemplo, se o dia do mês for definido como1
e o dia da semana for definido comoSAT
, o job será executado no primeiro dia do mês e em todos os sábados do mês, mesmo que o primeiro dia do mês não seja um sábado. Se o dia da semana não for irrestrito (definido como*
), o job será executado apenas no primeiro dia do mês.
- Esse campo é avaliado como
Como fazer a correspondência de todos os valores
Para corresponder a todos os valores de um campo, use o asterisco: *
. Quando um campo é definido com o asterisco, ele corresponde a todos os valores válidos para aquele campo sempre que as outras condições são atendidas. Às vezes, definir um campo com o asterisco é
chamado de deixar o campo irrestrito, porque não
está restrito a um valor específico.
Veja dois exemplos em que o campo de minuto é irrestrito:
* 0 1 1 1
: o job é executado a cada minuto da meia-noite no dia 1o de janeiro e nas segundas-feiras.* * * * *
: o job é executado a cada minuto, de cada hora, de cada dia do mês, de cada mês, todos os dias da semana, porque cada um desses campos também é irrestrito.
O asterisco é equivalente a um caso especial de um intervalo, em que o intervalo começa no primeiro valor válido e termina no último valor válido para o campo (por exemplo, 0-59
para o campo de minuto).
Correspondência de um intervalo
Para fazer a correspondência de um intervalo de valores, especifique os valores de início e parada, separados por um hífen (-
). Não inclua espaços no intervalo. Os intervalos são inclusivos. O primeiro número precisa ser menor que o segundo. Se você estiver usando nomes abreviados para o mês ou dia da semana (por exemplo, JAN
em vez de 1
para o primeiro mês do ano), o primeiro valor precisa vir antes do segundo valor no mês ou na semana.
Os exemplos equivalentes a seguir são executados à meia-noite às segundas, terças, quartas, quintas e sextas-feiras (para todos os meses):
0 0 * * 1-5
0 0 * * MON-FRI
Como fazer a correspondência de uma lista
As listas podem conter qualquer valor válido para o campo, incluindo intervalos.
Especifique os valores, separados por vírgula (,
). Não inclua espaços na
lista.
Exemplos:
0 0,12 * * *
: o job é executado à meia-noite e meio-dia.0-5,30-35 * * * *
: o job é executado em cada um dos primeiros cinco minutos de cada meia hora (no topo da hora e à meia hora).
Pular valores em um intervalo
É possível pular valores em um intervalo especificando a taxa na qual percorrer o intervalo. Isso às vezes é chamado de função de etapa (ou valor ou expressão de taxa de etapa). Para fazer isso, especifique o intervalo, seguido pela
barra (/
) e a taxa em que você quer pular o intervalo.
Você pode usar o asterisco (*
) para indicar o intervalo de todos os valores do
campo. Quando você usa o asterisco, o primeiro valor no intervalo é: 0 para os campos de minuto, hora e dia da semana (domingo) e 1 para os campos de dia do mês e mês.
O valor da taxa não pode ser maior do que o maior valor possível para o campo.
A etapa padrão é 1, portanto, a função de etapa /1
é igual a não usar uma função de etapa.
Exemplos de intervalos que usam funções de etapa:
*/2
: é uma função de etapa válida para qualquer campo. Para o campo de minuto, corresponde a 0, 2, 4, ... , 58. Para a hora, corresponde a 0, 2, 4, ... , 22. Para o dia do mês, corresponde a 1, 3, 5, ... , 31 (para um mês com 31 dias). No mês, corresponde a 1, 3, 5, ... , 11. Para o dia da semana, corresponde a 0, 2, 4, 6.0-12/2
: esta é uma função de etapa válida para os campos de minuto e hora. Corresponde a 0, 2, 4, ... , 12.
Exemplos de programações usando funções de etapa:
*/2 * * * *
: o job é executado a cada dois minutos.0 0-12/2 * * *
: o job é executado a cada duas horas, na hora. A primeira execução é à meia-noite. A última corrida é ao meio-dia.
Exemplos de programação
A tabela a seguir mostra alguns exemplos de programações cron job e as respectivas descrições:
Programação | Formato do cron job | Explicação |
---|---|---|
A cada minuto | * * * * * |
É executado no minuto. Por exemplo, 9h, 9h01, h02h e assim por diante. |
A cada hora | 0 * * * * |
Executada na hora. Por exemplo, 9h, 10h, 11h e assim por diante. |
Todos os dias | 0 0 * * * |
É executado à 0h (00h no formato de 24 horas) todos os dias. |
Todos os dias da semana (seg-sex) |
Os seguintes são equivalentes:
|
É executado à 0h (00h no formato de 24 horas) às segundas, terças, quartas, quintas e sextas-feiras. |
Toda semana | Os seguintes são equivalentes:
|
É executada aos domingos à 0h (00:00 no formato de 24 horas). |
Todo mês | 0 0 1 * * |
É executado à 0h (00:00 no formato de 24 horas) no primeiro dia do mês. |
Todo trimestre | Os seguintes são equivalentes:
|
É executada à 0h (00h no formato de 24 horas) no primeiro dia do trimestre, para uma programação trimestral padrão: 1o de janeiro, 1o de abril, 1o de julho e 1o de outubro. |
Todo ano | Os seguintes são equivalentes:
|
É executado à 0h (00:00 no formato de 24 horas) no primeiro dia do primeiro mês do ano (1o de janeiro). |
Fuso horário
Selecione o fuso horário para avaliar a programação no console do Google Cloud (na página Criar um job, selecione um Fuso horário na
lista) ou usando a sinalização gcloud
--time-zone
ao
criar o job. O fuso horário padrão é Etc/UTC
.
Em alguns fusos horários, o horário de verão pode fazer com que os jobs sejam executados ou não inesperadamente. Isso ocorre porque o Cloud Scheduler é executado no tempo real. Nos casos em que um horário pode ocorrer duas vezes (como quando o relógio volta para trás) e o job está agendado nesse horário, o job programado pode observar anomalias de execução.
Se o job exigir uma cadência muito específica, escolha um fuso horário que não siga o horário de verão. Especificamente, o UTC é recomendado para que o Cloud Scheduler evite completamente o problema.