vrl 0.32.0

Vector Remap Language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

{
  "anchor": "xxhash",
  "name": "xxhash",
  "category": "Checksum",
  "description": "Calculates a [xxHash](https://github.com/DoumanAsh/xxhash-rust) hash of the `value`.",
  "arguments": [
    {
      "name": "value",
      "description": "The string to calculate the hash for.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "variant",
      "description": "The xxHash hashing algorithm to use.",
      "required": false,
      "type": [
        "string"
      ],
      "default": "XXH32"
    }
  ],
  "return": {
    "types": [
      "string",
      "integer"
    ]
  },
  "examples": [
    {
      "title": "Calculate a hash using the default (XXH32) algorithm",
      "source": "xxhash(\"foo\")",
      "return": 3792637401
    },
    {
      "title": "Calculate a hash using the XXH32 algorithm",
      "source": "xxhash(\"foo\", \"XXH32\")",
      "return": 3792637401
    },
    {
      "title": "Calculate a hash using the XXH64 algorithm",
      "source": "xxhash(\"foo\", \"XXH64\")",
      "return": 3728699739546630719
    },
    {
      "title": "Calculate a hash using the XXH3-64 algorithm",
      "source": "xxhash(\"foo\", \"XXH3-64\")",
      "return": -6093828362558603894
    },
    {
      "title": "Calculate a hash using the XXH3-128 algorithm",
      "source": "xxhash(\"foo\", \"XXH3-128\")",
      "return": "161745101148472925293886522910304009610"
    }
  ],
  "notices": [
    "Due to limitations in the underlying VRL data types, this function converts the unsigned\n64-bit integer hash result to a signed 64-bit integer. Results higher than the signed\n64-bit integer maximum value wrap around to negative values. For the XXH3-128 hash\nalgorithm, values are returned as a string."
  ],
  "pure": true
}