Skip to content

Commit 75a55fd

Browse files
scMarkusscMarkus
committed
generate-component-docs
1 parent 6224fe2 commit 75a55fd

26 files changed

+1924
-260
lines changed

‎website/cue/reference/components/sinks/base/amqp.cue

+74-10
Original file line numberDiff line numberDiff line change
@@ -127,18 +127,82 @@ base: components: sinks: amqp: configuration: {
127127
description: "The CSV Serializer Options."
128128
relevant_when: "codec = \"csv\""
129129
required: true
130-
type: object: options: fields: {
131-
description: """
132-
Configures the fields that will be encoded, as well as the order in which they
133-
appear in the output.
130+
type: object: options: {
131+
capacity: {
132+
description: """
133+
Set the capacity (in bytes) of the internal buffer used in the CSV writer.
134+
This defaults to a reasonable setting.
135+
"""
136+
required: false
137+
type: uint: default: 8192
138+
}
139+
delimiter: {
140+
description: "The field delimiter to use when writing CSV."
141+
required: false
142+
type: uint: default: 44
143+
}
144+
double_quote: {
145+
description: """
146+
Enable double quote escapes.
147+
148+
This is enabled by default, but it may be disabled. When disabled, quotes in
149+
field data are escaped instead of doubled.
150+
"""
151+
required: false
152+
type: bool: default: true
153+
}
154+
escape: {
155+
description: """
156+
The escape character to use when writing CSV.
134157
135-
If a field is not present in the event, the output will be an empty string.
158+
In some variants of CSV, quotes are escaped using a special escape character
159+
like \\ (instead of escaping quotes by doubling them).
136160
137-
Values of type `Array`, `Object`, and `Regex` are not supported and the
138-
output will be an empty string.
139-
"""
140-
required: true
141-
type: array: items: type: string: {}
161+
To use this `double_quotes` needs to be disabled as well otherwise it is ignored
162+
"""
163+
required: false
164+
type: uint: default: 34
165+
}
166+
fields: {
167+
description: """
168+
Configures the fields that will be encoded, as well as the order in which they
169+
appear in the output.
170+
171+
If a field is not present in the event, the output will be an empty string.
172+
173+
Values of type `Array`, `Object`, and `Regex` are not supported and the
174+
output will be an empty string.
175+
"""
176+
required: true
177+
type: array: items: type: string: {}
178+
}
179+
quote: {
180+
description: "The quote character to use when writing CSV."
181+
required: false
182+
type: uint: default: 34
183+
}
184+
quote_style: {
185+
description: "The quoting style to use when writing CSV data."
186+
required: false
187+
type: string: {
188+
default: "necessary"
189+
enum: {
190+
always: "This puts quotes around every field. Always."
191+
necessary: """
192+
This puts quotes around fields only when necessary.
193+
They are necessary when fields contain a quote, delimiter or record terminator.
194+
Quotes are also necessary when writing an empty record
195+
(which is indistinguishable from a record with one empty field).
196+
"""
197+
never: "This never writes quotes, even if it would produce invalid CSV data."
198+
non_numeric: """
199+
This puts quotes around all fields that are non-numeric.
200+
Namely, when writing a field that does not parse as a valid float or integer,
201+
then quotes will be used even if they aren’t strictly necessary.
202+
"""
203+
}
204+
}
205+
}
142206
}
143207
}
144208
except_fields: {

‎website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue

+74-10
Original file line numberDiff line numberDiff line change
@@ -298,18 +298,82 @@ base: components: sinks: aws_cloudwatch_logs: configuration: {
298298
description: "The CSV Serializer Options."
299299
relevant_when: "codec = \"csv\""
300300
required: true
301-
type: object: options: fields: {
302-
description: """
303-
Configures the fields that will be encoded, as well as the order in which they
304-
appear in the output.
301+
type: object: options: {
302+
capacity: {
303+
description: """
304+
Set the capacity (in bytes) of the internal buffer used in the CSV writer.
305+
This defaults to a reasonable setting.
306+
"""
307+
required: false
308+
type: uint: default: 8192
309+
}
310+
delimiter: {
311+
description: "The field delimiter to use when writing CSV."
312+
required: false
313+
type: uint: default: 44
314+
}
315+
double_quote: {
316+
description: """
317+
Enable double quote escapes.
305318
306-
If a field is not present in the event, the output will be an empty string.
319+
This is enabled by default, but it may be disabled. When disabled, quotes in
320+
field data are escaped instead of doubled.
321+
"""
322+
required: false
323+
type: bool: default: true
324+
}
325+
escape: {
326+
description: """
327+
The escape character to use when writing CSV.
307328
308-
Values of type `Array`, `Object`, and `Regex` are not supported and the
309-
output will be an empty string.
310-
"""
311-
required: true
312-
type: array: items: type: string: {}
329+
In some variants of CSV, quotes are escaped using a special escape character
330+
like \\ (instead of escaping quotes by doubling them).
331+
332+
To use this `double_quotes` needs to be disabled as well otherwise it is ignored
333+
"""
334+
required: false
335+
type: uint: default: 34
336+
}
337+
fields: {
338+
description: """
339+
Configures the fields that will be encoded, as well as the order in which they
340+
appear in the output.
341+
342+
If a field is not present in the event, the output will be an empty string.
343+
344+
Values of type `Array`, `Object`, and `Regex` are not supported and the
345+
output will be an empty string.
346+
"""
347+
required: true
348+
type: array: items: type: string: {}
349+
}
350+
quote: {
351+
description: "The quote character to use when writing CSV."
352+
required: false
353+
type: uint: default: 34
354+
}
355+
quote_style: {
356+
description: "The quoting style to use when writing CSV data."
357+
required: false
358+
type: string: {
359+
default: "necessary"
360+
enum: {
361+
always: "This puts quotes around every field. Always."
362+
necessary: """
363+
This puts quotes around fields only when necessary.
364+
They are necessary when fields contain a quote, delimiter or record terminator.
365+
Quotes are also necessary when writing an empty record
366+
(which is indistinguishable from a record with one empty field).
367+
"""
368+
never: "This never writes quotes, even if it would produce invalid CSV data."
369+
non_numeric: """
370+
This puts quotes around all fields that are non-numeric.
371+
Namely, when writing a field that does not parse as a valid float or integer,
372+
then quotes will be used even if they aren’t strictly necessary.
373+
"""
374+
}
375+
}
376+
}
313377
}
314378
}
315379
except_fields: {

‎website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue

+74-10
Original file line numberDiff line numberDiff line change
@@ -277,18 +277,82 @@ base: components: sinks: aws_kinesis_firehose: configuration: {
277277
description: "The CSV Serializer Options."
278278
relevant_when: "codec = \"csv\""
279279
required: true
280-
type: object: options: fields: {
281-
description: """
282-
Configures the fields that will be encoded, as well as the order in which they
283-
appear in the output.
280+
type: object: options: {
281+
capacity: {
282+
description: """
283+
Set the capacity (in bytes) of the internal buffer used in the CSV writer.
284+
This defaults to a reasonable setting.
285+
"""
286+
required: false
287+
type: uint: default: 8192
288+
}
289+
delimiter: {
290+
description: "The field delimiter to use when writing CSV."
291+
required: false
292+
type: uint: default: 44
293+
}
294+
double_quote: {
295+
description: """
296+
Enable double quote escapes.
284297
285-
If a field is not present in the event, the output will be an empty string.
298+
This is enabled by default, but it may be disabled. When disabled, quotes in
299+
field data are escaped instead of doubled.
300+
"""
301+
required: false
302+
type: bool: default: true
303+
}
304+
escape: {
305+
description: """
306+
The escape character to use when writing CSV.
286307
287-
Values of type `Array`, `Object`, and `Regex` are not supported and the
288-
output will be an empty string.
289-
"""
290-
required: true
291-
type: array: items: type: string: {}
308+
In some variants of CSV, quotes are escaped using a special escape character
309+
like \\ (instead of escaping quotes by doubling them).
310+
311+
To use this `double_quotes` needs to be disabled as well otherwise it is ignored
312+
"""
313+
required: false
314+
type: uint: default: 34
315+
}
316+
fields: {
317+
description: """
318+
Configures the fields that will be encoded, as well as the order in which they
319+
appear in the output.
320+
321+
If a field is not present in the event, the output will be an empty string.
322+
323+
Values of type `Array`, `Object`, and `Regex` are not supported and the
324+
output will be an empty string.
325+
"""
326+
required: true
327+
type: array: items: type: string: {}
328+
}
329+
quote: {
330+
description: "The quote character to use when writing CSV."
331+
required: false
332+
type: uint: default: 34
333+
}
334+
quote_style: {
335+
description: "The quoting style to use when writing CSV data."
336+
required: false
337+
type: string: {
338+
default: "necessary"
339+
enum: {
340+
always: "This puts quotes around every field. Always."
341+
necessary: """
342+
This puts quotes around fields only when necessary.
343+
They are necessary when fields contain a quote, delimiter or record terminator.
344+
Quotes are also necessary when writing an empty record
345+
(which is indistinguishable from a record with one empty field).
346+
"""
347+
never: "This never writes quotes, even if it would produce invalid CSV data."
348+
non_numeric: """
349+
This puts quotes around all fields that are non-numeric.
350+
Namely, when writing a field that does not parse as a valid float or integer,
351+
then quotes will be used even if they aren’t strictly necessary.
352+
"""
353+
}
354+
}
355+
}
292356
}
293357
}
294358
except_fields: {

‎website/cue/reference/components/sinks/base/aws_kinesis_streams.cue

+74-10
Original file line numberDiff line numberDiff line change
@@ -277,18 +277,82 @@ base: components: sinks: aws_kinesis_streams: configuration: {
277277
description: "The CSV Serializer Options."
278278
relevant_when: "codec = \"csv\""
279279
required: true
280-
type: object: options: fields: {
281-
description: """
282-
Configures the fields that will be encoded, as well as the order in which they
283-
appear in the output.
280+
type: object: options: {
281+
capacity: {
282+
description: """
283+
Set the capacity (in bytes) of the internal buffer used in the CSV writer.
284+
This defaults to a reasonable setting.
285+
"""
286+
required: false
287+
type: uint: default: 8192
288+
}
289+
delimiter: {
290+
description: "The field delimiter to use when writing CSV."
291+
required: false
292+
type: uint: default: 44
293+
}
294+
double_quote: {
295+
description: """
296+
Enable double quote escapes.
284297
285-
If a field is not present in the event, the output will be an empty string.
298+
This is enabled by default, but it may be disabled. When disabled, quotes in
299+
field data are escaped instead of doubled.
300+
"""
301+
required: false
302+
type: bool: default: true
303+
}
304+
escape: {
305+
description: """
306+
The escape character to use when writing CSV.
286307
287-
Values of type `Array`, `Object`, and `Regex` are not supported and the
288-
output will be an empty string.
289-
"""
290-
required: true
291-
type: array: items: type: string: {}
308+
In some variants of CSV, quotes are escaped using a special escape character
309+
like \\ (instead of escaping quotes by doubling them).
310+
311+
To use this `double_quotes` needs to be disabled as well otherwise it is ignored
312+
"""
313+
required: false
314+
type: uint: default: 34
315+
}
316+
fields: {
317+
description: """
318+
Configures the fields that will be encoded, as well as the order in which they
319+
appear in the output.
320+
321+
If a field is not present in the event, the output will be an empty string.
322+
323+
Values of type `Array`, `Object`, and `Regex` are not supported and the
324+
output will be an empty string.
325+
"""
326+
required: true
327+
type: array: items: type: string: {}
328+
}
329+
quote: {
330+
description: "The quote character to use when writing CSV."
331+
required: false
332+
type: uint: default: 34
333+
}
334+
quote_style: {
335+
description: "The quoting style to use when writing CSV data."
336+
required: false
337+
type: string: {
338+
default: "necessary"
339+
enum: {
340+
always: "This puts quotes around every field. Always."
341+
necessary: """
342+
This puts quotes around fields only when necessary.
343+
They are necessary when fields contain a quote, delimiter or record terminator.
344+
Quotes are also necessary when writing an empty record
345+
(which is indistinguishable from a record with one empty field).
346+
"""
347+
never: "This never writes quotes, even if it would produce invalid CSV data."
348+
non_numeric: """
349+
This puts quotes around all fields that are non-numeric.
350+
Namely, when writing a field that does not parse as a valid float or integer,
351+
then quotes will be used even if they aren’t strictly necessary.
352+
"""
353+
}
354+
}
355+
}
292356
}
293357
}
294358
except_fields: {

0 commit comments

Comments
 (0)