FileFormatBuilder Class

Definition

Namespace:: Microsoft.DataPrep.Common

Assembly:: Microsoft.DataPrep.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Interactive object that can learn the file format and properties required to read a given file.

Note: This Builder is generally used on a Dataflow which has had a 'get_files' step applied to it.After the path(s) to files have been resolved, the appropriate method of interpreting those files can be learned and modified using this Builder.

public ref class FileFormatBuilder

public class FileFormatBuilder

type FileFormatBuilder = class

Public Class FileFormatBuilder

Inheritance: Object
FileFormatBuilder

Constructors

FileFormatBuilder(DataFlow, IDPrepEngine)

Class constructor for file format builder.

Properties

FileFormat

indicate the detcted file format.

Methods

LearnAsync()

Learn the file_format of the files from the initial Dataflow.

Note: After calling this function the 'file_format' attribute on this Builder will be populated with information about the file(s) in the initial Dataflow.This attribute includes file type as well as some parameters to be used when parsing the file(s).

ToDataFlowAsync(Boolean)

Uses learned information about the files in the initial Dataflow to construct a new Dataflow which has the correct reading/parsing steps to extract their data.

Applies to