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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

{
  "anchor": "to_bool",
  "name": "to_bool",
  "category": "Coerce",
  "description": "Coerces the `value` into a boolean.",
  "arguments": [
    {
      "name": "value",
      "description": "The value to convert to a Boolean.",
      "required": true,
      "type": [
        "any"
      ]
    }
  ],
  "return": {
    "types": [
      "boolean"
    ],
    "rules": [
      "If `value` is `\"true\"`, `\"t\"`, `\"yes\"`, or `\"y\"`, `true` is returned.",
      "If `value` is `\"false\"`, `\"f\"`, `\"no\"`, `\"n\"`, or `\"0\"`, `false` is returned.",
      "If `value` is `0.0`, `false` is returned, otherwise `true` is returned.",
      "If `value` is `0`, `false` is returned, otherwise `true` is returned.",
      "If `value` is `null`, `false` is returned.",
      "If `value` is a Boolean, it's returned unchanged."
    ]
  },
  "internal_failure_reasons": [
    "`value` is not a supported boolean representation."
  ],
  "examples": [
    {
      "title": "Coerce to a Boolean (string)",
      "source": "to_bool!(\"yes\")",
      "return": true
    },
    {
      "title": "Coerce to a Boolean (float)",
      "source": "to_bool(0.0)",
      "return": false
    },
    {
      "title": "Coerce to a Boolean (int)",
      "source": "to_bool(0)",
      "return": false
    },
    {
      "title": "Coerce to a Boolean (null)",
      "source": "to_bool(null)",
      "return": false
    },
    {
      "title": "Coerce to a Boolean (Boolean)",
      "source": "to_bool(true)",
      "return": true
    },
    {
      "title": "Integer (other)",
      "source": "to_bool(2)",
      "return": true
    },
    {
      "title": "Float (other)",
      "source": "to_bool(5.6)",
      "return": true
    },
    {
      "title": "False",
      "source": "to_bool(false)",
      "return": false
    },
    {
      "title": "True string",
      "source": "to_bool!(s'true')",
      "return": true
    },
    {
      "title": "Y string",
      "source": "to_bool!(s'y')",
      "return": true
    },
    {
      "title": "Non-zero integer string",
      "source": "to_bool!(s'1')",
      "return": true
    },
    {
      "title": "False string",
      "source": "to_bool!(s'false')",
      "return": false
    },
    {
      "title": "No string",
      "source": "to_bool!(s'no')",
      "return": false
    },
    {
      "title": "N string",
      "source": "to_bool!(s'n')",
      "return": false
    },
    {
      "title": "Invalid string",
      "source": "to_bool!(s'foobar')",
      "raises": "function call error for \"to_bool\" at (0:19): Invalid boolean value \"foobar\""
    },
    {
      "title": "Timestamp",
      "source": "to_bool!(t'2020-01-01T00:00:00Z')",
      "raises": "function call error for \"to_bool\" at (0:33): unable to coerce timestamp into boolean"
    },
    {
      "title": "Array",
      "source": "to_bool!([])",
      "raises": "function call error for \"to_bool\" at (0:12): unable to coerce array into boolean"
    },
    {
      "title": "Object",
      "source": "to_bool!({})",
      "raises": "function call error for \"to_bool\" at (0:12): unable to coerce object into boolean"
    },
    {
      "title": "Regex",
      "source": "to_bool!(r'foo')",
      "raises": "function call error for \"to_bool\" at (0:16): unable to coerce regex into boolean"
    }
  ],
  "pure": true
}