{
  "comment" : "This is generated by ESQL's AbstractFunctionTestCase. Do not edit it. See ../README.md for how to regenerate it.",
  "type" : "agg",
  "name" : "sample",
  "description" : "Collects sample values for a field.",
  "signatures" : [
    {
      "params" : [
        {
          "name" : "field",
          "type" : "boolean",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "boolean"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "cartesian_point",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "cartesian_point"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "cartesian_shape",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "cartesian_shape"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "date",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "date"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "date_nanos",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "date_nanos"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "double",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "double"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "geo_point",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "geo_point"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "geo_shape",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "geo_shape"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "integer",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "integer"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "ip",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "ip"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "keyword",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "long",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "long"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "text",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "keyword"
    },
    {
      "params" : [
        {
          "name" : "field",
          "type" : "version",
          "optional" : false,
          "description" : "The field to collect sample values for."
        },
        {
          "name" : "limit",
          "type" : "integer",
          "optional" : false,
          "description" : "The maximum number of values to collect."
        }
      ],
      "variadic" : false,
      "returnType" : "version"
    }
  ],
  "examples" : [
    "FROM employees\n| STATS sample = SAMPLE(gender, 5)"
  ],
  "preview" : false,
  "snapshot_only" : false
}