google_api_spanner v0.2.0 GoogleApi.Spanner.V1.Model.PlanNode View Source

Node information for nodes appearing in a QueryPlan.plan_nodes.

Attributes

  • childLinks ([ChildLink]): List of child node `index`es and their relationship to this parent. Defaults to: null.
  • displayName (String.t): The display name for the node. Defaults to: null.
  • executionStats (%{optional(String.t) => String.t}): The execution statistics associated with the node, contained in a group of key-value pairs. Only present if the plan was returned as a result of a profile query. For example, number of executions, number of rows/time per execution etc. Defaults to: null.
  • index (integer()): The `PlanNode`'s index in node list. Defaults to: null.
  • kind (String.t): Used to determine the type of node. May be needed for visualizing different kinds of nodes differently. For example, If the node is a SCALAR node, it will have a condensed representation which can be used to directly embed a description of the node in its parent. Defaults to: null.

    • Enum - one of [KIND_UNSPECIFIED, RELATIONAL, SCALAR]
  • metadata (%{optional(String.t) => String.t}): Attributes relevant to the node contained in a group of key-value pairs. For example, a Parameter Reference node could have the following information in its metadata: { "parameter_reference": "param1", "parameter_type": "array" } Defaults to: null.
  • shortRepresentation (ShortRepresentation): Condensed representation for SCALAR nodes. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type t() View Source
t() :: %GoogleApi.Spanner.V1.Model.PlanNode{
  childLinks: [GoogleApi.Spanner.V1.Model.ChildLink.t()],
  displayName: any(),
  executionStats: map(),
  index: any(),
  kind: any(),
  metadata: map(),
  shortRepresentation: GoogleApi.Spanner.V1.Model.ShortRepresentation.t()
}

Link to this section Functions

Link to this function decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.