Csv.Document is a function in the Power Query M language that returns the contents of a CSV document as a table. The function returns a table with the specified number of columns, column names, or options, and handles various delimiters, extraValues, and encodings.
Compatible with: Power BI Service Power BI Desktop Excel Microsoft 365
Syntax
Csv.Document(
source as any,
optional columns as any,
optional delimiter as any,
optional extraValues as nullable number,
optional encoding as nullable number,
) as table| Argument | Attribute | Description |
|---|---|---|
| Source | contents of a CSV document | |
| Columns | Optional | can be null, the number of columns, a list of column names, a table type, or an options record. When specifying a record (and omitting other optional arguments) you can provide the following fields: Delimiter, Columns, Encoding, CsvStyle and Quotestyle. |
| Delimiter | Optional | can be a single character, a list of characters, or the value "", which indicates rows should be split by consecutive whitespace characters. Default: ",". |
| ExtraValues | Optional | Refers to the ExtraValues.Type to specify the expected action for extra values in a row that has less columns than expected. You can choose from ExtraValues.Error, ExtraValues.Ignore or ExtraValues.List. |
| Encoding | Optional | Specifies the TextEncoding.Type. Default: 65001 (UTF-8). You can choose from: TextEncoding.Unicode, TextEncoding.Utf16, TextEncoding.BigEndianUnicode, TextEncoding.Windows, TextEncoding.Ascii and TextEncoding.Utf8. |
Description
Returns the contents of the CSV document as a table. If a record is specified for columns (and delimiter, extraValues, and encoding are null), the following record fields may be provided:
Delimiter: The column delimiter. Default:",".Columns: Can be null, the number of columns, a list of column names, or a table type. If the number of columns is lower than the number found in the input, the additional columns will be ignored. If the number of columns is higher than the number found in the input, the additional columns will be null. When not specified, the number of columns will be determined by what is found in the input.Encoding: The text encoding of the file. Default: 65001 (UTF-8).CsvStyle: Specifies how quotes are handled.- CsvStyle.QuoteAfterDelimiter (default): Quotes in a field are only significant immediately following the delimiter.
- CsvStyle.QuoteAlways: Quotes in a field are always significant, regardless of where they appear.
QuoteStyle: Specifies how quoted line breaks are handled.- QuoteStyle.Csv (default): Quoted line breaks are treated as part of the data, not as the end of the current row.
- QuoteStyle.None: All line breaks are treated as the end of the current row, even when they occur inside a quoted value.
Examples
Process CSV text with column headers
let
csv = Text.Combine( {"OrderID,Item", "1,Fishing rod", "2,1 lb. worms"}, "#( cr )#( lf )" )
in
Table.PromoteHeaders( Csv.Document( csv ) )
/* Output:
Table.FromRecords( {
[OrderID = "1", Item = "Fishing rod"],
[OrderID = "2", Item = "1 lb. worms"]
} )
*/
Related articles
Learn more about Csv.Document in the following articles:
- An In-Depth Look At The Csv.Document M Function
The article presents a comprehensive examination of the Csv.Document M function. Topics covered include parameters such as Source, Delimiter, Encoding, Columns, QuoteStyle, CsvStyle, and more. » Read more
Related functions
Other functions related to Csv.Document are:
