Types: Power Query

Definitions of the names from the “TypeScript type” column on the operation pages.

Other dictionary topics: session, workbook, and sheets · cells and ranges · formulas and calculation · formatting · data and sheet objects · pivot tables · charts and graphics · printing and page layout · Power Query · VBA and macros · protection and review · general and utility.

Types on this page — 86

• AppliedStep
• AppliedStepsProjection
• ApprovedMacroDescriptor
• ApprovedMacroExecutionMode
• ApprovedMacroScope
• ApprovedODataFeedDescriptor
• ApprovedSourceDescriptor
• ApprovedWebConnectorDescriptor
• ApprovedWebConnectorHeader
• ApprovedWebSourceDescriptor
• ContractForeignMashupGroup
• ContractForeignMashupLoadDestination
• ContractForeignMashupProjection
• ContractForeignMashupQueryEntry
• ContractForeignMashupRefreshResult
• ContractForeignMashupRefusal
• ContractMashupWriteEdit
• ContractMashupWriteResult
• ContractPowerQueryCell
• ContractPowerQueryCellKind
• ContractPowerQueryTransformOutcome
• ContractPrivacyInspectorIntent
• ContractPrivacyInspectorResult
• ContractQueryDependencyEdge
• ContractRecomputedQueryStatus
• FoldingNativeQuery
• ODataFeedCredential
• ODataQueryOptions
• PowerQueryInspectorSnapshot
• PowerQueryLoadDestination
• PowerQueryLoadMode
• PowerQueryLoadPlan
• PqDataSourceEntry
• PqDataSourceSettingsOutcome
• PqPostgresConnectorBounds
• PqPostgresDeniedWire
• PqPostgresDialogDescriptor
• PqPostgresInspectHint
• PqPostgresLanGrantWire
• PqPostgresNavTableWire
• PqPostgresNavigationItemWire
• PqPostgresNavigationSchemaWire
• PqPostgresPreviewTableRef
• PqPrivacyEvaluationInput
• PqPrivacyGraphNode
• PqPrivacyLevelAssignment
• PqPrivacyLevelListEntry
• PqPrivacyLevelWriteOutcome
• PqProductRibbonColumnPayload
• PqProductRibbonDenied
• PqProductRibbonQueryPayload
• PqQueryGraphDiagnostic
• PqQueryGraphEdge
• PqQueryGraphExplain
• PqQueryGraphNode
• PqQueryGraphNodePublication
• PqQueryGraphPartitionSummary
• PqQueryGraphRefreshOutcome
• PqQueryGraphSnapshot
• PqScaleBackpressureState
• PqScaleBudget
• PqScaleDenied
• PqScaleDeniedReason
• PqScaleProgressCancelPayload
• PqScaleProgressOpenPayload
• PqScaleProgressPullPayload
• PqScaleProgressSnapshotPayload
• PqScaleProgressStatus
• PqSourceScopeWire
• PqSqlServerDeniedWire
• PqSqlServerDescriptor
• PqSqlServerNavigationItemWire
• PqSqlServerTableRef
• PrivacyCapabilityState
• PrivacyCategory
• PrivacyCategorySummary
• PrivacyFinding
• PrivacyInventoryReport
• PrivacyMutationReport
• PrivacyRiskLevel
• ProductTableRangeRefreshQueryOutcome
• TableRangeQueryMutationPreview
• TableRangeQueryPreview
• WebConnectorCacheRetryPolicy
• WebConnectorCredentialMode
• WebConnectorCredentialScope

AppliedStep

interface AppliedStep {

  stepId: string;

  displayName: string;

  canonicalM: string;

  span: MWireSpan;

  inputs: string[];

  kind: "source" | "transform" | "output";

  astNodeId?: string;
}

AppliedStepsProjection

interface AppliedStepsProjection {

  queryStableId: string;

  steps: AppliedStep[];

  canonicalM: string;

  diagnostics: InspectorDiagnostic[];

