Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This sink is used whenever you want access to a PartitionedFileSet containing exactly the most recent run’s data in Text format. For example, you might want to create daily snapshots of a database by reading the entire contents of a table, writing to this sink, and then other programs can analyze the contents of the specified file. Or you might want to see the output of the pipeline in Text Format for easy readability.

Configuration

Property

Macro Enabled?

Description

Dataset Name

Yes

Required. Name of the PartitionedFileSet to which records are written. If it doesn’t exist, it will be created.

Snapshot Base Path

Yes

Optional. Base path for the PartitionedFileSet. Defaults to the name of the dataset.

FileSet Properties

Yes

Optional. Advanced feature to specify any additional properties that should be used with the sink, specified as a JSON object of string to string. These properties are set on the dataset if one is created. The properties are also passed to the dataset at runtime as arguments.

Clean Partitions Older Than

Yes

Optional. configures the sink to delete partitions older than a specified date-time after a successful run. If set, when a run successfully finishes, the sink will subtract this amount of time from the runtime and delete any delete any partitions for time partitions older than that. The format is expected to be a number followed by an ‘s’, ‘m’, ‘h’, or ‘d’ specifying the time unit, with ‘s’ for seconds, ‘m’ for minutes, ‘h’ for hours, and ‘d’ for days. For example, if the pipeline is scheduled to run at midnight of January 1, 2016, and this property is set to 7d, the sink will delete any partitions for time partitions older than midnight Dec 25, 2015.

delimiter

Yes

Optional. The Delimiter used to combine the Structured Record fields.

Default is tab.

Example

This example will write to a PartitionedFileSet named snapshotText. It will write data in Text format with specified delimiter. Every time the pipeline runs, the most recent run will be stored in a new partition in the PartitionedFileSet:

Property

Value

Dataset Name

snapshotText

Snapshot Base Path

path/to/store/data

Clean Partitions Older Than

1h

delimiter

,