Skip to content
This is an archived version of the documentation downloaded from LogScale Documentation Archives. Up to date documentation, and documentation for later versions, is available on LogScale Documentation

## Filtering Query Functions

Filter functions allow you to filter events or event data based on whether the query matches the filter. For example:

logscale

    in(name,values=["livequery-count"])

Returns all events where the name field equals livequery-count.

Filter functions can also be negated, for example, filter the events that do not match the given filter. For example:

logscale

    !in(name,values=["livequery-count"])

Returns all events where the name field does not equal livequery-count.

### Note

All the functions in the Filtering Query Functions table are negatable except `sample()`.

Table: Filtering Query Functions

Function | Default Argument | Availability | Description
--- | --- | --- | ---
`array:contains(array, value)` | `array` |  | Checks whether the given value matches any of the values of the array and excludes the event if no value matches.
`array:filter(array, [asArray], function, [var])` | `array` |  | Drops entries from the input array using the given filtering function.
`array:regex(array, [flags], regex)` | `array` |  | Checks whether the given pattern matches any of the values of the array and excludes the event from the search result.
`cidr([column], field, [file], [negate], [subnet])` | `field` |  | Filters events using CIDR subnets.
`in(field, [ignoreCase], values)` | `field` |  | Filters records by values where field is in given values.
`match([column], field, file, [glob], [ignoreCase], [include], [mode], [nrows], [strict])` | `file` |  | Searches text using a CSV or JSON file and can enhance entries.
`regex([field], [flags], [limit], regex, [repeat], [strict])` | `regex` |  | Extracts new fields using a regular expression.
`sample([field], [percentage])` | `percentage` |  | Samples the event stream.
`selfJoinFilter(field, [prefilter], where)` | `field` |  | Runs query to determine IDs, and then gets all events containing one of them.
`test(expression)` | `expression` |  | Evaluates boolean expression and filters events.
`text:contains(string, substring)` | `string` |  | Tests if a specific substring is present within a given string.
`wildcard([field], [ignoreCase], pattern)` | `pattern` |  | Performs a wildcard pattern search with optional case insensitivity.

#### Enter search term