{
  "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it.",
  "type" : "scalar",
  "name" : "round",
  "description" : "Rounds a number to the specified number of decimal places.\nDefaults to 0, which returns the nearest integer. If the\nprecision is a negative number, rounds to the number of digits left\nof the decimal point.",
  "signatures" : [
    {
      "params" : [
        {
          "name" : "number",
          "type" : "double",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "double",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        },
        {
          "name" : "decimals",
          "type" : "integer",
          "optional" : true,
          "description" : "The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "double",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        },
        {
          "name" : "decimals",
          "type" : "long",
          "optional" : true,
          "description" : "The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "integer",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "integer"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "integer",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        },
        {
          "name" : "decimals",
          "type" : "integer",
          "optional" : true,
          "description" : "The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "integer"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "integer",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        },
        {
          "name" : "decimals",
          "type" : "long",
          "optional" : true,
          "description" : "The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "integer"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "long",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "long"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "long",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        },
        {
          "name" : "decimals",
          "type" : "integer",
          "optional" : true,
          "description" : "The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "long"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "long",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        },
        {
          "name" : "decimals",
          "type" : "long",
          "optional" : true,
          "description" : "The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "long"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "unsigned_long"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        },
        {
          "name" : "decimals",
          "type" : "integer",
          "optional" : true,
          "description" : "The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "unsigned_long"
    },
    {
      "params" : [
        {
          "name" : "number",
          "type" : "unsigned_long",
          "optional" : false,
          "description" : "The numeric value to round. If `null`, the function returns `null`."
        },
        {
          "name" : "decimals",
          "type" : "long",
          "optional" : true,
          "description" : "The number of decimal places to round to. Defaults to 0. If `null`, the function returns `null`."
        }
      ],
      "variadic" : false,
      "returnType" : "unsigned_long"
    }
  ],
  "examples" : [
    "FROM employees\n| KEEP first_name, last_name, height\n| EVAL height_ft = ROUND(height * 3.281, 1)"
  ],
  "preview" : false,
  "snapshot_only" : false
}