String functions - Data Transformation| Alibaba Cloud Documentation Center

Functions


Type	Function	Description
Multi-string operation	str_format	Formats a string.
	str_join	Concatenates the elements in a sequence with a specified string to generate a new string.
	str_zip	Splits two value strings or expression strings concurrently, and then merges the strings into a single string.
Encoding and decoding	str_encode	Encodes a string by using a specified encoding format.
	str_decode	Decodes an input value by using a specified encoding format.
	str_hex_escape_encode	Escapes special characters to Chinese characters. Hexadecimal characters are supported.
	str_uuid	Generates a random UUID.
Sorting, reversing, and replacement	str_sort	Sorts specified objects.
	str_reverse	Reverses a string.
	str_replace	Replaces an old string with a new string based on a rule.
	str_logstash_config_normalize	Converts the data format of the Logstash configuration language to the JSON format.
	str_translate	Replaces the specified characters in a string with mapping characters.
Regular munging	str_strip	Deletes specified characters from a string.
	str_lstrip	Deletes specified characters from the start of a string.
	str_rstrip	Deletes specified characters from the end of a string.
	str_lower	Converts all uppercase characters in a string to lowercase characters.
	str_upper	Converts all lowercase characters in a string to uppercase characters.
	str_title	Capitalizes the first letter of each word in a string and converts all other letters in the string to lowercase letters.
	str_capitalize	Capitalizes the first letter of a string and converts all the other letters in the string to lowercase letters.
	str_swapcase	Interchanges the uppercase letters and lowercase letters in a string.
Search and check	str_count	Counts the number of occurrences of a character in a string.
	str_find	Checks whether an original string contains a specified substring.
	str_rfind	Finds the position of the last occurrence of a character or a substring in a string.
	str_endswith	Checks whether a string ends with a specified suffix.
	str_startswith	Checks whether a string starts with a specified string.
Splitting	str_split	Splits a string with a specified delimiter.
	str_splitlines	Splits a string with a line feed.
	str_partition	Splits a string with a specified delimiter into three parts from left to right.
	str_rpartition	Splits a string with a specified delimiter into three parts from right to left.
Formatting	str_center	Pads a string to a specified length with a specified character.
	str_ljust	Pads a string to a specified length from the end with a specified character.
	str_rjust	Pads a string to a specified length from the start with a specified character.
	str_zfill	Pads a string to a specified length from the start with 0.
	str_expandtabs	Converts `\t` in a string to a space character.
Character set check	str_isalnum	Checks whether a string consists of only letters and digits.
	str_isalpha	Checks whether a string consists of only letters.
	str_isascii	Checks whether a string is in the ASCII table.
	str_isdecimal	Checks whether a string contains only decimal characters.
	str_isdigit	Checks whether a string consists of only digits.
	str_isidentifier	Checks whether a string is a valid Python identifier. This function can also check whether a variable name is valid.
	str_islower	Checks whether a string consists of lowercase letters.
	str_isnumeric	Checks whether a string consists of digits.
	str_isprintable	Checks whether all characters in a string are printable characters.
	str_isspace	Checks whether a string consists of only space characters.
	str_istitle	Checks whether the first letter of each word in a string is in uppercase and whether all other letters in the string are in lowercase.
	str_isupper	Checks whether all letters in a string are uppercase letters.

The following table describes the functions that can be used together with string functions.


Type	Function	Description
Multi-string operation	op_add	Calculates the sum of multiple values. The values can be strings or numbers.
	op_max	Returns the maximum value among multiple numeric values or strings.
	op_min	Returns the minimum value among multiple numeric values or strings.
String truncation	op_slice	Truncates a string.
Length calculation	op_len	Calculates the length of a string.

str_format

Syntax

str_format(formatted string, value 1, value 2, ...)

Parameters


Parameter	Type	Required	Description
formatted string	Arbitrary (automatically converted to a string)	Yes	The format of the converted string. Example: `{}={}`.
value 1	Arbitrary	Yes	The value 1 that you want to format.
value 2	Arbitrary	Yes	The value 2 that you want to format.

