docs-v2/content/v2.0/reference/flux/functions/strings/compare.md

title	description	menu	weight
strings.compare() function	The strings.compare() function compares the lexicographical order of two strings.	v2_0_ref name parent strings.compare Strings	301

The strings.compare() function compares the lexicographical order of two strings.

Output data type: Integer

import "strings"

strings.compare(v: "a", t: "b")

// returns -1

Return values

Comparison	Return value
v < t	-1
v == t	0
v > t	1

Parameters

v

The string value to compare.

Data type: String

t

The string value to compare against.

Data type: String

Examples

Compare the lexicographical order of column values

import "strings"

data
  |> map(fn: (r) => ({
      r with
      _value: strings.compare(v: r.tag1, t: r.tag2)
    })
  )