Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tobz committed Sep 19, 2023
1 parent 06b2ad2 commit 4bf857c
Show file tree
Hide file tree
Showing 46 changed files with 222 additions and 222 deletions.
14 changes: 7 additions & 7 deletions website/cue/reference/components/sinks/base/amqp.cue
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ base: components: sinks: amqp: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -187,18 +187,18 @@ base: components: sinks: amqp: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ base: components: sinks: aws_cloudwatch_logs: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -358,18 +358,18 @@ base: components: sinks: aws_cloudwatch_logs: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ base: components: sinks: aws_kinesis_firehose: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -337,18 +337,18 @@ base: components: sinks: aws_kinesis_firehose: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ base: components: sinks: aws_kinesis_streams: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -337,18 +337,18 @@ base: components: sinks: aws_kinesis_streams: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
14 changes: 7 additions & 7 deletions website/cue/reference/components/sinks/base/aws_s3.cue
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ base: components: sinks: aws_s3: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -446,18 +446,18 @@ base: components: sinks: aws_s3: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
14 changes: 7 additions & 7 deletions website/cue/reference/components/sinks/base/aws_sns.cue
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ base: components: sinks: aws_sns: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -273,18 +273,18 @@ base: components: sinks: aws_sns: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
14 changes: 7 additions & 7 deletions website/cue/reference/components/sinks/base/aws_sqs.cue
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ base: components: sinks: aws_sqs: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -273,18 +273,18 @@ base: components: sinks: aws_sqs: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
14 changes: 7 additions & 7 deletions website/cue/reference/components/sinks/base/azure_blob.cue
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ base: components: sinks: azure_blob: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -300,18 +300,18 @@ base: components: sinks: azure_blob: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
14 changes: 7 additions & 7 deletions website/cue/reference/components/sinks/base/console.cue
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ base: components: sinks: console: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -171,18 +171,18 @@ base: components: sinks: console: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
14 changes: 7 additions & 7 deletions website/cue/reference/components/sinks/base/databend.cue
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ base: components: sinks: databend: configuration: {
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
To use this, `double_quotes` needs to be disabled as well otherwise it is ignored.
"""
required: false
type: uint: default: 34
Expand Down Expand Up @@ -216,18 +216,18 @@ base: components: sinks: databend: configuration: {
type: string: {
default: "necessary"
enum: {
always: "This puts quotes around every field. Always."
always: "Always puts quotes around every field."
necessary: """
This puts quotes around fields only when necessary.
They are necessary when fields contain a quote, delimiter or record terminator.
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."
never: "Never writes quotes, even if it produces invalid CSV data."
non_numeric: """
This puts quotes around all fields that are non-numeric.
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 arent strictly necessary.
then quotes are used even if they aren't strictly necessary.
"""
}
}
Expand Down
Loading

0 comments on commit 4bf857c

Please sign in to comment.