Response
A formatted string is returned.

Example

Raw log entry:

class: Format
escape_name: Traditional

Transformation rule:

e_set("str_format", str_format("{}={}",v("class"),v("escape_name")))

Result:

class: Format
escape_name: Traditional
str_format: Format=Traditional

str_join

Syntax

str_join(delimiter, value 1, value 2, ...)

Parameters


Parameter	Type	Required	Description
delimiter	Arbitrary (automatically converted to a string)	Yes	The delimiter. You can use the exclamation point (!), at sign (@), number sign (#), dollar sign ($), or percent sign (%) as the delimiter.
value 1	Arbitrary (automatically converted to a string)	Yes	The value that you want to concatenate.
value 2	Arbitrary (automatically converted to a string)	Yes	The value that you want to concatenate.

Response
A concatenated string is returned.

Example

Raw log entry:

name: ETL
company: aliyun.com

Transformation rule:

e_set("email", str_join("@",v("name"),v("company")))

Result:

name: ETL
company: aliyun.com
email:ETL@aliyun.com

str_encode

Syntax

str_encode(value, "utf8", errors="ignore"))

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The value that you want to encode.
encoding	String	No	The encoding format. Default value: utf8. ASCII is supported.
errors	String	No	The action performed when an error message is reported. By default, the error message is ignored. You can also set the errors parameter to strict, replace, or xmlcharrefreplace.

Response
An encoded string is returned.

Example

Raw log entry:

test: asewds

Transformation rule:

e_set("f1", str_decode(str_encode("hello", "utf8"), "utf8"))

Result:

test: asewds
f1: hello

str_decode

Syntax
```
str_decode(value, "utf8", errors="ignore"))
```
Note The str_decode function can process data only of the byte data type.

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The value that you want to decode.
encoding	Arbitrary (automatically converted to a string)	No	The encoding format. Default value: utf8. ASCII is supported.
errors	Arbitrary (automatically converted to a string)	No	The action performed when an error message is reported. By default, the error message is ignored. You can also set the errors parameter to strict, replace, or xmlcharrefreplace.

Response
A decoded value is returned.

Example

Raw log entry:

test: asewds

Transformation rule:

e_set("encoding", str_decode(b'\xe4\xbd\xa0\xe5\xa5\xbd', "utf8",'strict'))

Result:

test: asewds
encoding: hello

str_replace

Syntax
```
str_replace(value, old, new, count)
```
Note This function is used to call variable parameters. For more information, see Function invoking.

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The value in which you want to replace the specified string.
old	Arbitrary (automatically converted to a string)	Yes	The string that you want to replace.
new	Arbitrary (automatically converted to a string)	Yes	The string that you want to use to replace the specified string.
count	Number	No	The number of replacements. If you do not specify this parameter, the specified string in all occurrences in the value is replaced.

Response
A new string is returned.

Example: Convert a dictionary to a JSON string.

Raw log entry:

content:  {'referer': '-', 'request': 'GET /phpMyAdmin', 'status': 404, 'data-1': {'aaa': 'Mozilla', 'bbb': 'asde'}, 'data-2': {'up_adde': '-', 'up_host': '-'}}

Transformation rule:

e_set("content_json", str_replace(ct_str(v("content")),"'",'"'))

Result:

content:  {'referer': '-', 'request': 'GET /phpMyAdmin', 'status': 404, 'data-1': {'aaa': 'Mozilla', 'bbb': 'asde'}, 'data-2': {'up_adde': '-', 'up_host': '-'}}
content_json:  {"referer": "-", "request": "GET /phpMyAdmin", "status": 404, "data-1": {"aaa": "Mozilla", "bbb": "asde"}, "data-2": {"up_adde": "-", "up_host": "-"}}

str_sort

