Funções de carimbo de data/hora

Funções de carimbo de data/hora

Nome Descrição
CURRENT_TIMESTAMP Gera um TIMESTAMP correspondente ao horário da solicitação.
TIMESTAMP_TRUNC Trunca um TIMESTAMP para uma determinada granularidade.
UNIX_MICROS_TO_TIMESTAMP Converte o número de microssegundos desde 1970-01-01 00:00:00 UTC em um TIMESTAMP
UNIX_MILLIS_TO_TIMESTAMP Converte o número de milissegundos desde 1970-01-01 00:00:00 UTC em um TIMESTAMP
UNIX_SECONDS_TO_TIMESTAMP Converte o número de segundos desde 1970-01-01 00:00:00 UTC em um TIMESTAMP
TIMESTAMP_ADD Adiciona um intervalo de tempo a um TIMESTAMP
TIMESTAMP_SUB Subtrai um intervalo de tempo de um TIMESTAMP
TIMESTAMP_TO_UNIX_MICROS Converte um TIMESTAMP no número de microssegundos desde 1970-01-01 00:00:00 UTC
TIMESTAMP_TO_UNIX_MILLIS Converte um TIMESTAMP no número de milissegundos desde 1970-01-01 00:00:00 UTC
TIMESTAMP_TO_UNIX_SECONDS Converte um TIMESTAMP no número de segundos desde 1970-01-01 00:00:00 UTC

CURRENT_TIMESTAMP

Sintaxe:

current_timestamp() -> TIMESTAMP

Descrição:

Recebe o carimbo de data/hora no início do tempo de solicitação input (interpretado como o número de microssegundos desde 1970-01-01 00:00:00 UTC).

Ele é estável em uma consulta e sempre será resolvido com o mesmo valor se for chamado várias vezes.

TIMESTAMP_TRUNC

Sintaxe:

timestamp_trunc(timestamp: TIMESTAMP, granularity: STRING[, timezone: STRING]) -> TIMESTAMP

Descrição:

Trunca um carimbo de data/hora para uma determinada granularidade.

O argumento granularity precisa ser uma string e um dos seguintes:

  • microsecond
  • millisecond
  • second
  • minute
  • hour
  • day
  • week
  • week([weekday])
  • month
  • quarter
  • year
  • isoyear

Se o argumento timezone for fornecido, o truncamento será baseado nos limites do calendário do fuso horário especificado (por exemplo, o truncamento diário será feito até a meia-noite no fuso horário especificado). O truncamento vai respeitar o horário de verão.

Se timezone não for fornecido, o truncamento será baseado nos limites do calendário UTC.

O argumento timezone precisa ser uma representação de string de um fuso horário do banco de dados tz, por exemplo, America/New_York. Também é possível usar um ajuste de tempo personalizado especificando um ajuste de GMT.

Exemplos:

timestamp granularity timezone timestamp_trunc(timestamp, granularity, timezone)
2000-01-01 10:20:30:123456 UTC "segundo" Não fornecido 2001-01-01 10:20:30 UTC
1997-05-31 04:30:30 UTC "dia" Não fornecido 1997-05-31 00:00:00 UTC
1997-05-31 04:30:30 UTC "dia" "America/Los_Angeles" 1997-05-30 07:00:00 UTC
2001-03-16 04:00:00 UTC "semana(sexta-feira) Não fornecido 2001-03-16 00:00:00 UTC
2001-03-23 04:00:00 UTC "semana(sexta-feira) "America/Los_Angeles" 2001-03-23 17:00:00 UTC
2026-01-24 20:00:00 UTC "mês" "GMT+06:32:43" 2026-01-01T06:32:43 UTC

UNIX_MICROS_TO_TIMESTAMP

Sintaxe:

unix_micros_to_timestamp(input: INT64) -> TIMESTAMP

Descrição:

Converte input (interpretado como o número de microssegundos desde 1970-01-01 00:00:00 UTC) em um TIMESTAMP. Gera um error se input não puder ser convertido em um TIMESTAMP válido.

Exemplos:

input unix_micros_to_timestamp(input)
0L 1970-01-01 00:00:00 UTC
400123456L 1970-01-01 00:06:40.123456 UTC
-1000000L 1969-12-31 23:59:59 UTC

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("createdAtMicros").unixMicrosToTimestamp().as("createdAtString")
  )
);
Swift
let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("createdAtMicros").unixMicrosToTimestamp().as("createdAtString")
  ])
  .execute()

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtMicros").unixMicrosToTimestamp().alias("createdAtString")
    )
    .execute()

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtMicros").unixMicrosToTimestamp().alias("createdAtString")
    )
    .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("createdAtMicros")
        .unix_micros_to_timestamp()
        .as_("createdAtString")
    )
    .execute()
)