  foldExplainPlan?: FoldExplainPlan;
}

ApprovedMacroDescriptor

interface ApprovedMacroDescriptor {
  macroId: string;
  displayName: string;
  entrypoint: string;
  scope: ApprovedMacroScope;
  sourceLabel: string;
  sourceText: string;
  mode: ApprovedMacroExecutionMode;
  summary: string;
  effectRangeA1: string;
  limitations: string[];
}

ApprovedMacroExecutionMode

type ApprovedMacroExecutionMode = "approved-demo";

ApprovedMacroScope

type ApprovedMacroScope = "workbook-local";

ApprovedODataFeedDescriptor

interface ApprovedODataFeedDescriptor {

  serviceUrl: string;

  approvedHeaders?: [string, string][];

  timeoutMs: number;

  maxResponseBytes: number;

  maxPageCount: number;

  maxTotalRows: number;

  queryOptions?: ODataQueryOptions;

  credential: ODataFeedCredential;

  testAllowlist?: WebSourceTestAllowlist;
}

ApprovedSourceDescriptor

type ApprovedSourceDescriptor =
  | ({ kind: "workbook" } & WorkbookSourceDescriptor)
  | ({ kind: "file" } & FileSourceDescriptor)
  | ({ kind: "folder" } & FolderSourceDescriptor);

ApprovedWebConnectorDescriptor

interface ApprovedWebConnectorDescriptor {

  source: ApprovedWebSourceDescriptor;

  relativePath?: string;

  query?: ApprovedWebConnectorHeader[];

  headers?: ApprovedWebConnectorHeader[];

  cacheRetry?: WebConnectorCacheRetryPolicy;

  credentialMode?: WebConnectorCredentialMode;

  credentialScope?: WebConnectorCredentialScope;
}

ApprovedWebConnectorHeader

interface ApprovedWebConnectorHeader {
  name: string;
  value: string;
}

ApprovedWebSourceDescriptor

interface ApprovedWebSourceDescriptor {

  url: string;

  workbookId: string;

  queryId?: string;

  timeoutMs?: number;

  revoked?: boolean;

  testAllowlist?: WebSourceTestAllowlist;
}

ContractForeignMashupGroup

interface ContractForeignMashupGroup {
  id: string;
  name?: string;
}

ContractForeignMashupLoadDestination

type ContractForeignMashupLoadDestination =
  | { mode: "existing_sheet"; sheetName: string; anchor: string }
  | { mode: "new_sheet"; sheetName: string }
  | { mode: "connection_only" };

ContractForeignMashupProjection

interface ContractForeignMashupProjection {
  readOnly: boolean;
  revision: number;
  refused?: ContractForeignMashupRefusal;
  queries: ContractForeignMashupQueryEntry[];
  groups: ContractForeignMashupGroup[];
  connections: ContractWorkbookConnectionEntry[];
  loadLinks: ContractWorkbookConnectionLoadLink[];
  sourceScopes?: PqSourceScopeWire[];
  unknownElements: string[];
  sectionName?: string;
  sectionDeclarationCount: number;
  sectionHasErrors: boolean;
  hasConfig: boolean;
}

ContractForeignMashupQueryEntry

interface ContractForeignMashupQueryEntry {
  identity: string;
  name: string;
  dependencyIdentities?: string[];
  stableGuid?: string;
  itemPath?: string;
  queryGroupId?: string;
  isPrivate?: boolean;
  loadEnabled?: boolean;
  loadObjectType?: string;
  loadToDataModel?: boolean;
  resultType?: string;
  expressionParseOk?: boolean;
  expressionPreview?: string;
  expressionSha256?: string;
  previewSanitized: boolean;
  hasSectionDeclaration: boolean;
}

ContractForeignMashupRefreshResult

interface ContractForeignMashupRefreshResult {
  status: string;
  revision: number;
  generation: number;
  queryIdentity: string;
  valueKind?: string;
  rowCount?: number;
  columnCount?: number;
  packageHash?: string;
  code?: string;
  detail?: string;
}

