com.pingcap.tidb.tipb

Interface DAGRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DAGRequest, DAGRequest.Builder

public interface DAGRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ChunkMemoryLayout	getChunkMemoryLayout() Represents the chunk memory layout.
ChunkMemoryLayoutOrBuilder	getChunkMemoryLayoutOrBuilder() Represents the chunk memory layout.
boolean	getCollectExecutionSummaries() It represents whether or not TiKV should collect execution summaries.
boolean	getCollectRangeCounts() It represents whether we collect the detailed scan counts in each range.
EncodeType	getEncodeType() It indicates the encode type of response.
Executor	getExecutors(int index) It represents push down Executors.
int	getExecutorsCount() It represents push down Executors.
List<Executor>	getExecutorsList() It represents push down Executors.
ExecutorOrBuilder	getExecutorsOrBuilder(int index) It represents push down Executors.
List<? extends ExecutorOrBuilder>	getExecutorsOrBuilderList() It represents push down Executors.
long	getFlags() flags are used to store flags that change the execution mode, it contains: ignore_truncate = 1 truncate error should be ignore if set.
boolean	getIsRpnExpr() Represents whether the expression use RPN form.
long	getMaxAllowedPacket() Represents the maximum size of one packet, any generated string, or any parameter sent as long data.
long	getMaxWarningCount() It indicates the maximum number of warning, which is the number of messages that SHOW WARNINGS displays.
int	getOutputOffsets(int index) It represents which columns we should output.
int	getOutputOffsetsCount() It represents which columns we should output.
List<Integer>	getOutputOffsetsList() It represents which columns we should output.
long	getSqlMode() It indicates the sql_mode.
long	getStartTsFallback() Transaction start timestamp.
String	getTimeZoneName() supply offset is not enough since we have daylight saving time present in some regions
com.google.protobuf.ByteString	getTimeZoneNameBytes() supply offset is not enough since we have daylight saving time present in some regions
long	getTimeZoneOffset() time zone offset in seconds
UserIdentity	getUser() UserIdentity uses to do privilege check.
UserIdentityOrBuilder	getUserOrBuilder() UserIdentity uses to do privilege check.
boolean	hasChunkMemoryLayout() Represents the chunk memory layout.
boolean	hasCollectExecutionSummaries() It represents whether or not TiKV should collect execution summaries.
boolean	hasCollectRangeCounts() It represents whether we collect the detailed scan counts in each range.
boolean	hasEncodeType() It indicates the encode type of response.
boolean	hasFlags() flags are used to store flags that change the execution mode, it contains: ignore_truncate = 1 truncate error should be ignore if set.
boolean	hasIsRpnExpr() Represents whether the expression use RPN form.
boolean	hasMaxAllowedPacket() Represents the maximum size of one packet, any generated string, or any parameter sent as long data.
boolean	hasMaxWarningCount() It indicates the maximum number of warning, which is the number of messages that SHOW WARNINGS displays.
boolean	hasSqlMode() It indicates the sql_mode.
boolean	hasStartTsFallback() Transaction start timestamp.
boolean	hasTimeZoneName() supply offset is not enough since we have daylight saving time present in some regions
boolean	hasTimeZoneOffset() time zone offset in seconds
boolean	hasUser() UserIdentity uses to do privilege check.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasStartTsFallback

boolean hasStartTsFallback()

 Transaction start timestamp.
 Deprecated. Start Ts has been moved to coprocessor.Request.
 

optional uint64 start_ts_fallback = 1;

Returns:

Whether the startTsFallback field is set.

getStartTsFallback

long getStartTsFallback()

 Transaction start timestamp.
 Deprecated. Start Ts has been moved to coprocessor.Request.
 

optional uint64 start_ts_fallback = 1;

Returns:

The startTsFallback.

getExecutorsList

List<Executor> getExecutorsList()

 It represents push down Executors.
 

repeated .tipb.Executor executors = 2;

getExecutors

