tstep.json

{
  "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it.",
  "type" : "grouping",
  "name" : "tstep",
  "description" : "Creates end-aligned time buckets over @timestamp using a fixed step. The end anchor is taken from TRANGE when present,\nor from the current query time otherwise.",
  "signatures" : [
    {
      "params" : [
        {
          "name" : "step",
          "type" : "time_duration",
          "optional" : false,
          "description" : "Fixed step size. Buckets are anchored to the end of TRANGE, or the current query time when TRANGE is absent."
        }
      ],
      "variadic" : false,
      "returnType" : "date"
    },
    {
      "params" : [
        {
          "name" : "step",
          "type" : "time_duration",
          "optional" : false,
          "description" : "Fixed step size. Buckets are anchored to the end of TRANGE, or the current query time when TRANGE is absent."
        }
      ],
      "variadic" : false,
      "returnType" : "date_nanos"
    }
  ],
  "examples" : [
    "FROM sample_data\n| WHERE TRANGE(\"2023-10-23T12:15:00.000Z\", \"2023-10-23T13:55:01.543Z\")\n| STATS min = MIN(@timestamp), max = MAX(@timestamp) BY bucket = TSTEP(1 hour)\n| SORT min",
    "FROM sample_data\n| WHERE TRANGE(\"2023-10-23T12:15:00.000Z\", \"2023-10-23T13:55:01.543Z\")\n| STATS min = MIN(@timestamp), max = MAX(@timestamp) BY bucket = TSTEP(\"1 hour\")\n| SORT min"
  ],
  "preview" : false,
  "snapshot_only" : false
}