ContractForeignMashupRefusal

interface ContractForeignMashupRefusal {
  code: string;
  detail: string;
}

ContractMashupWriteEdit

type ContractMashupWriteEdit =
  | { kind: "replace_expression"; query: string; newExpression: string }
  | { kind: "rename_query"; query: string; newName: string }
  | { kind: "delete_query"; query: string }
  | { kind: "duplicate_query"; query: string; newName: string }
  | { kind: "reference_query"; query: string; newName: string }
  | { kind: "load_to"; query: string; destination: ContractForeignMashupLoadDestination; }
  | { kind: "create_connection";
    sourceSubsetId: string;
    name: string;
    destination: ContractWorkbookConnectionDestination;
    refreshOnOpen?: boolean;
  }
  | { kind: "edit_connection";
    connection: string;
    sourceSubsetId?: string;
    name?: string;
    destination?: ContractWorkbookConnectionDestination;
    refreshOnOpen?: boolean;
  }
  | { kind: "rename_connection"; connection: string; newName: string }
  | { kind: "delete_connection"; connection: string }
  | { kind: "duplicate_connection"; connection: string; newName: string }
  | { kind: "reference_connection"; connection: string; newName: string };

ContractMashupWriteResult

interface ContractMashupWriteResult {
  status: string;
  revision: number;
  envelopeHash?: string;
  code?: string;
  detail?: string;
}

ContractPowerQueryCell

interface ContractPowerQueryCell {
  kind: ContractPowerQueryCellKind;
  text?: string;
  number?: number;
  integer?: number;
  logical?: boolean;
  date?: string;
  errorSourceText?: string;
  errorTargetType?: string;
}

ContractPowerQueryCellKind

type ContractPowerQueryCellKind = "null" | "text" | "number" | "integer" | "logical" | "date" | "error";

ContractPowerQueryTransformOutcome

type ContractPowerQueryTransformOutcome =
  | { status: "evaluated";
    sourceId: string;
    mSource: string;
    supportedSubset: string;
    columns: string[];
    rows: ContractPowerQueryCell[][];
    cellErrorCount: number;
  }
  | { status: "blocked"; sourceId: string; mSource: string; reason: string; detail: string; };

ContractPrivacyInspectorIntent

type ContractPrivacyInspectorIntent =
  | { action: "scan" }
  | { action: "remove_to_copy";
    destinationUri: string;
    selectedCategories: PrivacyCategory[];
    expectedSourceSha256: string;
  };

ContractPrivacyInspectorResult

type ContractPrivacyInspectorResult =
  | { status: "scanned"; inspection: PrivacyInventoryReport }
  | { status: "removed_to_copy"; sanitization: PrivacyMutationReport };

ContractQueryDependencyEdge

interface ContractQueryDependencyEdge {
  dependentStableId: string;
  upstreamStableId: string;
}

ContractRecomputedQueryStatus

interface ContractRecomputedQueryStatus {
  queryStableId: string;
  recomputed: boolean;
}

FoldingNativeQuery

interface FoldingNativeQuery {
  transport: "odata" | "sql" | string;
  text: string;
}

ODataFeedCredential

interface ODataFeedCredential {

  mode?: WebConnectorCredentialMode;

  scope: WebConnectorCredentialScope;
}

ODataQueryOptions

interface ODataQueryOptions {

  select?: string[];

  filter?: string;

  top?: number;
}

PowerQueryInspectorSnapshot

interface PowerQueryInspectorSnapshot {

  source: string;
  ast?: InspectorAstNode;

  bindings: InspectorBinding[];
  outcome: InspectorOutcome;

  diagnostics: InspectorDiagnostic[];
  lineage: InspectorLineage;

  foldExplainPlan?: FoldExplainPlan;

  foldingVerdict: FoldingVerdict;

}

PowerQueryLoadDestination