UNIX_MILLIS_TO_TIMESTAMP

Sintaxe:

unix_millis_to_timestamp(input: INT64) -> TIMESTAMP

Descrição:

Converte input (interpretado como o número de milissegundos desde 1970-01-01 00:00:00 UTC) em um TIMESTAMP. Gera um error se input não puder ser convertido em um TIMESTAMP válido.

Exemplos:

input unix_millis_to_timestamp(input)
0L 1970-01-01 00:00:00 UTC
4000123L 1970-01-01 01:06:40.123 UTC
-1000000L 1969-12-31 23:43:20 UTC

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("createdAtMillis").unixMillisToTimestamp().as("createdAtString")
  )
);
Swift
let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("createdAtMillis").unixMillisToTimestamp().as("createdAtString")
  ])
  .execute()

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtMillis").unixMillisToTimestamp().alias("createdAtString")
    )
    .execute()

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtMillis").unixMillisToTimestamp().alias("createdAtString")
    )
    .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("createdAtMillis")
        .unix_millis_to_timestamp()
        .as_("createdAtString")
    )
    .execute()
)

UNIX_SECONDS_TO_TIMESTAMP

Sintaxe:

unix_seconds_to_timestamp(input: INT64) -> TIMESTAMP

Descrição:

Converte input (interpretado como o número de segundos desde 1970-01-01 00:00:00 UTC) em um TIMESTAMP. Gera um error se input não puder ser convertido em um TIMESTAMP válido.

Exemplos:

input unix_seconds_to_timestamp(input)
0L 1970-01-01 00:00:00 UTC
60L 1970-01-01 00:01:00 UTC
-300L 1969-12-31 23:55:00 UTC

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("createdAtSeconds").unixSecondsToTimestamp().as("createdAtString")
  )
);
Swift
let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("createdAtSeconds").unixSecondsToTimestamp().as("createdAtString")
  ])
  .execute()

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtSeconds").unixSecondsToTimestamp().alias("createdAtString")
    )
    .execute()

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAtSeconds").unixSecondsToTimestamp().alias("createdAtString")
    )
    .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("createdAtSeconds")
        .unix_seconds_to_timestamp()
        .as_("createdAtString")
    )
    .execute()
)

TIMESTAMP_ADD

Sintaxe:

timestamp_add(timestamp: TIMESTAMP, unit: STRING, amount: INT64) -> TIMESTAMP

Descrição:

Adiciona um amount de unit de timestamp. O argumento amount pode ser negativo. Nesse caso, é equivalente a TIMESTAMP_SUB.

O argumento unit precisa ser uma string e um dos seguintes:

  • microsecond
  • millisecond
  • second
  • minute
  • hour
  • day

Um erro será gerado se o carimbo de data/hora resultante não se encaixar no intervalo TIMESTAMP.

Exemplos:

timestamp unit amount timestamp_add(timestamp, unit, amount)
2025-02-20 00:00:00 UTC "minuto" 2L 2025-02-20 00:02:00 UTC
2025-02-20 00:00:00 UTC "hora" -4L 2025-02-19 20:00:00 UTC
2025-02-20 00:00:00 UTC "dia" 5L 2025-02-25 00:00:00 UTC

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("createdAt").timestampAdd("day", 3653).as("expiresAt")
  )
);
Swift
let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("createdAt").timestampAdd(3653, .day).as("expiresAt")
  ])
  .execute()

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAt")
          .timestampAdd("day", 3653)
          .alias("expiresAt")
    )
    .execute()

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("createdAt").timestampAdd("day", 3653).alias("expiresAt")
    )
    .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(Field.of("createdAt").timestamp_add("day", 3653).as_("expiresAt"))
    .execute()
)

TIMESTAMP_SUB

Sintaxe:

timestamp_sub(timestamp: TIMESTAMP, unit: STRING, amount: INT64) -> TIMESTAMP

Descrição:

Subtrai um amount de unit de timestamp. O argumento amount pode ser negativo. Nesse caso, é equivalente a TIMESTAMP_ADD.

O argumento unit precisa ser uma string e um dos seguintes:

  • microsecond
  • millisecond
  • second
  • minute
  • hour
  • day

