TiDAGRequest (TiKV Java Client 3.3.4-SNAPSHOT API)

java.lang.Object
- org.tikv.common.meta.TiDAGRequest

All Implemented Interfaces:

Serializable
```
public class TiDAGRequest
extends Object
implements Serializable
```
Type TiDAGRequest.
Used for constructing a new DAG request to TiKV

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TiDAGRequest.Builder`
`static class`	`TiDAGRequest.IndexScanType`
`static class`	`TiDAGRequest.PushDownType` Whether we use streaming to push down the request
`static class`	`TiDAGRequest.TruncateMode`

Constructor Summary

Constructors
Constructor and Description
`TiDAGRequest(TiDAGRequest.PushDownType pushDownType)`
`TiDAGRequest(TiDAGRequest.PushDownType pushDownType, EncodeType encodeType, int timeZoneOffset)`
`TiDAGRequest(TiDAGRequest.PushDownType pushDownType, int timeZoneOffset)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TiDAGRequest`	`addAggregate(AggregateFunction expr)`
`void`	`addDowngradeFilter(Expression filter)`
`TiDAGRequest`	`addFilters(List<Expression> filters)`
`TiDAGRequest`	`addGroupByItem(ByItem byItem)` add a group by clause to select query
`TiDAGRequest`	`addOrderByItem(ByItem byItem)` add a order by clause to select query.
`TiDAGRequest`	`addRanges(Map<Long,List<Coprocessor.KeyRange>> ranges)` set key range of scan
`TiDAGRequest`	`addRequiredColumn(ColumnRef column)` Field is not support in TiDB yet, for here we simply allow TiColumnRef instead of TiExpr like in SelectRequest proto
`DAGRequest`	`buildIndexScan()`
`DAGRequest`	`buildTableScan()`
`void`	`clearIndexInfo()`
`TiDAGRequest`	`copy()`
`TiDAGRequest`	`copyReqWithPhysicalId(long id)`
`List<Expression>`	`getDowngradeFilters()`
`EncodeType`	`getEncodeType()`
`double`	`getEstimatedCount()` Get the estimated row count will be fetched from this request.
`List<ColumnRef>`	`getFields()`
`List<Expression>`	`getFilters()`
`List<ByItem>`	`getGroupByItems()`
`List<DataType>`	`getIndexDataTypes()`
`TiIndexInfo`	`getIndexInfo()`
`TiDAGRequest.IndexScanType`	`getIndexScanType()`
`int`	`getLimit()`
`long`	`getPhysicalId()`
`List<TiPartitionDef>`	`getPrunedParts()`
`List<Long>`	`getPrunedPhysicalIds()`
`List<AggregateFunction>`	`getPushDownAggregates()`
`List<ByItem>`	`getPushDownGroupBys()`
`List<ByItem>`	`getPushDownOrderBys()`
`TiDAGRequest.PushDownType`	`getPushDownType()` Whether we use streaming processing to retrieve data
`List<Coprocessor.KeyRange>`	`getRangesByPhysicalId(long physicalId)`
`Map<Long,List<Coprocessor.KeyRange>>`	`getRangesMaps()`
`TiTimestamp`	`getStartTs()`
`TiStoreType`	`getStoreType()`
`TiTableInfo`	`getTableInfo()`
`boolean`	`hasIndex()` Returns whether this request is of indexScanType
`boolean`	`hasPushDownAggregate()` Check whether the DAG request has any aggregate expression.
`boolean`	`hasPushDownGroupBy()` Check whether the DAG request has any group by expression.
`void`	`init(boolean readHandle)`
`boolean`	`isDistinct()`
`boolean`	`isDoubleRead()` Returns whether needs to read handle from index first and find its corresponding row.
`void`	`resetFilters(List<Expression> filters)`
`TiDAGRequest`	`setDistinct(boolean distinct)`
`void`	`setEncodeType(EncodeType encodeType)`
`void`	`setEstimatedCount(double estimatedCount)` Set the estimated row count will be fetched from this request.
`TiDAGRequest`	`setHaving(Expression having)` set having clause to select query
`TiDAGRequest`	`setIndexInfo(TiIndexInfo indexInfo)`
`void`	`setIsDoubleRead(boolean isDoubleRead)` Sets isDoubleRead
`TiDAGRequest`	`setLimit(int limit)` add limit clause to select query.
`TiDAGRequest`	`setPhysicalId(long id)`
`void`	`setPrunedParts(List<TiPartitionDef> prunedParts)`
`TiDAGRequest`	`setStartTs(TiTimestamp startTs)` set start timestamp for the transaction
`void`	`setStoreType(TiStoreType storeType)`
`TiDAGRequest`	`setTableInfo(TiTableInfo tableInfo)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TiDAGRequest