interface PowerQueryLoadDestination {
  mode: PowerQueryLoadMode;
  sheetName?: string;

  sheet_name?: string;

  anchor?: CellAnchor;
}

PowerQueryLoadMode

type PowerQueryLoadMode = "new-sheet" | "current-anchor" | "existing-range" | "connection-only";

PowerQueryLoadPlan

interface PowerQueryLoadPlan {
  requests: ComputeRequest[];
  outputRect: CellRect;
  sheetKey: string;
  staleClearCount: number;
  createdSheet: boolean;
}

PqDataSourceEntry

interface PqDataSourceEntry {

  scopeId: string;
  scopeKind: "workbook" | "file" | "folder" | "web" | "odata" | "database";

  queryCount: number;

  pathChangeable: boolean;
}

PqDataSourceSettingsOutcome

interface PqDataSourceSettingsOutcome {
  action: string;

  requestedScopeId: string;

  scopeId?: string;
  accepted: boolean;
  reason?: string;

  workbookChanged: boolean;
}

PqPostgresConnectorBounds

interface PqPostgresConnectorBounds {
  maxPreviewRows?: number;
  maxTotalRows?: number;
  statementTimeoutMs?: number;
}

PqPostgresDeniedWire

interface PqPostgresDeniedWire {
  reason: string;
  message: string;
}

PqPostgresDialogDescriptor

interface PqPostgresDialogDescriptor {
  providerId?: "postgres";
  host: string;
  port: number;
  database: string;

  credentialMode?: "stored" | "anonymous";
  credentialScope?: WebConnectorCredentialScope;

  options?: Record<string, string>;
  bounds?: PqPostgresConnectorBounds;
  revoked?: boolean;
}

PqPostgresInspectHint

interface PqPostgresInspectHint {

  canonicalM: string;

  descriptorJson: string;

  schema?: string;

  item?: string;
}

PqPostgresLanGrantWire

interface PqPostgresLanGrantWire {
  scopeOrigin: string;
  allowPrivateNetwork: boolean;
}

PqPostgresNavTableWire

interface PqPostgresNavTableWire {
  schema: string;
  name: string;
  kind: string;
}

PqPostgresNavigationItemWire

interface PqPostgresNavigationItemWire {
  name: string;

  kind: string;
}

PqPostgresNavigationSchemaWire

interface PqPostgresNavigationSchemaWire {
  name: string;
  items: PqPostgresNavigationItemWire[];
}

PqPostgresPreviewTableRef

interface PqPostgresPreviewTableRef {
  schema: string;
  table: string;
}

PqPrivacyEvaluationInput

interface PqPrivacyEvaluationInput {
  rootQueryId: string;
  graph?: PqPrivacyGraphNode[];
  levels?: PqPrivacyLevelAssignment[];
}

PqPrivacyGraphNode

interface PqPrivacyGraphNode {
  queryId: string;
  references?: string[];
  parameters?: string[];
  dynamicSource?: boolean;
  directScopes?: PqSourceScopeWire[];
}

PqPrivacyLevelAssignment

interface PqPrivacyLevelAssignment {
  canonicalScope: string;
  level: string;
  invalid?: boolean;
}

PqPrivacyLevelListEntry

interface PqPrivacyLevelListEntry {
  scopeId: string;
  scopeKind: "workbook" | "file" | "folder" | "web" | "odata" | "unknown";
  displayResource: string;
  level: string;
  origin: "user-store" | "workbook-declared" | "effective";
  reason?: string;
}

PqPrivacyLevelWriteOutcome

interface PqPrivacyLevelWriteOutcome {
  canonicalScope: string;
  level?: string;
  scopeId?: string;
  accepted: boolean;
  reason?: string;
}

PqProductRibbonColumnPayload

interface PqProductRibbonColumnPayload {
  name: string;
  inferredType: string;
}

PqProductRibbonDenied

interface PqProductRibbonDenied {
  reason: string;
  message: string;
}

PqProductRibbonQueryPayload