Executor getExecutors(int index)

 It represents push down Executors.
 

repeated .tipb.Executor executors = 2;

getExecutorsCount

int getExecutorsCount()

 It represents push down Executors.
 

repeated .tipb.Executor executors = 2;

getExecutorsOrBuilderList

List<? extends ExecutorOrBuilder> getExecutorsOrBuilderList()

 It represents push down Executors.
 

repeated .tipb.Executor executors = 2;

getExecutorsOrBuilder

ExecutorOrBuilder getExecutorsOrBuilder(int index)

 It represents push down Executors.
 

repeated .tipb.Executor executors = 2;

hasTimeZoneOffset

boolean hasTimeZoneOffset()

 time zone offset in seconds
 

optional int64 time_zone_offset = 3 [(.gogoproto.nullable) = false];

Returns:

Whether the timeZoneOffset field is set.

getTimeZoneOffset

long getTimeZoneOffset()

 time zone offset in seconds
 

optional int64 time_zone_offset = 3 [(.gogoproto.nullable) = false];

Returns:

The timeZoneOffset.

hasFlags

boolean hasFlags()

 flags are used to store flags that change the execution mode, it contains:
        ignore_truncate = 1
                truncate error should be ignore if set.
        truncate_as_warning = 1 << 1
                when ignored_truncate is not set, return warning instead of error if this flag is set.
        ...
        add more when needed.
 

optional uint64 flags = 4 [(.gogoproto.nullable) = false];

Returns:

Whether the flags field is set.

getFlags

long getFlags()

 flags are used to store flags that change the execution mode, it contains:
        ignore_truncate = 1
                truncate error should be ignore if set.
        truncate_as_warning = 1 << 1
                when ignored_truncate is not set, return warning instead of error if this flag is set.
        ...
        add more when needed.
 

optional uint64 flags = 4 [(.gogoproto.nullable) = false];

Returns:

The flags.

getOutputOffsetsList

List<Integer> getOutputOffsetsList()

 It represents which columns we should output.
 

repeated uint32 output_offsets = 5;

Returns:

A list containing the outputOffsets.

getOutputOffsetsCount

int getOutputOffsetsCount()

 It represents which columns we should output.
 

repeated uint32 output_offsets = 5;

Returns:

The count of outputOffsets.

getOutputOffsets

int getOutputOffsets(int index)

 It represents which columns we should output.
 

repeated uint32 output_offsets = 5;

Parameters:

index - The index of the element to return.

Returns:

The outputOffsets at the given index.

hasCollectRangeCounts

boolean hasCollectRangeCounts()

 It represents whether we collect the detailed scan counts in each range.
 

optional bool collect_range_counts = 6;

Returns:

Whether the collectRangeCounts field is set.

getCollectRangeCounts

boolean getCollectRangeCounts()

 It represents whether we collect the detailed scan counts in each range.
 

optional bool collect_range_counts = 6;

Returns:

The collectRangeCounts.

hasMaxWarningCount

boolean hasMaxWarningCount()

 It indicates the maximum number of warning,
 which is the number of messages that SHOW WARNINGS displays.
 

optional uint64 max_warning_count = 7;

Returns:

Whether the maxWarningCount field is set.

getMaxWarningCount

long getMaxWarningCount()

 It indicates the maximum number of warning,
 which is the number of messages that SHOW WARNINGS displays.
 

optional uint64 max_warning_count = 7;

Returns:

The maxWarningCount.

hasEncodeType

boolean hasEncodeType()

 It indicates the encode type of response.
 

optional .tipb.EncodeType encode_type = 8 [(.gogoproto.nullable) = false];

Returns:

Whether the encodeType field is set.

getEncodeType

EncodeType getEncodeType()

 It indicates the encode type of response.
 

optional .tipb.EncodeType encode_type = 8 [(.gogoproto.nullable) = false];

Returns:

The encodeType.

hasSqlMode

boolean hasSqlMode()

 It indicates the sql_mode.
 