public TiDAGRequest(TiDAGRequest.PushDownType pushDownType)

TiDAGRequest

public TiDAGRequest(TiDAGRequest.PushDownType pushDownType,
                    EncodeType encodeType,
                    int timeZoneOffset)

TiDAGRequest

public TiDAGRequest(TiDAGRequest.PushDownType pushDownType,
                    int timeZoneOffset)

Method Detail

getPrunedParts

public List<TiPartitionDef> getPrunedParts()

setPrunedParts

public void setPrunedParts(List<TiPartitionDef> prunedParts)

getPrunedPhysicalIds

public List<Long> getPrunedPhysicalIds()

getStoreType
```
public TiStoreType getStoreType()
```

setStoreType

public void setStoreType(TiStoreType storeType)

getEncodeType
```
public EncodeType getEncodeType()
```

setEncodeType

public void setEncodeType(EncodeType encodeType)

buildIndexScan
```
public DAGRequest buildIndexScan()
```

buildTableScan
```
public DAGRequest buildTableScan()
```

getTableInfo
```
public TiTableInfo getTableInfo()
```

setTableInfo

public TiDAGRequest setTableInfo(TiTableInfo tableInfo)

getPhysicalId
```
public long getPhysicalId()
```

setPhysicalId

public TiDAGRequest setPhysicalId(long id)

getIndexInfo
```
public TiIndexInfo getIndexInfo()
```

setIndexInfo

public TiDAGRequest setIndexInfo(TiIndexInfo indexInfo)

clearIndexInfo
```
public void clearIndexInfo()
```

getLimit
```
public int getLimit()
```

setLimit
```
public TiDAGRequest setLimit(int limit)
```
add limit clause to select query.

Parameters:

limit - is just a integer.

Returns:

a SelectBuilder

getStartTs
```
public TiTimestamp getStartTs()
```

setStartTs

public TiDAGRequest setStartTs(@Nonnull
                               TiTimestamp startTs)

set start timestamp for the transaction

Parameters:: startTs - timestamp
Returns:: a TiDAGRequest

setHaving
```
public TiDAGRequest setHaving(Expression having)
```
set having clause to select query

Parameters:

having - is a expression represents Having

Returns:

a TiDAGRequest

isDistinct
```
public boolean isDistinct()
```

setDistinct

public TiDAGRequest setDistinct(boolean distinct)

addAggregate

public TiDAGRequest addAggregate(AggregateFunction expr)

addOrderByItem
```
public TiDAGRequest addOrderByItem(ByItem byItem)
```
add a order by clause to select query.

Parameters:

byItem - is a TiByItem.

Returns:

a SelectBuilder

addGroupByItem
```
public TiDAGRequest addGroupByItem(ByItem byItem)
```
add a group by clause to select query

Parameters:

byItem - is a TiByItem

Returns:

a SelectBuilder

getGroupByItems
```
public List<ByItem> getGroupByItems()
```

addRequiredColumn
```
public TiDAGRequest addRequiredColumn(ColumnRef column)
```
Field is not support in TiDB yet, for here we simply allow TiColumnRef instead of TiExpr like in SelectRequest proto

