1. class
  2. Google
  3. \
  4. Spanner
  5. \
  6. V1
  7. \
  8. PlanNode_ChildLink

PlanNode_ChildLink

class PlanNode_ChildLink extends Message

Metadata associated with a parent-child relationship appearing in a [PlanNode][google.spanner.v1.PlanNode].

Protobuf type Google\Spanner\V1\PlanNode\ChildLink

Methods

__construct()

No description

int
getChildIndex()

The node to which the link points.

setChildIndex(int $var)

The node to which the link points.

string
getType()

The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.

setType(string $var)

The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.

string
getVariable()

Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds to an output variable of the parent node. The field carries the name of the output variable.

setVariable(string $var)

Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds to an output variable of the parent node. The field carries the name of the output variable.

Details

at line 48
__construct()

at line 59
int getChildIndex()

The node to which the link points.

Generated from protobuf field int32 child_index = 1;

Return Value

int

at line 70
setChildIndex(int $var)

The node to which the link points.

Generated from protobuf field int32 child_index = 1;

Parameters

int $var

at line 85
string getType()

The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.

Generated from protobuf field string type = 2;

Return Value

string

at line 99
setType(string $var)

The type of the link. For example, in Hash Joins this could be used to distinguish between the build child and the probe child, or in the case of the child being an output variable, to represent the tag associated with the output variable.

Generated from protobuf field string type = 2;

Parameters

string $var

at line 118
string getVariable()

Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds to an output variable of the parent node. The field carries the name of the output variable.

For example, a TableScan operator that reads rows from a table will have child links to the SCALAR nodes representing the output variables created for each column that is read by the operator. The corresponding variable fields will be set to the variable names assigned to the columns.

Generated from protobuf field string variable = 3;

Return Value

string

at line 136
setVariable(string $var)

Only present if the child node is [SCALAR][google.spanner.v1.PlanNode.Kind.SCALAR] and corresponds to an output variable of the parent node. The field carries the name of the output variable.

For example, a TableScan operator that reads rows from a table will have child links to the SCALAR nodes representing the output variables created for each column that is read by the operator. The corresponding variable fields will be set to the variable names assigned to the columns.

Generated from protobuf field string variable = 3;

Parameters

string $var