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

991 B

title description menu weight
strings.substring() function The strings.substring() function returns a substring based on `start` and `end` parameters. Indices are based on UTF code points.
v2_0_ref
name parent
strings.substring Strings
301

The strings.substring() function returns a substring based on start and end parameters. These parameters are represent indices of UTF code points in the string.

Output data type: String

import "strings"

strings.substring(v: "influx", start: 0, end: 3)

// returns "infl"

Parameters

v

The string value to search.

Data type: String

start

The starting index of the substring.

Data type: Integer

end

The ending index of the substring.

Data type: Integer

Examples

Store the first four characters of a string
import "strings"

data
  |> map(fn: (r) => ({
      r with
      abbr: strings.substring(v: r.name, start: 0, end: 3)
    })
  )