This interface allows duplicate columns and it's user's responsibility to do dedup since we need to ensure exact order and items preserved during decoding

Parameters:

column - is column referred during selectReq

getFields
```
public List<ColumnRef> getFields()
```

getIndexDataTypes

public List<DataType> getIndexDataTypes()

addRanges

public TiDAGRequest addRanges(Map<Long,List<Coprocessor.KeyRange>> ranges)

set key range of scan

Parameters:: ranges - key range of scan

resetFilters

public void resetFilters(List<Expression> filters)

getRangesByPhysicalId

public List<Coprocessor.KeyRange> getRangesByPhysicalId(long physicalId)

getRangesMaps

public Map<Long,List<Coprocessor.KeyRange>> getRangesMaps()

addFilters

public TiDAGRequest addFilters(List<Expression> filters)

getFilters
```
public List<Expression> getFilters()
```

addDowngradeFilter

public void addDowngradeFilter(Expression filter)

getDowngradeFilters

public List<Expression> getDowngradeFilters()

getPushDownAggregates

public List<AggregateFunction> getPushDownAggregates()

getPushDownGroupBys

public List<ByItem> getPushDownGroupBys()

getPushDownOrderBys

public List<ByItem> getPushDownOrderBys()

hasPushDownAggregate
```
public boolean hasPushDownAggregate()
```
Check whether the DAG request has any aggregate expression.

Returns:

the boolean

hasPushDownGroupBy
```
public boolean hasPushDownGroupBy()
```
Check whether the DAG request has any group by expression.

Returns:

the boolean

isDoubleRead
```
public boolean isDoubleRead()
```
Returns whether needs to read handle from index first and find its corresponding row. i.e, "double read"

Returns:

boolean

setIsDoubleRead
```
public void setIsDoubleRead(boolean isDoubleRead)
```
Sets isDoubleRead

Parameters:

isDoubleRead - if is double read

hasIndex
```
public boolean hasIndex()
```
Returns whether this request is of indexScanType

Returns:

true iff indexInfo is provided, false otherwise

getPushDownType
```
public TiDAGRequest.PushDownType getPushDownType()
```
Whether we use streaming processing to retrieve data

Returns:

push down type.

getEstimatedCount
```
public double getEstimatedCount()
```
Get the estimated row count will be fetched from this request.

setEstimatedCount
```
public void setEstimatedCount(double estimatedCount)
```
Set the estimated row count will be fetched from this request.

init
```
public void init(boolean readHandle)
```

getIndexScanType

public TiDAGRequest.IndexScanType getIndexScanType()

toString
```
public String toString()
```
Overrides:

toString in class Object

copy
```
public TiDAGRequest copy()
```

copyReqWithPhysicalId

public TiDAGRequest copyReqWithPhysicalId(long id)

Class TiDAGRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TiDAGRequest

TiDAGRequest

TiDAGRequest

Method Detail

getPrunedParts

setPrunedParts

getPrunedPhysicalIds

getStoreType

setStoreType

getEncodeType

setEncodeType

buildIndexScan

buildTableScan

getTableInfo

setTableInfo

getPhysicalId

setPhysicalId

getIndexInfo

setIndexInfo

clearIndexInfo

getLimit

setLimit

getStartTs

setStartTs

setHaving

isDistinct

setDistinct

addAggregate

addOrderByItem

addGroupByItem

getGroupByItems

addRequiredColumn

getFields

getIndexDataTypes

addRanges

resetFilters

getRangesByPhysicalId

getRangesMaps

addFilters

getFilters

addDowngradeFilter

getDowngradeFilters

getPushDownAggregates

getPushDownGroupBys

getPushDownOrderBys

hasPushDownAggregate

hasPushDownGroupBy

isDoubleRead

setIsDoubleRead

hasIndex

getPushDownType

getEstimatedCount

setEstimatedCount

init

getIndexScanType

toString

copy

copyReqWithPhysicalId