formats

type Delimited struct {
	Name        string `hcl:",label"`
	Description string `hcl:"description,optional"`
	// Option to skip type detection for CSV parsing and assume all columns to be of type VARCHAR
	AllVarchar *bool `hcl:"all_varchar,optional"`

	// Option to allow the conversion of quoted values to NULL values
	AllowQuotedNulls *bool `hcl:"allow_quoted_nulls,optional"`

	// Character used to initiate comments.
	// Lines starting with a comment character (optionally preceded by space characters) are completely ignored; other lines containi
	Comment *string `hcl:"comment,optional"`

	// Specifies the date format to use when parsing dates.
	DateFormat *string `hcl:"date_format,optional"`

	// The decimal separator of numbers.
	DecimalSeparator *string `hcl:"decimal_separator,optional"`

	// Specifies the delimiter character that separates columns within each row (line) of the file.
	Delimiter *string `hcl:"delimiter,optional"`

	// Specifies the string that should appear before a data character sequence that matches the quote value.
	Escape *string `hcl:"escape,optional"`

	// Whether or not an extra filename column should be included in the result.
	Filename *bool `hcl:"filename,optional"`

	// Do not match the specified columns' values against the NULL string.
	// In the default case where the NULL string is empty,
	// this means that empty values will be read as zero-length strings rather than NULLs.
	ForceNotNull *[]string `hcl:"force_not_null,optional"`

	// Specifies that the file contains a header line with the names of each column in the file.
	Header *bool `hcl:"header,optional"`

	// Option to ignore any parsing errors encountered – and instead ignore rows with errors.
	IgnoreErrors *bool `hcl:"ignore_errors,optional"`

	// The maximum line size in bytes.
	MaxLineSize *int `hcl:"max_line_size,optional"`

	// Set the new line character(s) in the file. Options are '\r','\n', or '\r\n'.
	// Note that the CSV parser only distinguishes between single-character and double-character line delimiters.
	// Therefore, it does not differentiate between '\r' and '\n'.
	NewLine *string `hcl:"new_line,optional"`

	// Boolean value that specifies whether or not column names should be normalized,
	// removing any non-alphanumeric characters from them.
	NormalizeNames *bool `hcl:"normalize_names,optional"`

	// If this option is enabled, when a row lacks columns, it will pad the remaining columns on the right with NULL values.
	NullPadding *bool `hcl:"null_padding,optional"`

	// Specifies the string that represents a NULL value or (since v0.10.2) a list of strings that represent a NULL value.
	NullStr *string `hcl:"null_str,optional"`

	// Specifies the quoting string to be used when a data value is quoted.
	Quote *string `hcl:"quote,optional"`

	// The number of sample rows for auto detection of parameters.
	SampleSize *int `hcl:"sample_size,optional"`

	// Specifies the date format to use when parsing timestamps
	TimestampFormat *string `hcl:"timestamp_format,optional"`
}

type Format interface {
	parse.Config

	GetName() string
	SetName(name string)
	GetMapper() (mappers.Mapper[*types.DynamicRow], error)
	GetRegex() (string, error)
	GetDescription() string
	// GetProperties returns the format properties as a string map - used for introspection
	GetProperties() map[string]string
}

type Grok struct {
	Name        string `hcl:",label"`
	Description string `hcl:"description,optional"`
	// the layout of the log line
	// NOTE that as will contain grok patterns, this property is included in constants.GrokConfigProperties
	// meaning and '{' will be auto-escaped in the hcl
	Layout string `hcl:"layout"`

	// grok patterns to add to the grok parser used to parse the layout
	Patterns map[string]string `hcl:"patterns,optional"`
}

type JsonLines struct {
	Name        string `hcl:",label"`
	Description string `hcl:"description,optional"`
	// Option to define number of sample objects for automatic JSON type detection.
	// Set to -1 to scan the entire input file (if not provided, DuckDB defaults to 20480)
	SampleSize *int `hcl:"sample_size,optional"`
	// Specifies the date format to use when parsing timestamps.
	// (If not provided, DuckDB defaults to the ISO 8601 format)
	DateFormat *string `hcl:"date_format,optional"`
}

type Regex struct {
	Name        string `hcl:",label"`
	Description string `hcl:"description,optional"`
	// the layout of the log line
	// NOTE that as will contain grok patterns, this property is included in constants.GrokConfigProperties
	// meaning and '{' will be auto-escaped in the hcl
	Layout string `hcl:"layout"`
}