Um erro será gerado se o carimbo de data/hora resultante não se encaixar no intervalo TIMESTAMP.

Exemplos:

timestamp unit amount timestamp_sub(timestamp, unit, amount)
2026-07-04 00:00:00 UTC "minuto" 40L 2026-07-03 23:20:00 UTC
2026-07-04 00:00:00 UTC "hora" -24L 2026-07-05 00:00:00 UTC
2026-07-04 00:00:00 UTC "dia" 3L 2026-07-01 00:00:00 UTC

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("expiresAt").timestampSubtract("day", 14).as("sendWarningTimestamp")
  )
);
Swift
let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("expiresAt").timestampSubtract(14, .day).as("sendWarningTimestamp")
  ])
  .execute()

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("expiresAt")
          .timestampSubtract("day", 14)
          .alias("sendWarningTimestamp")
    )
    .execute()

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("expiresAt").timestampSubtract("day", 14).alias("sendWarningTimestamp")
    )
    .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(
        Field.of("expiresAt")
        .timestamp_subtract("day", 14)
        .as_("sendWarningTimestamp")
    )
    .execute()
)

TIMESTAMP_TO_UNIX_MICROS

Sintaxe:

timestamp_to_unix_micros(input: TIMESTAMP) -> INT64

Descrição:

Converte input no número de microssegundos desde 1970-01-01 00:00:00 UTC. Trunca níveis mais elevados de precisão ao arredondar para baixo até o início do segundo.

Exemplos:

input timestamp_to_unix_micros(input)
1970-01-01 00:00:00 UTC 0L
1970-01-01 00:06:40.123456 UTC 400123456L
1969-12-31 23:59:59 UTC -1000000L

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("dateString").timestampToUnixMicros().as("unixMicros")
  )
);
Swift
let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("dateString").timestampToUnixMicros().as("unixMicros")
  ])
  .execute()

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixMicros().alias("unixMicros")
    )
    .execute()

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixMicros().alias("unixMicros")
    )
    .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(Field.of("dateString").timestamp_to_unix_micros().as_("unixMicros"))
    .execute()
)

TIMESTAMP_TO_UNIX_MILLIS

Sintaxe:

timestamp_to_unix_millis(input: TIMESTAMP) -> INT64

Descrição:

Converte input no número de milissegundos desde 1970-01-01 00:00:00 UTC. Trunca níveis mais altos de precisão ao arredondar para baixo até o início do milissegundo.

Exemplos:

input timestamp_to_unix_millis(input)
1970-01-01 00:00:00 UTC 0L
1970-01-01 01:06:40.123 UTC 4000123L
1969-12-31 23:43:20 -1000000L

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("dateString").timestampToUnixMillis().as("unixMillis")
  )
);
Swift
let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("dateString").timestampToUnixMillis().as("unixMillis")
  ])
  .execute()

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixMillis().alias("unixMillis")
    )
    .execute()

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixMillis().alias("unixMillis")
    )
    .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(Field.of("dateString").timestamp_to_unix_millis().as_("unixMillis"))
    .execute()
)

TIMESTAMP_TO_UNIX_SECONDS

Sintaxe:

timestamp_to_unix_seconds(input: TIMESTAMP) -> INT64

Descrição:

Converte input no número de segundos desde 1970-01-01 00:00:00 UTC. Trunca níveis mais elevados de precisão ao arredondar para baixo até o início do segundo.

Exemplos:

input timestamp_to_unix_seconds(input)
1970-01-01 00:00:00 UTC 0L
1970-01-01 00:01:00 UTC 60L
1969-12-31 23:55:00 UTC -300L

Web

const result = await execute(db.pipeline()
  .collection("documents")
  .select(
    field("dateString").timestampToUnixSeconds().as("unixSeconds")
  )
);
Swift
let result = try await db.pipeline()
  .collection("documents")
  .select([
    Field("dateString").timestampToUnixSeconds().as("unixSeconds")
  ])
  .execute()

Kotlin

val result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixSeconds().alias("unixSeconds")
    )
    .execute()

Java

Task<Pipeline.Snapshot> result = db.pipeline()
    .collection("documents")
    .select(
        field("dateString").timestampToUnixSeconds().alias("unixSeconds")
    )
    .execute();
Python
from google.cloud.firestore_v1.pipeline_expressions import Field

result = (
    client.pipeline()
    .collection("documents")
    .select(Field.of("dateString").timestamp_to_unix_seconds().as_("unixSeconds"))
    .execute()
)