optional uint64 sql_mode = 9;

Returns:

Whether the sqlMode field is set.

getSqlMode

long getSqlMode()

 It indicates the sql_mode.
 

optional uint64 sql_mode = 9;

Returns:

The sqlMode.

hasTimeZoneName

boolean hasTimeZoneName()

 supply offset is not enough since we have daylight saving time present in some regions
 

optional string time_zone_name = 11 [(.gogoproto.nullable) = false];

Returns:

Whether the timeZoneName field is set.

getTimeZoneName

String getTimeZoneName()

 supply offset is not enough since we have daylight saving time present in some regions
 

optional string time_zone_name = 11 [(.gogoproto.nullable) = false];

Returns:

The timeZoneName.

getTimeZoneNameBytes

com.google.protobuf.ByteString getTimeZoneNameBytes()

 supply offset is not enough since we have daylight saving time present in some regions
 

optional string time_zone_name = 11 [(.gogoproto.nullable) = false];

Returns:

The bytes for timeZoneName.

hasCollectExecutionSummaries

boolean hasCollectExecutionSummaries()

 It represents whether or not TiKV should collect execution summaries.
 Execution summaries will be collected into `execution_summaries` field
 in the response.
 

optional bool collect_execution_summaries = 12;

Returns:

Whether the collectExecutionSummaries field is set.

getCollectExecutionSummaries

boolean getCollectExecutionSummaries()

 It represents whether or not TiKV should collect execution summaries.
 Execution summaries will be collected into `execution_summaries` field
 in the response.
 

optional bool collect_execution_summaries = 12;

Returns:

The collectExecutionSummaries.

hasMaxAllowedPacket

boolean hasMaxAllowedPacket()

 Represents the maximum size of one packet, any generated string, or any parameter sent as long data.
 

optional uint64 max_allowed_packet = 13;

Returns:

Whether the maxAllowedPacket field is set.

getMaxAllowedPacket

long getMaxAllowedPacket()

 Represents the maximum size of one packet, any generated string, or any parameter sent as long data.
 

optional uint64 max_allowed_packet = 13;

Returns:

The maxAllowedPacket.

hasChunkMemoryLayout

boolean hasChunkMemoryLayout()

 Represents the chunk memory layout.
 

optional .tipb.ChunkMemoryLayout chunk_memory_layout = 14;

Returns:

Whether the chunkMemoryLayout field is set.

getChunkMemoryLayout

ChunkMemoryLayout getChunkMemoryLayout()

 Represents the chunk memory layout.
 

optional .tipb.ChunkMemoryLayout chunk_memory_layout = 14;

Returns:

The chunkMemoryLayout.

getChunkMemoryLayoutOrBuilder

ChunkMemoryLayoutOrBuilder getChunkMemoryLayoutOrBuilder()

 Represents the chunk memory layout.
 

optional .tipb.ChunkMemoryLayout chunk_memory_layout = 14;

hasIsRpnExpr

boolean hasIsRpnExpr()

 Represents whether the expression use RPN form.
 

optional bool is_rpn_expr = 15;

Returns:

Whether the isRpnExpr field is set.

getIsRpnExpr

boolean getIsRpnExpr()

 Represents whether the expression use RPN form.
 

optional bool is_rpn_expr = 15;

Returns:

The isRpnExpr.

hasUser

boolean hasUser()

 UserIdentity uses to do privilege check. It is only used in TiDB cluster memory table.
 

optional .tipb.UserIdentity user = 16;

Returns:

Whether the user field is set.

getUser

UserIdentity getUser()

 UserIdentity uses to do privilege check. It is only used in TiDB cluster memory table.
 

optional .tipb.UserIdentity user = 16;

Returns:

The user.

getUserOrBuilder

UserIdentityOrBuilder getUserOrBuilder()

 UserIdentity uses to do privilege check. It is only used in TiDB cluster memory table.
 

optional .tipb.UserIdentity user = 16;