TableScan (TiSpark Project TiKV Java Client 3.1.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.pingcap.tidb.tipb.TableScan

所有已实现的接口:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TableScanOrBuilder, Serializable
```
public final class TableScan
extends com.google.protobuf.GeneratedMessageV3
implements TableScanOrBuilder
```
Protobuf type tipb.TableScan

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

static class TableScan.Builder
Protobuf type tipb.TableScan
- 从类继承的嵌套类/接口 com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- 从类继承的嵌套类/接口 com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

嵌套类
限定符和类型	类和说明
`static class`	`TableScan.Builder` Protobuf type `tipb.TableScan`

字段概要

字段
限定符和类型	字段和说明
`static int`	`COLUMNS_FIELD_NUMBER`
`static int`	`DESC_FIELD_NUMBER`
`static int`	`NEXT_READ_ENGINE_FIELD_NUMBER`
`static com.google.protobuf.Parser<TableScan>`	`PARSER` 已过时。
`static int`	`PRIMARY_COLUMN_IDS_FIELD_NUMBER`
`static int`	`RANGES_FIELD_NUMBER`
`static int`	`TABLE_ID_FIELD_NUMBER`

从类继承的字段 com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

从类继承的字段 com.google.protobuf.AbstractMessage
memoizedSize

从类继承的字段 com.google.protobuf.AbstractMessageLite
memoizedHashCode

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`equals(Object obj)`
`ColumnInfo`	`getColumns(int index)` `repeated .tipb.ColumnInfo columns = 2;`
`int`	`getColumnsCount()` `repeated .tipb.ColumnInfo columns = 2;`
`List<ColumnInfo>`	`getColumnsList()` `repeated .tipb.ColumnInfo columns = 2;`
`ColumnInfoOrBuilder`	`getColumnsOrBuilder(int index)` `repeated .tipb.ColumnInfo columns = 2;`
`List<? extends ColumnInfoOrBuilder>`	`getColumnsOrBuilderList()` `repeated .tipb.ColumnInfo columns = 2;`
`static TableScan`	`getDefaultInstance()`
`TableScan`	`getDefaultInstanceForType()`
`boolean`	`getDesc()` `optional bool desc = 3 [(.gogoproto.nullable) = false];`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`EngineType`	`getNextReadEngine()` which engine we should in next step, only used by tiflash `optional .tipb.EngineType next_read_engine = 5 [(.gogoproto.nullable) = false];`
`com.google.protobuf.Parser<TableScan>`	`getParserForType()`
`long`	`getPrimaryColumnIds(int index)` `repeated int64 primary_column_ids = 4;`
`int`	`getPrimaryColumnIdsCount()` `repeated int64 primary_column_ids = 4;`
`List<Long>`	`getPrimaryColumnIdsList()` `repeated int64 primary_column_ids = 4;`
`KeyRange`	`getRanges(int index)` For global read in join, we must point out the key ranges when we don't have the region info.
`int`	`getRangesCount()` For global read in join, we must point out the key ranges when we don't have the region info.
`List<KeyRange>`	`getRangesList()` For global read in join, we must point out the key ranges when we don't have the region info.
`KeyRangeOrBuilder`	`getRangesOrBuilder(int index)` For global read in join, we must point out the key ranges when we don't have the region info.
`List<? extends KeyRangeOrBuilder>`	`getRangesOrBuilderList()` For global read in join, we must point out the key ranges when we don't have the region info.
`int`	`getSerializedSize()`
`long`	`getTableId()` `optional int64 table_id = 1 [(.gogoproto.nullable) = false];`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasDesc()` `optional bool desc = 3 [(.gogoproto.nullable) = false];`
`int`	`hashCode()`
`boolean`	`hasNextReadEngine()` which engine we should in next step, only used by tiflash `optional .tipb.EngineType next_read_engine = 5 [(.gogoproto.nullable) = false];`
`boolean`	`hasTableId()` `optional int64 table_id = 1 [(.gogoproto.nullable) = false];`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static TableScan.Builder`	`newBuilder()`
`static TableScan.Builder`	`newBuilder(TableScan prototype)`
`TableScan.Builder`	`newBuilderForType()`
`protected TableScan.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static TableScan`	`parseDelimitedFrom(InputStream input)`
`static TableScan`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static TableScan`	`parseFrom(byte[] data)`
`static TableScan`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static TableScan`	`parseFrom(ByteBuffer data)`
`static TableScan`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static TableScan`	`parseFrom(com.google.protobuf.ByteString data)`
`static TableScan`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static TableScan`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static TableScan`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static TableScan`	`parseFrom(InputStream input)`
`static TableScan`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<TableScan>`	`parser()`
`TableScan.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

从类继承的方法 com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

从类继承的方法 com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

从类继承的方法 com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

从接口继承的方法 com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

- 字段详细资料
  - TABLE_ID_FIELD_NUMBER
```
public static final int TABLE_ID_FIELD_NUMBER
```
    另请参阅:
    
    常量字段值
  - COLUMNS_FIELD_NUMBER
```
public static final int COLUMNS_FIELD_NUMBER
```
    另请参阅:
    
    常量字段值
  - DESC_FIELD_NUMBER
```
public static final int DESC_FIELD_NUMBER
```
    另请参阅:
    
    常量字段值
  - PRIMARY_COLUMN_IDS_FIELD_NUMBER
```
public static final int PRIMARY_COLUMN_IDS_FIELD_NUMBER
```
    另请参阅:
    
    常量字段值
  - NEXT_READ_ENGINE_FIELD_NUMBER
```
public static final int NEXT_READ_ENGINE_FIELD_NUMBER
```
    另请参阅:
    
    常量字段值
  - RANGES_FIELD_NUMBER
```
public static final int RANGES_FIELD_NUMBER
```
    另请参阅:
    
    常量字段值
  - PARSER
```
@Deprecated
public static final com.google.protobuf.Parser<TableScan> PARSER
```
    已过时。
- 方法详细资料
  - getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
    指定者:
    
    getUnknownFields 在接口中 com.google.protobuf.MessageOrBuilder
    
    覆盖:
    
    getUnknownFields 在类中 com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    指定者:
    
    internalGetFieldAccessorTable 在类中 com.google.protobuf.GeneratedMessageV3
  - hasTableId
```
public boolean hasTableId()
```
    optional int64 table_id = 1 [(.gogoproto.nullable) = false];
    
    指定者:
    
    hasTableId 在接口中 TableScanOrBuilder
  - getTableId
```
public long getTableId()
```
    optional int64 table_id = 1 [(.gogoproto.nullable) = false];
    
    指定者:
    
    getTableId 在接口中 TableScanOrBuilder
  - getColumnsList
```
public List<ColumnInfo> getColumnsList()
```
    repeated .tipb.ColumnInfo columns = 2;
    
    指定者:
    
    getColumnsList 在接口中 TableScanOrBuilder
  - getColumnsOrBuilderList
```
public List<? extends ColumnInfoOrBuilder> getColumnsOrBuilderList()
```
    repeated .tipb.ColumnInfo columns = 2;
    
    指定者:
    
    getColumnsOrBuilderList 在接口中 TableScanOrBuilder
  - getColumnsCount
```
public int getColumnsCount()
```
    repeated .tipb.ColumnInfo columns = 2;
    
    指定者:
    
    getColumnsCount 在接口中 TableScanOrBuilder
  - getColumns
```
public ColumnInfo getColumns(int index)
```
    repeated .tipb.ColumnInfo columns = 2;
    
    指定者:
    
    getColumns 在接口中 TableScanOrBuilder
  - getColumnsOrBuilder
```
public ColumnInfoOrBuilder getColumnsOrBuilder(int index)
```
    repeated .tipb.ColumnInfo columns = 2;
    
    指定者:
    
    getColumnsOrBuilder 在接口中 TableScanOrBuilder
  - hasDesc
```
public boolean hasDesc()
```
    optional bool desc = 3 [(.gogoproto.nullable) = false];
    
    指定者:
    
    hasDesc 在接口中 TableScanOrBuilder
  - getDesc
```
public boolean getDesc()
```
    optional bool desc = 3 [(.gogoproto.nullable) = false];
    
    指定者:
    
    getDesc 在接口中 TableScanOrBuilder
  - getPrimaryColumnIdsList
```
public List<Long> getPrimaryColumnIdsList()
```
    repeated int64 primary_column_ids = 4;
    
    指定者:
    
    getPrimaryColumnIdsList 在接口中 TableScanOrBuilder
  - getPrimaryColumnIdsCount
```
public int getPrimaryColumnIdsCount()
```
    repeated int64 primary_column_ids = 4;
    
    指定者:
    
    getPrimaryColumnIdsCount 在接口中 TableScanOrBuilder
  - getPrimaryColumnIds
```
public long getPrimaryColumnIds(int index)
```
    repeated int64 primary_column_ids = 4;
    
    指定者:
    
    getPrimaryColumnIds 在接口中 TableScanOrBuilder
  - hasNextReadEngine
```
public boolean hasNextReadEngine()
```
```
 which engine we should in next step, only used by tiflash
 
```
    optional .tipb.EngineType next_read_engine = 5 [(.gogoproto.nullable) = false];
    指定者:
    
    hasNextReadEngine 在接口中 TableScanOrBuilder
  - getNextReadEngine
```
public EngineType getNextReadEngine()
```
```
 which engine we should in next step, only used by tiflash
 
```
    optional .tipb.EngineType next_read_engine = 5 [(.gogoproto.nullable) = false];
    指定者:
    
    getNextReadEngine 在接口中 TableScanOrBuilder
  - getRangesList
```
public List<KeyRange> getRangesList()
```
```
 For global read in join, we must point out the key ranges when we don't have the region info.
 
```
    repeated .tipb.KeyRange ranges = 6 [(.gogoproto.nullable) = false];
    指定者:
    
    getRangesList 在接口中 TableScanOrBuilder
  - getRangesOrBuilderList
```
public List<? extends KeyRangeOrBuilder> getRangesOrBuilderList()
```
```
 For global read in join, we must point out the key ranges when we don't have the region info.
 
```
    repeated .tipb.KeyRange ranges = 6 [(.gogoproto.nullable) = false];
    指定者:
    
    getRangesOrBuilderList 在接口中 TableScanOrBuilder
  - getRangesCount
```
public int getRangesCount()
```
```
 For global read in join, we must point out the key ranges when we don't have the region info.
 
```
    repeated .tipb.KeyRange ranges = 6 [(.gogoproto.nullable) = false];
    指定者:
    
    getRangesCount 在接口中 TableScanOrBuilder
  - getRanges
```
public KeyRange getRanges(int index)
```
```
 For global read in join, we must point out the key ranges when we don't have the region info.
 
```
    repeated .tipb.KeyRange ranges = 6 [(.gogoproto.nullable) = false];
    指定者:
    
    getRanges 在接口中 TableScanOrBuilder
  - getRangesOrBuilder
```
public KeyRangeOrBuilder getRangesOrBuilder(int index)
```
```
 For global read in join, we must point out the key ranges when we don't have the region info.
 
```
    repeated .tipb.KeyRange ranges = 6 [(.gogoproto.nullable) = false];
    指定者:
    
    getRangesOrBuilder 在接口中 TableScanOrBuilder
  - isInitialized
```
public final boolean isInitialized()
```
    指定者:
    
    isInitialized 在接口中 com.google.protobuf.MessageLiteOrBuilder
    
    覆盖:
    
    isInitialized 在类中 com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
```
    指定者:
    
    writeTo 在接口中 com.google.protobuf.MessageLite
    
    覆盖:
    
    writeTo 在类中 com.google.protobuf.GeneratedMessageV3
    
    抛出:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    指定者:
    
    getSerializedSize 在接口中 com.google.protobuf.MessageLite
    
    覆盖:
    
    getSerializedSize 在类中 com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(Object obj)
```
    指定者:
    
    equals 在接口中 com.google.protobuf.Message
    
    覆盖:
    
    equals 在类中 com.google.protobuf.AbstractMessage
  - hashCode
```
public int hashCode()
```
    指定者:
    
    hashCode 在接口中 com.google.protobuf.Message
    
    覆盖:
    
    hashCode 在类中 com.google.protobuf.AbstractMessage
  - parseFrom
```
public static TableScan parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    抛出:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static TableScan parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    抛出:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static TableScan parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    抛出:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static TableScan parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    抛出:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static TableScan parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    抛出:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static TableScan parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
```
    抛出:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static TableScan parseFrom(InputStream input)
                           throws IOException
```
    抛出:
    
    IOException
  - parseFrom
```
public static TableScan parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
```
    抛出:
    
    IOException
  - parseDelimitedFrom
```
public static TableScan parseDelimitedFrom(InputStream input)
                                    throws IOException
```
    抛出:
    
    IOException
  - parseDelimitedFrom
```
public static TableScan parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
```
    抛出:
    
    IOException
  - parseFrom
```
public static TableScan parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException
```
    抛出:
    
    IOException
  - parseFrom
```
public static TableScan parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
```
    抛出:
    
    IOException
  - newBuilderForType
```
public TableScan.Builder newBuilderForType()
```
    指定者:
    
    newBuilderForType 在接口中 com.google.protobuf.Message
    
    指定者:
    
    newBuilderForType 在接口中 com.google.protobuf.MessageLite
  - newBuilder
```
public static TableScan.Builder newBuilder()
```
  - newBuilder
```
public static TableScan.Builder newBuilder(TableScan prototype)
```
  - toBuilder
```
public TableScan.Builder toBuilder()
```
    指定者:
    
    toBuilder 在接口中 com.google.protobuf.Message
    
    指定者:
    
    toBuilder 在接口中 com.google.protobuf.MessageLite
  - newBuilderForType
```
protected TableScan.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    指定者:
    
    newBuilderForType 在类中 com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static TableScan getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<TableScan> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<TableScan> getParserForType()
```
    指定者:
    
    getParserForType 在接口中 com.google.protobuf.Message
    
    指定者:
    
    getParserForType 在接口中 com.google.protobuf.MessageLite
    
    覆盖:
    
    getParserForType 在类中 com.google.protobuf.GeneratedMessageV3
  - getDefaultInstanceForType
```
public TableScan getDefaultInstanceForType()
```
    指定者:
    
    getDefaultInstanceForType 在接口中 com.google.protobuf.MessageLiteOrBuilder
    
    指定者:
    
    getDefaultInstanceForType 在接口中 com.google.protobuf.MessageOrBuilder

类 TableScan

嵌套类概要

从类继承的嵌套类/接口 com.google.protobuf.GeneratedMessageV3

从类继承的嵌套类/接口 com.google.protobuf.AbstractMessageLite

字段概要

从类继承的字段 com.google.protobuf.GeneratedMessageV3

从类继承的字段 com.google.protobuf.AbstractMessage

从类继承的字段 com.google.protobuf.AbstractMessageLite

方法概要

从类继承的方法 com.google.protobuf.GeneratedMessageV3

从类继承的方法 com.google.protobuf.AbstractMessage

从类继承的方法 com.google.protobuf.AbstractMessageLite

从类继承的方法 java.lang.Object

从接口继承的方法 com.google.protobuf.MessageOrBuilder

从接口继承的方法 com.google.protobuf.MessageLite

字段详细资料

TABLE_ID_FIELD_NUMBER

COLUMNS_FIELD_NUMBER

DESC_FIELD_NUMBER

PRIMARY_COLUMN_IDS_FIELD_NUMBER

NEXT_READ_ENGINE_FIELD_NUMBER

RANGES_FIELD_NUMBER

PARSER

方法详细资料

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

hasTableId

getTableId

getColumnsList

getColumnsOrBuilderList

getColumnsCount

getColumns

getColumnsOrBuilder

hasDesc

getDesc

getPrimaryColumnIdsList

getPrimaryColumnIdsCount

getPrimaryColumnIds

hasNextReadEngine

getNextReadEngine

getRangesList

getRangesOrBuilderList

getRangesCount

getRanges

getRangesOrBuilder

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType