Packages > pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf

com.influxdata.telegraf.plugins.parsers.CsvInputDataFormat1.4.0

Properties
Methods

open module com.influxdata.telegraf.plugins.parsers.CsvInputDataFormat extends com.influxdata.telegraf.plugins.parsers.InputDataFormat

The csv parser creates metrics from a document containing comma separated values.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/com.influxdata.telegraf@1.4.0#/plugins/parsers/CsvInputDataFormat.pkl
Pkl version:: 0.25.0 or higher
Source code:: CsvInputDataFormat.pkl
Known subtypes:
Known usages:
All versions:: 1.4.0, 1.3.0, 1.2.1, 1.2.0, 1.1.1, 1.1.0, 1.0.1, 1.0.0

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

data_format: "csv"Source
link

files: Listing<String>Source
link

csv_header_row_count: Int(isPositive)?Source

Indicates how many rows to treat as a header.

By default, the parser assumes there is no header and will parse the first row as data. If set to anything more than 1, column names will be concatenated with the name listed in the next header row. If csv_column_names is specified, the column names in header will be overridden.
link

csv_column_names: Listing<String>?Source

For assigning custom names to columns.

If this is specified, all columns should have a name. Unnamed columns will be ignored by the parser. If csv_header_row_count is set to 0, this config must be used.
link

csv_column_types: Listing<("int"|"float"|"bool"|"string")>?Source

For assigning explicit data types to columns.

Specify types in order by column (e.g., csv_column_types { "string"; "int"; "float" }). If this is not specified, type conversion will be done on the types above.
link

csv_skip_rows: Int(isPositive)?Source

Indicates the number of rows to skip before looking for header information.
link

csv_skip_columns: Int(isPositive)?Source

Indicates the number of columns to skip before looking for data to parse.

These columns will be skipped in the header as well.
link

csv_delimiter: String?Source

The separator between csv fields.

Default: ","
link

csv_comment: String?Source

The character reserved for marking a row as a comment row.

Commented rows are skipped and not parsed.
link

csv_trim_space: Boolean?Source

If set to true, the parser will remove leading whitespace from fields.

Default: false
link

csv_tag_columns: Listing<String>?Source

Columns listed here will be added as tags.

Any other columns will be added as fields.
link

csv_measurement_column: String?Source

The column to extract the name of the metric from.

Will not be included as field in metric.
link

csv_timestamp_column: String?Source

The column to extract time information for the metric.

csv_timestamp_format must be specified if this is used. Will not be included as field in metric.
link

csv_timestamp_format: String?Source

The format of time data extracted from csv_timestamp_column.

This must be specified if csv_timestamp_column is specified.
link

csv_timezone: String?Source

The timezone of time data extracted from csv_timestamp_column in case there is no timezone information.

It follows the IANA Time Zone database.
link

csv_skip_values: Listing<String>?Source

Indicates values to skip, such as an empty string value "".

The field will be skipped entirely where it matches any values inserted here.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```