Add-OfficeExcelPowerQueryMetadata

Aliases: ExcelPowerQueryMetadata, ExcelQueryMetadata

Namespace PSWriteOffice

Aliases

ExcelPowerQueryMetadata ExcelQueryMetadata

Inputs

OfficeIMO.Excel.ExcelDocument

Outputs

System.Management.Automation.PSObject

Source

Sources/PSWriteOffice/Cmdlets/Excel/AddOfficeExcelPowerQueryMetadataCommand.cs:21 Edit on GitHub

Adds safe Power Query/connection metadata for Excel-compatible applications to own and refresh.

Remarks

Adds safe Power Query/connection metadata for Excel-compatible applications to own and refresh.

Examples

Authored help example

Add a workbook connection and worksheet query-table metadata.

PS>


Add-OfficeExcelPowerQueryMetadata -Path .\Report.xlsx `
                -Name SalesQuery `
                -WorksheetName Data `
                -CommandText 'let Source = Excel.CurrentWorkbook(){[Name="Sales"]}[Content] in Source' `
                -Description 'Sales query metadata authored by automation' `
                -RefreshOnOpen `
                -PassThru

Writes package metadata only. OfficeIMO does not execute Power Query M; Excel-compatible applications perform refresh when opened.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Add-OfficeExcelPowerQueryMetadata [-CommandText <String>] [-Description <String>] -Name <String> [-PassThru] [-QueryTableName <String>] [-RefreshOnOpen] [-WorksheetName <String>] [<CommonParameters>]

Parameter set: Context

Parameters

CommandText String optionalposition: namedpipeline: False: Power Query M expression stored as metadata.
Description String optionalposition: namedpipeline: False: Connection description.
Name String requiredposition: namedpipeline: False: Connection name stored in workbook metadata.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit metadata about the authored package parts.
QueryTableName String optionalposition: namedpipeline: False: Optional query-table name.
RefreshOnOpen SwitchParameter optionalposition: namedpipeline: False: Request refresh-on-open metadata.
WorksheetName String optionalposition: namedpipeline: Falsealiases: Sheet, SheetName, Worksheet: Worksheet that should own query-table metadata. Defaults to the current DSL sheet when used inside New-OfficeExcel.

Outputs

System.Management.Automation.PSObject

Add-OfficeExcelPowerQueryMetadata [-CommandText <String>] [-Description <String>] -InputPath <String> -Name <String> [-PassThru] [-QueryTableName <String>] [-RefreshOnOpen] [-WorksheetName <String>] [<CommonParameters>]

Parameter set: Path

Parameters

CommandText String optionalposition: namedpipeline: False: Power Query M expression stored as metadata.
Description String optionalposition: namedpipeline: False: Connection description.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Workbook path to update.
Name String requiredposition: namedpipeline: False: Connection name stored in workbook metadata.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit metadata about the authored package parts.
QueryTableName String optionalposition: namedpipeline: False: Optional query-table name.
RefreshOnOpen SwitchParameter optionalposition: namedpipeline: False: Request refresh-on-open metadata.
WorksheetName String optionalposition: namedpipeline: Falsealiases: Sheet, SheetName, Worksheet: Worksheet that should own query-table metadata. Defaults to the current DSL sheet when used inside New-OfficeExcel.

Outputs

System.Management.Automation.PSObject

Add-OfficeExcelPowerQueryMetadata [-CommandText <String>] [-Description <String>] -Document <ExcelDocument> -Name <String> [-PassThru] [-QueryTableName <String>] [-RefreshOnOpen] [-WorksheetName <String>] [<CommonParameters>]

Parameter set: Document

Parameters

CommandText String optionalposition: namedpipeline: False: Power Query M expression stored as metadata.
Description String optionalposition: namedpipeline: False: Connection description.
Document ExcelDocument requiredposition: namedpipeline: True (ByValue): Workbook document to update.
Name String requiredposition: namedpipeline: False: Connection name stored in workbook metadata.
PassThru SwitchParameter optionalposition: namedpipeline: False: Emit metadata about the authored package parts.
QueryTableName String optionalposition: namedpipeline: False: Optional query-table name.
RefreshOnOpen SwitchParameter optionalposition: namedpipeline: False: Request refresh-on-open metadata.
WorksheetName String optionalposition: namedpipeline: Falsealiases: Sheet, SheetName, Worksheet: Worksheet that should own query-table metadata. Defaults to the current DSL sheet when used inside New-OfficeExcel.

Outputs

System.Management.Automation.PSObject