Class MemoryPhysicalQueryPlanLogger

A physical query plan logger that stores everything in memory.

Implements

IPhysicalQueryPlanLogger

Index

Constructors

Methods

appendMetadata logOperation nodeToCompactString stashChildren toCompactString toJson unstashChild

Constructors

constructor

new MemoryPhysicalQueryPlanLogger(): MemoryPhysicalQueryPlanLogger
Returns MemoryPhysicalQueryPlanLogger
- Defined in actor-query-process-explain-physical/lib/MemoryPhysicalQueryPlanLogger.ts:13

Methods

appendMetadata

appendMetadata(node: any, metadata: any): void
Append the given metadata to the given node.
Parameters
- node: any
  The node to add metadata to.
- metadata: any
  The metadata to add.
Returns void
Implementation of IPhysicalQueryPlanLogger.appendMetadata
- Defined in actor-query-process-explain-physical/lib/MemoryPhysicalQueryPlanLogger.ts:74

logOperation

logOperation(
    logicalOperator: string,
    physicalOperator: undefined | string,
    node: any,
    parentNode: any,
    actor: string,
    metadata: any,
): void
Log an operation.

Important here is that the node and parentNode can be of any type, as long as they properly reference each other in subsequent calls. These node references can be used to build up a hierarchy.
Parameters
- logicalOperator: string
  The current logical query operator.
- physicalOperator: undefined | string
  The current physical query operator. This may be omitted if no physical operator applies.
- node: any
  The current operation node.
- parentNode: any
  The parent operation node.
- actor: string
  The current actor name.
- metadata: any
  Metadata to include together in the physical query plan output for this node.
Returns void
Implementation of IPhysicalQueryPlanLogger.logOperation
- Defined in actor-query-process-explain-physical/lib/MemoryPhysicalQueryPlanLogger.ts:17

nodeToCompactString

nodeToCompactString(
    lines: string[],
    sources: Map<string, number>,
    indent: string,
    node: IPlanNodeJson,
    metadata?: string,
): void
Parameters
- lines: string[]
- sources: Map<string, number>
- indent: string
- node: IPlanNodeJson
- Optionalmetadata: string
Returns void
- Defined in actor-query-process-explain-physical/lib/MemoryPhysicalQueryPlanLogger.ts:208

stashChildren

stashChildren(node: any, filter?: (planNodeFilter: IPlanNode) => boolean): void
Remove all matching children from the given node,
Parameters
- node: any
  The node to remove children from.
- Optionalfilter: (planNodeFilter: IPlanNode) => boolean
  The filter to keep children by. If undefined, all children will be removed.
Returns void
Implementation of IPhysicalQueryPlanLogger.stashChildren
- Defined in actor-query-process-explain-physical/lib/MemoryPhysicalQueryPlanLogger.ts:52

toCompactString

toCompactString(): string
Returns string
- Defined in actor-query-process-explain-physical/lib/MemoryPhysicalQueryPlanLogger.ts:186

toJson

toJson(): IPlanNodeJson | Record<string, never>
Serialize the collected query plan to JSON.

Returns IPlanNodeJson | Record<string, never>
Implementation of IPhysicalQueryPlanLogger.toJson
- Defined in actor-query-process-explain-physical/lib/MemoryPhysicalQueryPlanLogger.ts:87

unstashChild

unstashChild(node: any, parentNode: any): void
Add the given child to the given parent node.
Parameters
- node: any
  A node to add to the parent.
- parentNode: any
  The parent to add to.
Returns void
Implementation of IPhysicalQueryPlanLogger.unstashChild
- Defined in actor-query-process-explain-physical/lib/MemoryPhysicalQueryPlanLogger.ts:60