Skip to content

Commit

Permalink
generate-component-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@scMarkus
scMarkus committed Aug 28, 2023
1 parent 6224fe2 commit 75a55fd
Show file tree
Hide file tree
Showing 26 changed files with 1,924 additions and 260 deletions.
84 changes: 74 additions & 10 deletions website/cue/reference/components/sinks/base/amqp.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,18 +127,82 @@ base: components: sinks: amqp: configuration: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
Configures the fields that will be encoded, as well as the order in which they
appear in the output.
type: object: options: {
capacity: {
description: """
Set the capacity (in bytes) of the internal buffer used in the CSV writer.
This defaults to a reasonable setting.
"""
required: false
type: uint: default: 8192
}
delimiter: {
description: "The field delimiter to use when writing CSV."
required: false
type: uint: default: 44
}
double_quote: {
description: """
Enable double quote escapes.
This is enabled by default, but it may be disabled. When disabled, quotes in
field data are escaped instead of doubled.
"""
required: false
type: bool: default: true
}
escape: {
description: """
The escape character to use when writing CSV.
If a field is not present in the event, the output will be an empty string.
In some variants of CSV, quotes are escaped using a special escape character
like \\ (instead of escaping quotes by doubling them).
Values of type `Array`, `Object`, and `Regex` are not supported and the
output will be an empty string.
"""
required: true
type: array: items: type: string: {}
To use this `double_quotes` needs to be disabled as well otherwise it is ignored
"""
required: false
type: uint: default: 34
}
fields: {
description: """
Configures the fields that will be encoded, as well as the order in which they
appear in the output.
If a field is not present in the event, the output will be an empty string.
Values of type `Array`, `Object`, and `Regex` are not supported and the
output will be an empty string.
"""
required: true
type: array: items: type: string: {}
}
quote: {
description: "The quote character to use when writing CSV."
required: false
type: uint: default: 34
}
quote_style: {
description: "The quoting style to use when writing CSV data."
required: false
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
Quotes are also necessary when writing an empty record
(which is indistinguishable from a record with one empty field).
"""
never: "This never writes quotes, even if it would produce invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
Namely, when writing a field that does not parse as a valid float or integer,
then quotes will be used even if they aren’t strictly necessary.
"""
}
}
}
}
}
except_fields: {
Expand Down
84 changes: 74 additions & 10 deletions website/cue/reference/components/sinks/base/aws_cloudwatch_logs.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -298,18 +298,82 @@ base: components: sinks: aws_cloudwatch_logs: configuration: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
Configures the fields that will be encoded, as well as the order in which they
appear in the output.
type: object: options: {
capacity: {
description: """
Set the capacity (in bytes) of the internal buffer used in the CSV writer.
This defaults to a reasonable setting.
"""
required: false
type: uint: default: 8192
}
delimiter: {
description: "The field delimiter to use when writing CSV."
required: false
type: uint: default: 44
}
double_quote: {
description: """
Enable double quote escapes.
If a field is not present in the event, the output will be an empty string.
This is enabled by default, but it may be disabled. When disabled, quotes in
field data are escaped instead of doubled.
"""
required: false
type: bool: default: true
}
escape: {
description: """
The escape character to use when writing CSV.
Values of type `Array`, `Object`, and `Regex` are not supported and the
output will be an empty string.
"""
required: true
type: array: items: type: string: {}
In some variants of CSV, quotes are escaped using a special escape character
like \\ (instead of escaping quotes by doubling them).
To use this `double_quotes` needs to be disabled as well otherwise it is ignored
"""
required: false
type: uint: default: 34
}
fields: {
description: """
Configures the fields that will be encoded, as well as the order in which they
appear in the output.
If a field is not present in the event, the output will be an empty string.
Values of type `Array`, `Object`, and `Regex` are not supported and the
output will be an empty string.
"""
required: true
type: array: items: type: string: {}
}
quote: {
description: "The quote character to use when writing CSV."
required: false
type: uint: default: 34
}
quote_style: {
description: "The quoting style to use when writing CSV data."
required: false
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
Quotes are also necessary when writing an empty record
(which is indistinguishable from a record with one empty field).
"""
never: "This never writes quotes, even if it would produce invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
Namely, when writing a field that does not parse as a valid float or integer,
then quotes will be used even if they aren’t strictly necessary.
"""
}
}
}
}
}
except_fields: {
Expand Down
84 changes: 74 additions & 10 deletions website/cue/reference/components/sinks/base/aws_kinesis_firehose.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -277,18 +277,82 @@ base: components: sinks: aws_kinesis_firehose: configuration: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
Configures the fields that will be encoded, as well as the order in which they
appear in the output.
type: object: options: {
capacity: {
description: """
Set the capacity (in bytes) of the internal buffer used in the CSV writer.
This defaults to a reasonable setting.
"""
required: false
type: uint: default: 8192
}
delimiter: {
description: "The field delimiter to use when writing CSV."
required: false
type: uint: default: 44
}
double_quote: {
description: """
Enable double quote escapes.
If a field is not present in the event, the output will be an empty string.
This is enabled by default, but it may be disabled. When disabled, quotes in
field data are escaped instead of doubled.
"""
required: false
type: bool: default: true
}
escape: {
description: """
The escape character to use when writing CSV.
Values of type `Array`, `Object`, and `Regex` are not supported and the
output will be an empty string.
"""
required: true
type: array: items: type: string: {}
In some variants of CSV, quotes are escaped using a special escape character
like \\ (instead of escaping quotes by doubling them).
To use this `double_quotes` needs to be disabled as well otherwise it is ignored
"""
required: false
type: uint: default: 34
}
fields: {
description: """
Configures the fields that will be encoded, as well as the order in which they
appear in the output.
If a field is not present in the event, the output will be an empty string.
Values of type `Array`, `Object`, and `Regex` are not supported and the
output will be an empty string.
"""
required: true
type: array: items: type: string: {}
}
quote: {
description: "The quote character to use when writing CSV."
required: false
type: uint: default: 34
}
quote_style: {
description: "The quoting style to use when writing CSV data."
required: false
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
Quotes are also necessary when writing an empty record
(which is indistinguishable from a record with one empty field).
"""
never: "This never writes quotes, even if it would produce invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
Namely, when writing a field that does not parse as a valid float or integer,
then quotes will be used even if they aren’t strictly necessary.
"""
}
}
}
}
}
except_fields: {
Expand Down
84 changes: 74 additions & 10 deletions website/cue/reference/components/sinks/base/aws_kinesis_streams.cue
View file
Original file line number Diff line number Diff line change
Expand Up @@ -277,18 +277,82 @@ base: components: sinks: aws_kinesis_streams: configuration: {
description: "The CSV Serializer Options."
relevant_when: "codec = \"csv\""
required: true
type: object: options: fields: {
description: """
Configures the fields that will be encoded, as well as the order in which they
appear in the output.
type: object: options: {
capacity: {
description: """
Set the capacity (in bytes) of the internal buffer used in the CSV writer.
This defaults to a reasonable setting.
"""
required: false
type: uint: default: 8192
}
delimiter: {
description: "The field delimiter to use when writing CSV."
required: false
type: uint: default: 44
}
double_quote: {
description: """
Enable double quote escapes.
If a field is not present in the event, the output will be an empty string.
This is enabled by default, but it may be disabled. When disabled, quotes in
field data are escaped instead of doubled.
"""
required: false
type: bool: default: true
}
escape: {
description: """
The escape character to use when writing CSV.
Values of type `Array`, `Object`, and `Regex` are not supported and the
output will be an empty string.
"""
required: true
type: array: items: type: string: {}
In some variants of CSV, quotes are escaped using a special escape character
like \\ (instead of escaping quotes by doubling them).
To use this `double_quotes` needs to be disabled as well otherwise it is ignored
"""
required: false
type: uint: default: 34
}
fields: {
description: """
Configures the fields that will be encoded, as well as the order in which they
appear in the output.
If a field is not present in the event, the output will be an empty string.
Values of type `Array`, `Object`, and `Regex` are not supported and the
output will be an empty string.
"""
required: true
type: array: items: type: string: {}
}
quote: {
description: "The quote character to use when writing CSV."
required: false
type: uint: default: 34
}
quote_style: {
description: "The quoting style to use when writing CSV data."
required: false
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
Quotes are also necessary when writing an empty record
(which is indistinguishable from a record with one empty field).
"""
never: "This never writes quotes, even if it would produce invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
Namely, when writing a field that does not parse as a valid float or integer,
then quotes will be used even if they aren’t strictly necessary.
"""
}
}
}
}
}
except_fields: {
Expand Down
Loading

0 comments on commit 75a55fd

Please sign in to comment.