# Functions

Use these functions in the **[Advanced Search](https://docs.kloudfuse.com/platform/3.2.5/logs-advanced-search/)** interface to perform relatively complex data transformations. The **Logs Query Builder** does not natively support these functions.

## base64Decode

Converts a base64 string into to an ASCII/UTF-8 string.

**Syntax**

```console
| base64Decode(<base64String>) as <alias>
```

**Example**

The following example returns K with a value of `Hello World`.

```console
| base64Decode("SGVsbG8gV29ybGQ=") as K
```

## base64Encode

Converts an ASCII/UTF-8 string to a base64 string.

**Syntax**

```console
| base64Encode(<string>) as <alias>
```

**Example**

The following example returns K with a value of `SGVsbG8gV29ybGQ=`.

```console
| base64Encode("Hello World") as K
```

## getCIDRPrefix

Retrieves the network prefix from an IPv4 address.

**Syntax**

```console
| getCIDRPrefix(<ipv4String>) as <alias>
```

**Example**

The following example returns K with a value of 24.

```console
| getCIDRPrefix("10.10.1.35") as K
```

## compareCIDRPrefix

Check if the network prefixes of two IPv4 addresses match.

**Syntax**

```console
| compareCIDRPrefix(<ipv4String>, <ipv4String>) as <alias>
```

**Examples**

The following example returns K with a value of true.

```console
| compareCIDRPrefix("10.10.1.35", "10.10.1.35", 24) as K
```

The following example returns K with a value of false.

```console
| compareCIDRPrefix("10.10.1.35", "11.11.2.35", 24) as K
```

## maskFromCIDR

Returns the subnet mask given a prefix length for IPv4 addresses.

**Syntax**

```console
| maskFromCIDR(<prefixLength>) as <alias>

where <prefixLength> is 0-32
```

**Examples**

The following example returns K with a value of `255.255.255.255`.

```console
| maskFromCIDR(32) as K
```

The following example returns K with a value of `255.255.255.254`.

```console
| maskFromCIDR(31) as K
```

## concat

Concatenates multiple strings, numbers into a new string.

**Syntax**

```console
| concat(<field1>, <field2>, ...) as <alias>
```

**Example**

The following example returns K with a value of `Hello World 1`.

```console
| concat("Hello", " ", "World", " ", 1) as K
```

## decToHex

Converts long value to hexadecimal value.

**Syntax**

```console
| decToHex(<longField>) as <alias>
```

**Example**

The following example returns K with a value of `461`.

```console
| decToHex("70") as K
```

## format

Returns a formatted string given a format specifier and arguments.

**Syntax**

```console
| format(<formatSpecifierString>, <field1>, ...) as <alias>
```

**Example**

The following example returns K with a value of `The count is: 1`.

```console
| format("%s : %s", "The count is", 1) as K
```

## formatDate

Returns a date string given a date, format, and timezone (default UTC).

**Syntax**

```console
| formatDate(<dateMilliseconds>) as <alias>

| formatDate(<dateMilliseconds>, <formatString>) as <alias>

| formatDate(<dateMilliseconds>, <formatString>, <timezoneString>) as <alias>
```

**Examples**

The following example returns K with a value of `2024-11-06T20:33:37Z`.

```console
| formatDate(1730925217838) as K
```

The following example returns K with a value of `11-06-2024`.

```console
| formatDate(1730925217838, "01-02-2006") as K
```

The following example returns K with a value of `2024-11-06 12:33:37`.

```console
| formatDate(1730925217838, "2006-01-02 15:04:05", "America/Los_Angeles") as K
```

## hash

Hashes data into a string value using the specified hash algorithm. Supported hash algorithms are MD5, SHA1, SHA2, and MurmurHash3.

**Syntax**

```console
| hash(<field>) as <alias>

| hash(<field>, <hashAlgorithm>) as <alias>

where <hashAlgorithm> is either md5(default), sha1, sha2_256, or murmur3_128
```

**Examples**

The following example returns K with a value of `5eb63bbbe01eeed093cb22bb8f5acdc3`.

```console
| hash("hello world") as K
```

The following example returns K with a value of `2aae6c35c94fcfb415dbe95f408b9ce91ee846ed`.

```console
| hash("hello world", "sha1") as K
```

## hexToAscii

Converts hexadecimal string to ASCII value.

**Syntax**

```console
| hexToAscii(<hexString>) as <alias>
```

**Example**

The following example returns K with a value of `Hello Gopher!`.

```console
| hexToAscii("48656c6c6f20476f7068657221") as K
```

## hexToDec

Converts hexadecimal string to a long value.

**Syntax**

```console
| hexToDec(<hexString>) as <alias>
```

**Example**

The following example returns K with a value of 4919.

```console
| hexToAscii("0000000000001337") as K
```

## ipv4ToNumber

Converts an Internet Protocol version 4 (IPv4) IP address from the octet dot-decimal format to a decimal format.

**Syntax**

```console
| ipv4ToNumber(<ipv4String>) as <alias>
```

**Example**

The following example returns K with a value of 178455296.

```console
| ipv4ToNumber("10.163.3.0") as K
```

## isEmpty

Checks if a string value is an empty string containing no characters or whitespace.

**Syntax**

```console
| isEmpty(<string>) as <alias>
```

**Example**

The following example returns K with a value of false.

```console
| isEmpty(" a ") as K
```

## isBlank

Checks if a string value is null, empty, or contains only empty characters.

**Syntax**

```console
| isBlank(<string>) as <alias>
```

**Example**

The following example returns K with a value of true.

```console
| isBlank("  ") as K
```

## isNumeric

Checks if a string value can be parsed as a number.

**Syntax**

```console
| isNumeric(<string>) as <alias>
```

**Example**

The following example returns K with a value of true.

```console
| isNumeric("1.234") as K
```

## isPrivateIP

Checks if an IPv4 address is private.

**Syntax**

```console
| isPrivateIP(<ipv4String>) as <alias>
```

**Example**

The following example returns K with a value of true.

```console
| isPrivateIP("192.168.0.1") as K
```

## isPublicIP

Checks if an IPv4 address is public.

**Syntax**

```console
| isPublicIP(<ipv4String>) as <alias>
```

**Example**

The following example returns K with a value of false.

```console
| isPrivateIP("192.168.0.1") as K
```

## isValidIP

Checks if an IPv4 or IPv6 address is valid.

**Syntax**

```console
| isValidIP(<ipString>) as <alias>
```

**Examples**

The following example returns K with a value of true.

```console
| isValidIP("192.168.0.1") as K
```

The following example returns K with a value of false.

```console
| isValidIP("192.168.400.1") as K
```

## len

Returns the length of a string.

**Syntax**

```console
| len(<string>) as <alias>
```

**Example**

The following example returns K with a value of `4`.

```console
| len("1234") as K
```

## luhn

Validates credit card numbers in a string value using Luhn’s algorithm. The operator removes all non-numeric values and checks if the resulting string is a valid credit card number.

**Syntax**

```console
| luhn(<string>) as <alias>
```

**Examples**

The following example returns K with a value of true.

```console
| luhn("6666-7777-6666-8888") as K
```

The following example returns K with a value of false.

```console
| luhn("00000000000000031") as K
```

## now

Returns the current epoch time in milliseconds.

**Syntax**

```console
| now() as <alias>
```

**Examples**

```console
| now() as K
| formatDate(now(), "YYYY-MM-dd") as today
```

## queryEndTime

Returns the end time of the search in milliseconds.

**Syntax**

```console
| queryEndTime() as <alias>
```

**Examples**

```console
| queryEndTime() as K
```

## queryStartTime

Returns the start time of the search in milliseconds.

**Syntax**

```console
| queryStartTime() as <alias>
```

**Examples**

```console
| queryStartTime() as K
```

## queryTimeRange

Returns the time range for the query being executed in milliseconds.

**Syntax**

```console
| queryTimeRange() as <alias>
```

**Examples**

```console
| queryTimeRange() as K
```

## replace

Replaces all occurrences of a specified string with another string. The specified string can be a literal or regex.

**Syntax**

```console
| replace(<sourceString>, <searchString>, <replaceString>) as <alias>

| replace(<sourceString>, <regexString>, <replaceString>) as <alias>
```

**Examples**

The following example returns K with a value of `hello gopher`.

```console
| replace("hello world", "world", "gopher") as K
```

The following example returns K with a value of `"http://kloudfuse.com/products//logs"`.

```console
| replace("http://kloudfuse.com/products/12345678/logs", "[0-9]{5,}", "") as K
```

## substring

Extract a part of a given string and start/end offsets. If end offset is not provided, the substring is taken until the end of the source string.

**Syntax**

```console
| substring(<sourceString>, <startOffsert>) as <alias>

| substring(<sourceString>, <startOffsert>, <endOffset>) as <alias>
```

**Example**

The following example returns K with a value of `hello`.

```console
| substring("hello world", 0, 5) as K
```

## toBytes

Parses a string representation of bytes (KB, MB, GB, etc.) into the number of bytes it represents.

**Syntax**

```console
| toBytes(<storageSize>) as <alias>
```

**Examples**

The following example returns K with a value of 1500.

```console
| toBytes("1.5KB") as K
```

## toDuration

Parses a string representation of time (ns, µs, ms, s, m, h) to nanoseconds.

**Syntax**

```console
| toDuration(<timeString>) as <alias>
```

**Examples**

The following example returns K with a value of 2000000.

```console
| toFloat("2ms") as K
```

## toFloat

Parses a string representation of a number or a number to a float.

**Syntax**

```console
| toFloat(<number>) as <alias>

| toFloat(<numberString>) as <alias>
```

**Examples**

The following example returns K with a value of 1.25.

```console
| toFloat("1.25") as K
```

## toInt

Parses a string representation of a number or a number to an int.

**Syntax**

```console
| toInt(<number>) as <alias>

| toInt(<numberString>) as <alias>
```

**Example**

The following example returns K with a value of 1.

```console
| toInt("1.5") as K
```

## toLowerCase

Converts all letters of a string to lowercase.

**Syntax**

```console
| toLowerCase(<string>) as <alias>
```

**Example**

The following example returns K with a value of `hello world`.

```console
| toLowerCase("HELLO WORLD") as K
```

## toUpperCase

Converts all letters of a string to uppercase.

**Syntax**

```console
| toUpperCase(<string>) as <alias>
```

**Example**

The following example returns K with a value of `HELLO WORLD`.

```console
| toUpperCase("hello world") as K
```

## trim

Removes starting and trailing empty spaces in a string.

**Syntax**

```console
| trim(<string>) as <alias>
```

**Example**

The following example returns K with a value of `hello world`.

```console
| trim("  hello world   ") as K
```

## urlDecode

Returns an unescaped url string.

**Syntax**

```console
| urlDecode(<urlString>) as <alias>
```

**Example**

The following example returns K with a value of `http://example-server123.org/api/v1/data.php?auth=AbCdEfGhIjKlMnOpQrStUvWxYz123456&;`.

```console
| urlDecode("http%3A%2F%2Fexample-server123.org%2Fapi%2Fv1%2Fdata.php%3Fauth%3DAbCdEfGhIjKlMnOpQrStUvWxYz123456%26") as K
```

## urlEncode

Encodes url into ASCII character set.

**Syntax**

```console
| urlDecode(<urlString>) as <alias>
```

**Example**

The following example returns K with a value of `http%3A%2F%2Fexample-server123.org%2Fapi%2Fv1%2Fdata.php%3Fauth%3DAbCdEfGhIjKlMnOpQrStUvWxYz123456%26`.

```console
| urlEncode("http://example-server123.org/api/v1/data.php?auth=AbCdEfGhIjKlMnOpQrStUvWxYz123456&") as K
```