github.com/Jeffail/benthos/v3@v3.65.0/lib/message/batch/docs.go

package batch

import "github.com/Jeffail/benthos/v3/internal/docs"

// FieldSpec returns a spec for a common batching field.
func FieldSpec() docs.FieldSpec {
	return docs.FieldSpec{
		Name: "batching",
		Type: docs.FieldTypeObject,
		Description: `
Allows you to configure a [batching policy](/docs/configuration/batching).`,
		Examples: []interface{}{
			map[string]interface{}{
				"count":     0,
				"byte_size": 5000,
				"period":    "1s",
			},
			map[string]interface{}{
				"count":  10,
				"period": "1s",
			},
			map[string]interface{}{
				"count":  0,
				"period": "1m",
				"check":  `this.contains("END BATCH")`,
			},
		},
		Children: docs.FieldSpecs{
			docs.FieldInt(
				"count",
				"A number of messages at which the batch should be flushed. If `0` disables count based batching.",
			),
			docs.FieldInt(
				"byte_size",
				"An amount of bytes at which the batch should be flushed. If `0` disables size based batching.",
			).HasDefault(0),
			docs.FieldString(
				"period",
				"A period in which an incomplete batch should be flushed regardless of its size.",
				"1s", "1m", "500ms",
			).HasDefault(""),
			docs.FieldBloblang(
				"check",
				"A [Bloblang query](/docs/guides/bloblang/about/) that should return a boolean value indicating whether a message should end a batch.",
				`this.type == "end_of_transaction"`,
			).HasDefault(""),
			docs.FieldDeprecated("condition").HasType(docs.FieldTypeCondition).OmitWhen(func(v, _ interface{}) (string, bool) {
				m, ok := v.(map[string]interface{})
				if !ok {
					return "", false
				}
				return "field condition is deprecated in favour of check", m["type"] == "static" && m["static"] == false
			}),
			docs.FieldAdvanced(
				"processors",
				"A list of [processors](/docs/components/processors/about) to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. Please note that all resulting messages are flushed as a single batch, therefore splitting the batch into smaller batches using these processors is a no-op.",
				[]map[string]interface{}{
					{
						"archive": map[string]interface{}{
							"format": "lines",
						},
					},
				},
				[]map[string]interface{}{
					{
						"archive": map[string]interface{}{
							"format": "json_array",
						},
					},
				},
				[]map[string]interface{}{
					{
						"merge_json": struct{}{},
					},
				},
			).Array().HasType(docs.FieldTypeProcessor).Optional(),
		},
	}
}