Syntax
```
str_sort(value, reverse)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to sort.
reverse	Bool	No	Default value: False. This value indicates that the string is sorted in ascending order.

Response
A sorted string is returned.
Examples
- Example 1: Sort the str string in alphabetical order.
  Raw log entry:
```
str: twish
```
  Transformation rule:
```
e_set("str_sort", str_sort(v("str")))
```
  Result:
```
str: twish
str_sort: histw
```
- Example 2: Sort the str string in two-letter pairs in reverse alphabetical order.
  Raw log entry:
```
str: twish
```
  Transformation rule:
```
e_set("str_sort", str_sort(v("str"),True))
```
  Result:
```
str: twish
str_sort: wtsih
```

str_reverse

Syntax
```
str_reverse(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The value that you want to reverse.

Response
A reversed string is returned.

Example: Reverse the data string.

Raw log entry:

data:twish

Transformation rule:

e_set("reverse_data", str_reverse(v("data")))

Result:

data:twish
reverse_data:hsiwt

str_logstash_config_normalize

Syntax
```
str_logstash_config_normalize(value)
```
Note For more information about the Logstash configuration language, see Logstash.

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The value that you want to convert.

Response
A converted string is returned.

Example: Convert the logstash string.

Raw log entry:

logstash: {"name"=>"tw5"}

Transformation rule:

e_set("normalize_data", str_logstash_config_normalize(v("logstash")))

Result:

logstash: {"name"=>"tw5"}
normalize_data:{"name":"tw5"}

str_hex_escape_encode

Syntax
```
str_hex_escape_encode(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The value that you want to escape.

Response
An escaped string is returned.

Example: Escape the myfriend string to Chinese characters.

Raw log entry:

myfriend: \xe4\xbd\xa0\xe5\xa5\xbd

Transformation rule:

e_set("hex_myfriend", str_hex_escape_encode(v("myfriend")))

Result:

myfriend: \xe4\xbd\xa0\xe5\xa5\xbd
hex_myfriend: hello

str_strip

Syntax
```
str_strip(value, chars)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to modify.
chars	Arbitrary (automatically converted to a string)	No	The character set that you want to delete from the start and end of a string. Default value: `\t\r\n`.

Response
A modified string is returned.
Examples
- Example 1: Delete the asterisk (*) from the start of the strip string.
  Raw log entry:
```
strip: ***I love Etl
```
  Transformation rule:
```
e_set("str_strip", str_strip(v("strip"),"*"))
```
  Result:
```
strip: ***I love Etl
str_strip:I love Etl
```
- Example 2: Delete the space character from the start of the strip string.
  Raw log entry:
```
strip:    I love Etl
```
  Transformation rule:
```
e_set("str_strip", str_strip(v("strip")))
```
  Result:
```
strip:    I love Etl
str_strip: I love Etl
```
- Example 3: Delete the xy character set.
  Raw log entry:
```
strip:xy123yx
```
  Transformation rule:
```
e_set("str_strip", str_strip(v("strip"),"xy"))
```
  Result:
```
strip:xy123yx
str_strip:123
```

str_lower

Syntax
```
str_lower(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to convert.

Response
A converted string is returned.
Example: Convert the name string to lowercase letters.
Raw log entry:
```
name: Etl
```
Transformation rule:
```
e_set("str_lower", str_lower(v("name")))
```
Result:
```
name: Etl
str_lower: etl
```

str_upper

Syntax
```
str_upper(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to convert.

Response
A converted string is returned.
Example: Convert the name string to uppercase letters.
Raw log entry:
```
name: etl
```
Transformation rule:
```
e_set("str_upper", str_upper(v("name")))
```
Result:
```
name: etl
str_upper: ETL
```

str_title

Syntax
```
str_title(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to convert.

Response
A converted string is returned.
Example: Capitalize the first letters of each word in the word field value.
Raw log entry:
```
word: this is etl
```
Transformation rule:
```
e_set("str_title", str_title(v("word")))
```
Result:
```
word: this is etl
str_title: This Is Etl
```

str_capitalize

Syntax
```
str_capitalize(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to convert.

Response
A converted string is returned.
Example: Capitalize the first letter of the word field value and convert all other letters in the value to lowercase letters.
Raw log entry:
```
word: this Is MY EAL
```
Transformation rule:
```
e_set("str_capitalize", str_capitalize(v("word")))
```
Result:
```
word: this Is MY EAL
str_capitalize: This is my eal
```

str_lstrip

Syntax
```
str_lstrip(value, chars)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to modify.
chars	Arbitrary (automatically converted to a string)	No	The character set that you want to delete from the start of a string. The default value is a space character.

Response
A modified string is returned.

Examples

Example 1: Delete the asterisk (*) from the start of the word field value.

Raw log entry:

word: ***this is string

Transformation rule:

e_set("str_lstrip", str_lstrip(v("word"),"*"))

Result:

word: ***this is string
str_lstrip: this is string

Example 2: Delete the space character from the start of the word field value.
Raw log entry:
```
word:     this is string
```
Transformation rule:
```
e_set("str_lstrip", str_lstrip(v("word")))
```
Result:
```
word:     this is string
str_lstrip: this is string
```

Example 3: Delete the xy character set.

Raw log entry:

lstrip:xy123yx

Transformation rule:

e_set("str_lstrip", str_lstrip(v("lstrip"),"xy"))

Result:

lstrip:xy123yx
str_lstrip:123yx

str_rstrip

Syntax
```
str_rstrip(value, chars)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to modify.
chars	Arbitrary (automatically converted to a string)	No	The character set that you want to delete from the end of a string. The default value is a space character.

Response
A modified string is returned.

Examples

Example 1: Delete the asterisk (*) from the end of the word field value.

Raw log entry:

word: this is string*****

Transformation rule:

e_set("str_rstrip", str_rstrip(v("word"),"*"))

Result:

word: this is string*****
str_rstrip: this is string

Example 2: Delete the xy character set.

Raw log entry:

word:xy123yx

Transformation rule:

e_set("str_rstrip", str_rstrip(v("word"),"xy"))

Result:

word:xy123yx
str_rstrip:xy123

str_swapcase

Syntax
```
str_swapcase(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to convert.

Response
A converted string is returned.

Example

Raw log entry:

name: this is string

Transformation rule:

e_set("str_swapcase", str_swapcase(v("name")))

Result:

name: this is string
str_swapcase: THIS IS STRING

str_translate

Syntax

str_translate(value, original character set, mapping character set)

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to replace.
original character set	Arbitrary (automatically converted to a string)	Yes	The original character set.
mapping character set	Arbitrary (automatically converted to a string)	Yes	The character set after the replacement.

Response
A converted string is returned.

Example

Raw log entry:

name: I love ETL!!!

Transformation rule:

e_set("str_translate", str_translate(v("name"),"aeiou","12345"))

Result:

name: I love ETL!!!
str_translate: I l4v2 ETL!!!

str_endswith

Syntax
```
str_endwith(value, suffix, start, end)
```
Note This function is used to call variable parameters. For more information, see Function invoking.

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to check.
suffix	Arbitrary (automatically converted to a string)	Yes	The suffix rule. The value of this parameter can be a string or an element.
start	Number	No	The position from which the string suffix check starts. The value 0 indicates the first character and the value -1 indicates the last character.
end	Number	No	The position at which the string suffix check ends. The value 0 indicates the first character and the value -1 indicates the last character.

Response
If the string ends with the specified suffix, the value True is returned. Otherwise, the value False is returned.

Example

Raw log entry:

name: this is endswith!!!

Transformation rule:

e_set("str_endswith",str_endswith(v("name"),"!"))

Result:

name: this is endswith!!!
str_endswith: True

str_startswith

Syntax
```
str_startswith(value, prefix, start, end)
```
Note This function is used to call variable parameters. For more information, see Function invoking.

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to check.
prefix	Arbitrary (automatically converted to a string)	Yes	The prefix rule. The value of this parameter can be a string or an element.
start	Number	No	The position from which the string prefix check starts. The value 0 indicates the first character and the value -1 indicates the last character.
end	Number	No	The position at which the string prefix check ends. The value 0 indicates the first character and the value -1 indicates the last character.

Response
If the string ends with the specified prefix, the value True is returned. Otherwise, the value False is returned.

Example

Raw log entry:

name: !! this is startwith

Transformation rule:

e_set("str_startswith",str_startswith(v("name"),"!!"))

Result:

name: !! this is startwith
str_startswith: True

str_find

Syntax
```
str_find(value, str, begin, end)
```
Note This function is used to call variable parameters. For more information, see Function invoking.

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string in which you want to search for a substring.
str	Arbitrary (automatically converted to a string)	Yes	The substring that you want to search for.
begin	Number	No	The position from which the substring search starts. The value 0 indicates the first character and the value -1 indicates the last character.
end	Number	No	The position at which the substring search ends. The default value is the length of the string. The value 0 indicates the first character and the value -1 indicates the last character.

Response
The position of the specified substring in the original string is returned. If the specified substring appears multiple times in the original string, only the position of the first substring is returned.

Example

Raw log entry:

name: hello world

Transformation rule:

e_set("str_find",str_find(v("name"),"h"))

Result:

name: hello world
str_find: 0

str_count

Syntax
```
str_count(value, sub, start, end)
```
Note This function is used to call variable parameters. For more information, see Function invoking.

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string in which you want to count the number of occurrences of a specified character.
sub	Arbitrary (automatically converted to a string)	Yes	The character whose number of occurrences you want to count.
start	Number	No	The position from which the search for the specified character starts in the string. Valid values: 0: the first character. This is the default value. -1: the last character.
end	Number	No	The position at which the search for the specified character ends in the string. Valid values: 0: the first character. -1: the last character. This is the default value.

Response
The number of occurrences of the specified character is returned.

Example

Raw log entry:

name: this is really a string

Transformation rule:

e_set("str_count",str_count(v("name"),"i"))

Result:

name: this is really a string
str_count: 3

str_rfind

Syntax
```
str_rfind(value, substr, beg, end)
```
Note This function is used to call variable parameters. For more information, see Function invoking.

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string in which you want to search for a specified character.
substr	Arbitrary (automatically converted to a string)	Yes	The character that you want to search for.
beg	Number	No	The position from which the search starts. Default value: 0.
end	Number	No	The position at which the search ends. The default value is the length of the string.

Response
The position of the last occurrence of the specified character is returned.

Example

Raw log entry:

name: this is really a string

Transformation rule:

e_set("str_rfind",str_rfind(v("name"),"i"))

Result:

name: this is really a string
str_rfind: 20

str_split

Syntax
```
str_split(value, sep=None, maxsplit=-1)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to split.
sep	Number	No	The delimiter. The value None indicates a space character.
maxsplit	Number	No	The maximum number of splits. The value -1 indicates that no limit is set.

Response
Split strings are returned.

Example: Split the content string with space characters.

Raw log entry:

content: hello world

Transformation rule:

e_set("str_split",str_split(v("content")," "))

Result:

content: hello world
str_split: ["hello", "world"]

str_splitlines

Syntax
```
str_splitlines(value, keepends)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to split.
keepends	Bool	No	Specifies whether to delete line feeds from the result. These line feeds include `\r`, `\r\n`, and `\n`. Default value: False. This value indicates that line feeds are deleted. The value True indicates that line feeds are retained.

Response
Split strings are returned.

Examples

Example 1

Raw log entry:

content: ab c\n\nde fg\rkl\r\n

Transformation rule:

e_set("str_splitlines",str_splitlines(v("content"),False))

Result:

content: ab c\n\nde fg\rkl\r\n
str_splitlines: ['ab c', '', 'de fg', 'kl']

Example 2

Raw log entry:

content: ab c\n\nde fg\rkl\r\n

Transformation rule:

e_set("str_splitlines",str_splitlines(v("content"),True))

Result:

content: ab c\n\nde fg\rkl\r\n  
str_splitlines: ['ab c\n', '\n', 'de fg\r', 'kl\r\n']

str_partition

Syntax
```
str_partition(value, substr)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to split.
substr	Arbitrary (automatically converted to a string)	No	The specified delimiter.

Response
Split strings are returned.

Example: Split the website string with periods (.) into three parts from left to right.

Raw log entry:

website: www.aliyun.com

Transformation rule:

e_set("str_partition",str_partition(v("website"),"."))

Result:

website: www.aliyun.com
str_partition:  ["www", ".", "aliyun.com"]

str_rpartition

Syntax
```
str_rpartition(value, substr)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to split.
substr	Arbitrary (automatically converted to a string)	No	The specified delimiter.

Response
Split strings are returned.

Example: Split the website string with periods (.) into three parts from right to left.

Raw log entry:

website: www.aliyun.com

Transformation rule:

e_set("str_partition",str_rpartition(v("website"),"."))

Result:

  website: www.aliyun.com
  str_partition: ["www.aliyun", ".", "com"]

str_center

Syntax
```
str_center(value, width, fillchar)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to modify.
width	Number	Yes	The length of the padded string.
fillchar	Arbitrary (automatically converted to a string)	No	The pad character. The default pad character is a space character.

Response
A padded string is returned.

Note If the length of the padded string is less than the length of the original string, the original string is returned.

Examples

Example 1: Pad a string with asterisks (*).

Raw log entry:

center: this is center

Transformation rule:

e_set("str_center", str_center(v("center"), 40, "*"))

Result:

center: this is center
str_center: *************this is center*************

Example 2: Pad a string with space characters.

Raw log entry:

center: this is center

Transformation rule:

e_set("str_center",str_center(v("center"),40))

Result:

center: this is center
str_center:              this is center

str_zfill

Syntax
```
str_zfill(value, width)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to modify.
width	Number	Yes	The length of the padded string.

Response
A padded string is returned.

Example

Raw log entry:

center: this is zfill

Transformation rule:

e_set("str_zfill",str_zfill(v("center"),40))

Result:

center:this is zfill
str_zfill:000000000000000000000000000this is zfill

str_expandtabs

Syntax
```
str_expandtabs(value, tabsize)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to modify.
tabsize	Number	Yes	Specifies the number of space characters after the conversion.

Response
A converted string is returned.

Examples

Example 1: Convert \t in the logstash string to a space character.

Raw log entry:

logstash: this is\tstring

Transformation rule:

e_set("str_expandtabs",str_expandtabs(v("logstash")))

Result:

logstash: this is\tstring
str_expandtabs: this is string

Example 2: Convert \t in the center string to space characters.

Raw log entry:

{"center": "this is\tstring"}

Transformation rule:

e_set("str_expandtabs",str_expandtabs(v("center"),16))

Result:

center: this is\tstring
str_expandtabs: this is         string

str_ljust

Syntax
```
str_ljust(value, width, fillchar)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to modify.
width	Number	Yes	The length of the padded string.
fillchar	Arbitrary (automatically converted to a string)	No	The pad character. The default pad character is a space character.

Response
A padded string is returned.

Note If the length of the padded string is less than the length of the original string, the original string is returned.

Examples

Example 1

Raw log entry:

content: this is ljust

Transformation rule:

e_set("str_ljust",str_ljust(v("content"),20,"*"))

Result:

content: this is ljust
str_ljust: this is ljust*******

Example 2

Raw log entry:

center: this is ljust

Transformation rule:

e_set("str_ljust",str_ljust(v("center"),20,))

Result:

center: this is ljust
str_ljust: this is ljust

Example 3: The original string is returned because the length of the padded string is less than the length of the original string.
Raw log entry:
```
center: this is ljust
```
Transformation rule:
```
e_set("str_ljust",str_ljust(v("center"),10,"*"))
```
Result:
```
center: this is ljust
str_ljust: this is ljust
```

str_rjust

Syntax
```
str_ljust(value, width, fillchar)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The original string that you want to modify.
width	Number	Yes	The length of the padded string.
fillchar	Arbitrary (automatically converted to a string)	No	The pad character. The default pad character is a space character.

Response
A padded string is returned.

Note If the length of the padded string is less than the length of the original string, the original string is returned.

Example

Raw log entry:

center: this is rjust

Transformation rule:

e_set("str_rjust",str_rjust(v("center"),20,"*"))

Result:

center: this is rjust
str_rjust: *******this is rjust

str_zip

Syntax

str_zip(value1, value2, combine_sep=None, sep=None, quote=None, lparse=None, rparse=None)

Parameters


Parameter	Type	Required	Description
value 1	Arbitrary (automatically converted to a string)	Yes	The value that you want to merge.
value 2	Arbitrary (automatically converted to a string)	Yes	The value that you want to merge.
combine_sep	Arbitrary (automatically converted to a string)	No	The identifier that is used to merge the elements. Default value: `#`.
sep	Arbitrary (automatically converted to a string)	No	The delimiter between the merged elements. The value must be a single character. Default value: `,`.
quote	Arbitrary (automatically converted to a string)	No	The character that encloses the merged elements. This parameter is required if the merged elements contain a delimiter. Default value: `"`.
lparse	Arbitrary (automatically converted to a string)	No	The delimiter and quote that are used among the elements of `value 1`. The default delimiter is `,` and the default quote is `"`. The format is `lparse=(',', '"')`. Note The quote has a higher priority than the delimiter.
rparse	Arbitrary (automatically converted to a string)	No	The delimiter and quote that are used among the elements of `value 2`. The default delimiter is `,` and the default quote is `"`. The format is `rparse=(',', '"')`. Note The quote has a higher priority than the delimiter.

Response
A merged string is returned.

Examples

Example 1

Raw log entry:

website: wwww.aliyun.com
escape_name: o

Transformation rule:

e_set("combine",str_zip(v("website"),v("escape_name"), combine_sep="@"))

Result:

website: wwww.aliyun.com
escape_name: o
combine: wwww.aliyun.com@o

Example 2

Raw log entry:

website: wwww.aliyun.com
escape_name: o

Transformation rule:

e_set("combine",str_zip(v("website"),v("escape_name")))

Result:

website: wwww.aliyun.com
escape_name: o
wwww.aliyun.com#o

Example 3: In this example, the sep parameter is specified.

Raw log entry:

f1: a,b,c
f2: x,y,z

Transformation rule:

e_set("combine",str_zip(v("f1"), v("f2"), sep="|"))

Result:

f1: a,b,c
f2: x,y,z
combine: a#x|b#y|c#z

Example 4: In this example, the quote parameter is specified.

Raw log entry:

f1: "a,a", b, "c,c"
f2: x, "y,y", z

Transformation rule:

e_set("combine",str_zip(v("f1"), v("f2"), quote='|'))

Result:

f1: "a,a", b, "c,c"
f2: x, "y,y", z
combine: |a,a#x|,|b#y,y|,|c,c#z|

Example 5: In this example, elements with different lengths are used.
Raw log entry:
```
f1: a,b
f2: x,y,z
```
Transformation rule:
```
e_set("combine",str_zip(v("f1"), v("f2")))
```
Result:
```
f1: a,b
f2: x,y,z
combine: a#x,b#y
```

Example 6: In this example, the lparse and rparse parameters are specified.

Raw log entry:

f1: a#b#c
f2: x|y|z

Transformation rule:

e_set("combine",str_zip(v("f1"), v("f2"), lparse=("#", '"'), rparse=("|", '"')))

Result:

f1: a#b#c
f2: x|y|z
combine: a#x,b#y,c#z

Example 7: In this example, the lparse and rparse parameters are specified.

Raw log entry:

f1: |a,a|, b, |c,c|
f2: x, #y,y#, z

Transformation rule:

e_set("combine",str_zip(v("f1"), v("f2"), lparse=(",", '|'), rparse=(",", '#')))

Result:

f1: |a,a|, b, |c,c|
f2: x, #y,y#, z
combine: "a,a#x","b#y,y","c,c#z"

str_isalnum

Syntax
```
str_isalnum(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

content: 13

Transformation rule:

e_set("str_isalnum",str_isalnum(v("content")))

Result:

content: 13
str_isalnum: True

str_isalpha

Syntax
```
str_isalpha(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

content: 13

Transformation rule:

e_set("str_isalpha",str_isalpha(v("content")))

Result:

content: 13
str_isalpha: False

str_isascii

Syntax
```
str_isascii(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

content: asw123

Transformation rule:

e_set("str_isascii",str_isascii(v("content")))

Result:

content: asw123
str_isascii: True

str_isdecimal

Syntax
```
str_isdecimal(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Examples

Example 1

Raw log entry:

welcome: hello

Transformation rule:

e_set("str_isdecimal",str_isdecimal(v("welcome")))

Result:

welcome: hello
str_isdecimal: False

Example 2

Raw log entry:

num: 123

Transformation rule:

e_set("str_isdecimal",str_isdecimal(v("num")))

Result:

num: 123
str_isdecimal: True

str_isdigit

Syntax
```
str_isdigit(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

content: 13

Transformation rule:

e_set("str_isdigit",str_isdigit(v("content")))

Result:

content: 13
str_isdigit: True

str_isidentifier

Syntax
```
str_isidentifier(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

class: class

Transformation rule:

e_set("str_isidentifier",str_isidentifier(v("class")))

Result:

class: class
str_isidentifier: True

str_islower

Syntax
```
str_islower(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

lower: asds

Transformation rule:

e_set("str_islower",str_islower(v("lower")))

Result:

lower: asds
str_islower: True

str_isnumeric

Syntax
```
str_isnumeric(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

num: 123

Transformation rule:

e_set("str_isnumeric",str_isnumeric(v("num")))

Result:

num: 123
str_isnumeric: True

str_isprintable

Syntax
```
str_isprintable(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

content: vs;,.as

Transformation rule:

e_set("str_isprintable",str_isprintable(v("content")))

Result:

content: vs;,.as
str_isprintable: True

str_isspace

Syntax
```
str_isspace(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

space:  as afsd

Transformation rule:

e_set("str_isspace",str_isspace(v("space")))

Result:

space:  as afsd
str_isspace: False

str_istitle

Syntax
```
str_istitle(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

title: Alex

Transformation rule:

e_set("str_istitle",str_istitle(v("title")))

Result:

title: Alex
str_istitle: True

str_isupper

Syntax
```
str_istitle(value)
```

Parameters


Parameter	Type	Required	Description
value	Arbitrary (automatically converted to a string)	Yes	The string that you want to check.

Response
The value True or False is returned.

Example

Raw log entry:

content: ASSD

Transformation rule:

e_set("str_isupper",str_isupper(v("content")))

Result:

content: ASSD
str_isupper: True

str_uuid

Syntax
```
str_uuid(lower=True)
```

Parameters


Parameter	Type	Required	Description
lower	Bool	No	Specifies whether the letters in the generated UUID are in lowercase. Default value: True. This value indicates that the letters are in lowercase.

Response
A UUID is returned.

Examples

Example 1

Raw log entry:

content: I am Iran man

Transformation rule:

e_set("UUID",str_uuid())

Result:

content: I am Iran man
UUID: dcc54d7e-c95f-11e9-9791-ffd6754a4f32

Example 2

Raw log entry:

content: I am Iran man

Transformation rule:

e_set("UUID",str_uuid(lower=False))

Result:

content: I am Iran man
UUID: DCC72D74-C95F-11E9-9921-F395B8647FFA