interface PqProductRibbonQueryPayload {
  queryId: string;
  sheetName: string;
  selectorKind: "table" | "range";
  selectorName: string;
  columns: PqProductRibbonColumnPayload[];
  totalRows: number;
  sampledRows: number;
  truncated: boolean;
  stepCount: number;
  canonicalM: string;
  editorAvailable: boolean;
  loaded: boolean;

  loadedQueryStableId?: string;
}

PqQueryGraphDiagnostic

interface PqQueryGraphDiagnostic {
  code: string;
  nodes: string[];
  message: string;
}

PqQueryGraphEdge

interface PqQueryGraphEdge {
  from: string;
  to: string;
  kind: "query-ref" | "parameter-ref" | "source-read" | string;
}

PqQueryGraphExplain

interface PqQueryGraphExplain {
  query_stable_id: string;
  display_name: string;
  dependencies: string[];

  plan_availability: string;
  fold_explain_plan?: FoldExplainPlan;

  folding_verdict: FoldingVerdict;
  partition_summary?: PqQueryGraphPartitionSummary;
  diagnostics: PqQueryGraphDiagnostic[];

  postgres_inspect_hint?: PqPostgresInspectHint;
}

PqQueryGraphNode

interface PqQueryGraphNode {
  id: string;
  kind: "query" | "parameter" | "source" | string;
  display_name: string;

  status: string;
  generation: number;

  diagnostic_code?: string;
}

PqQueryGraphNodePublication

interface PqQueryGraphNodePublication {
  query_stable_id: string;
  load_plan?: PowerQueryLoadPlan;
  refresh_outcome: unknown;
  persisted_query?: unknown;
}

PqQueryGraphPartitionSummary

interface PqQueryGraphPartitionSummary {
  transitive_query_ids: string[];
  transitive_scope_ids: string[];
}

PqQueryGraphRefreshOutcome

interface PqQueryGraphRefreshOutcome {
  generation: number;
  workbook_revision?: number;

  states: Record<string, string>;
  diagnostics: PqQueryGraphDiagnostic[];

  node_reasons?: Record<string, string>;
}

PqQueryGraphSnapshot

interface PqQueryGraphSnapshot {
  schema_version: number;
  workbook_revision?: number;
  nodes: PqQueryGraphNode[];
  edges: PqQueryGraphEdge[];
  diagnostics: PqQueryGraphDiagnostic[];
}

PqScaleBackpressureState

type PqScaleBackpressureState = { state: "ready" } | { state: "throttled"; retryAfterMs: number };

PqScaleBudget

interface PqScaleBudget {
  maxRows: number;
  maxResultBytes: number;
  maxRowBytes: number;
  maxSpillBytes: number;
  maxBatchRows: number;
  timeBudgetMs: number;
}

PqScaleDenied

interface PqScaleDenied {
  reason: PqScaleDeniedReason;
  message: string;
}

PqScaleDeniedReason

type PqScaleDeniedReason =
  | "row-budget-exceeded"
  | "byte-budget-exceeded"
  | "oversized-row"
  | "time-budget-exceeded"
  | "spill-cap-exceeded"
  | "cancelled"
  | "superseded"
  | "firewall-blocked"
  | "unsupported";

PqScaleProgressCancelPayload

interface PqScaleProgressCancelPayload {
  cancelled: boolean;
}

PqScaleProgressOpenPayload

interface PqScaleProgressOpenPayload {
  sessionId: string;
  rowsTotal: number;
  budget: PqScaleBudget;
}

PqScaleProgressPullPayload

interface PqScaleProgressPullPayload {
  status: PqScaleProgressStatus;
  rowsInBatch: number;
  rowsEmitted: number;
  rowsTotal: number;
  bytesEmitted: number;
  backpressure: PqScaleBackpressureState;
  elapsedMs: number;
  batchesPulled: number;
  denied?: PqScaleDenied;
}

PqScaleProgressSnapshotPayload

interface PqScaleProgressSnapshotPayload {
  status: PqScaleProgressStatus;
  rowsEmitted: number;
  rowsTotal: number;
  bytesEmitted: number;
  backpressure: PqScaleBackpressureState;
  elapsedMs: number;
  batchesPulled: number;
  denied?: PqScaleDenied;
}

PqScaleProgressStatus

type PqScaleProgressStatus = "batch" | "done" | "denied";

PqSourceScopeWire

type PqSourceScopeWire =
  | { kind: "workbook"; workbookStableId: string }
  | { kind: "file"; path: string }
  | { kind: "folder"; root: string }
  | { kind: "web"; origin: string }
  | { kind: "odata"; serviceOrigin: string }
  | { kind: "database"; resource: string };

PqSqlServerDeniedWire

interface PqSqlServerDeniedWire {
  reason: string;
  message: string;
}

PqSqlServerDescriptor

interface PqSqlServerDescriptor {
  host: string;
  port?: number;
  database: string;
  user: string;
  credentialScope: string;
  timeoutMs?: number;
  revoked?: boolean;
}

PqSqlServerNavigationItemWire

interface PqSqlServerNavigationItemWire {
  schema: string;
  name: string;
  kind: string;
}

PqSqlServerTableRef

interface PqSqlServerTableRef {
  schema: string;
  table: string;
}

PrivacyCapabilityState

type PrivacyCapabilityState = "remove_live" | "detect_only" | "blocked";

PrivacyCategory

type PrivacyCategory =
  | "core_properties"
  | "app_properties"
  | "custom_properties"
  | "custom_xml"
  | "thumbnail"
  | "document_server_metadata"
  | "comments_notes"
  | "hidden_sheets"
  | "hidden_rows_columns"
  | "external_links"
  | "custom_views"
  | "drawings";

PrivacyCategorySummary

interface PrivacyCategorySummary {
  category: PrivacyCategory;
  findingCount: number;
  capabilityState: PrivacyCapabilityState;
  reasonCodes: string[];
}

PrivacyFinding

interface PrivacyFinding {
  category: PrivacyCategory;
  reasonCode: string;
  count: number;
  riskLevel: PrivacyRiskLevel;
}

PrivacyInventoryReport

interface PrivacyInventoryReport {
  schemaVersion: number;
  sourceSha256: string;
  signedPackage: boolean;
  totalFindingCount: number;
  findings: PrivacyFinding[];
  categories: PrivacyCategorySummary[];
  packageReasonCodes: string[];
}

PrivacyMutationReport

interface PrivacyMutationReport {
  schemaVersion: number;
  sourceSha256: string;
  outputSha256: string;
  removedCategories: PrivacyCategory[];
  removedPartCount: number;
  modifiedPartCount: number;
  after: PrivacyInventoryReport;
}

PrivacyRiskLevel

type PrivacyRiskLevel = "high" | "medium" | "low" | "none";

ProductTableRangeRefreshQueryOutcome

interface ProductTableRangeRefreshQueryOutcome {
  queryStableId: string;
  status: "refreshed" | "blocked" | "skipped";
  loadPlan?: PowerQueryLoadPlan;

  persistedQuery?: unknown;
  reason?: string;
  detail?: string;
}

TableRangeQueryMutationPreview

interface TableRangeQueryMutationPreview {
  mutation: StepMutationResult;
  preview: TableRangeQueryPreview;
}

TableRangeQueryPreview

interface TableRangeQueryPreview {

  outcome: MExpressionOutcome;

  totalRows?: number;

  sampledRows?: number;

  truncated: boolean;
}

WebConnectorCacheRetryPolicy

interface WebConnectorCacheRetryPolicy {

  cacheEnabled?: boolean;

  maxRetries?: number;
}

WebConnectorCredentialMode

type WebConnectorCredentialMode = "anonymous" | "webApi";

WebConnectorCredentialScope

interface WebConnectorCredentialScope {

  origin: string;

  queryId?: string;
}