PlanNode

google.spanner.v1. PlanNode

Represents a PlanNode.

Constructor

new PlanNode(propertiesopt)

Constructs a new PlanNode.

Parameters:
Name Type Attributes Description
properties google.spanner.v1.IPlanNode <optional>

Properties to set

Implements:
  • IPlanNode

Classes

ChildLink
ShortRepresentation

Members

(static) Kind :number

Kind enum.

Properties:
Name Type Description
KIND_UNSPECIFIED number

KIND_UNSPECIFIED value

RELATIONAL number

RELATIONAL value

SCALAR number

SCALAR value

PlanNode childLinks.

displayName :string

PlanNode displayName.

executionStats :google.protobuf.IStruct|null|undefined

PlanNode executionStats.

index :number

PlanNode index.

kind :google.spanner.v1.PlanNode.Kind

PlanNode kind.

metadata :google.protobuf.IStruct|null|undefined

PlanNode metadata.

shortRepresentation :google.spanner.v1.PlanNode.IShortRepresentation|null|undefined

PlanNode shortRepresentation.

Methods

(static) create(propertiesopt) → {google.spanner.v1.PlanNode}

Creates a new PlanNode instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.spanner.v1.IPlanNode <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.spanner.v1.PlanNode}

Decodes a PlanNode message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.spanner.v1.PlanNode}

Decodes a PlanNode message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified PlanNode message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.spanner.v1.IPlanNode

PlanNode message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified PlanNode message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.spanner.v1.IPlanNode

PlanNode message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.spanner.v1.PlanNode}

Creates a PlanNode message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a PlanNode message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.spanner.v1.PlanNode

PlanNode

options $protobuf.IConversionOptions <optional>

Conversion options

(static) verify(message) → {string|null}

Verifies a PlanNode message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this PlanNode to JSON.