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

{
  "anchor": "encode_csv",
  "name": "encode_csv",
  "category": "Codec",
  "description": "Encodes the `value` to a single CSV formatted row.",
  "arguments": [
    {
      "name": "value",
      "description": "The value to convert to a CSV string.",
      "required": true,
      "type": [
        "any"
      ]
    },
    {
      "name": "delimiter",
      "description": "The field delimiter to use when encoding. Must be a single-byte UTF-8 character.",
      "required": false,
      "type": [
        "string"
      ],
      "default": ","
    }
  ],
  "return": {
    "types": [
      "string"
    ]
  },
  "internal_failure_reasons": [
    "The delimiter must be a single-byte UTF-8 character.",
    "`value` is not an object convertible to a CSV string.",
    "The `csv` crate encountered an I/O error while writing or flushing the output."
  ],
  "examples": [
    {
      "title": "Encode object to a single CSV formatted row",
      "source": "encode_csv!([\"foo\",\"bar\",\"foo \\\", bar\"])",
      "return": "foo,bar,\"foo \"\", bar\""
    },
    {
      "title": "Encode object to a single CSV formatted row with custom delimiter",
      "source": "encode_csv!([\"foo\",\"bar\"], delimiter: \" \")",
      "return": "foo bar"
    },
    {
      "title": "Encode object to a single CSV formatted row with linebreaks",
      "source": "encode_csv!([\"line\", \"with_linebreak\", \"here\\n\", \"and\", \"\\nhere\"])",
      "return": "line,with_linebreak,\"here\n\",and,\"\nhere\""
    }
  ],
  "pure": true
}