org.apache.hudi.common.table.timeline

Class CompletionTimeQueryView

java.lang.Object

org.apache.hudi.common.table.timeline.CompletionTimeQueryView

All Implemented Interfaces:

Serializable, AutoCloseable

public class CompletionTimeQueryView
extends Object
implements AutoCloseable, Serializable

Query view for instant completion time.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompletionTimeQueryView(HoodieTableMetaClient metaClient) The constructor.
CompletionTimeQueryView(HoodieTableMetaClient metaClient, String eagerLoadInstant) The constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
Option<String>	getCompletionTime(String beginTime) Queries the instant completion time with given start time.
Option<String>	getCompletionTime(String baseInstant, String instantTime) Get completion time with a base instant time as a reference to fix the compatibility.
String	getCursorInstant()
List<String>	getStartTimes(HoodieTimeline timeline, Option<String> rangeStart, Option<String> rangeEnd, InstantRange.RangeType rangeType) Queries the instant start time with given completion time range.
List<String>	getStartTimes(HoodieTimeline timeline, Option<String> rangeStart, Option<String> rangeEnd, InstantRange.RangeType rangeType, Function<String,String> earliestInstantTimeFunc) Queries the instant start time with given completion time range.
List<String>	getStartTimes(String rangeStart, String rangeEnd, Function<String,String> earliestInstantTimeFunc) Queries the instant start time with given completion time range.
boolean	isArchived(String instantTime) Returns whether the instant is archived.
boolean	isCompleted(String beginInstantTime) Returns whether the instant is completed.
boolean	isCompletedBefore(String baseInstant, String instantTime) Returns whether the give instant time instantTime completed before the base instant baseInstant.
boolean	isEmptyTable()
boolean	isSlicedAfterOrOn(String baseInstant, String instantTime) Returns whether the given instant time instantTime is sliced after or on the base instant baseInstant.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompletionTimeQueryView

public CompletionTimeQueryView(HoodieTableMetaClient metaClient)

The constructor.

Parameters:

metaClient - The table meta client.

CompletionTimeQueryView

public CompletionTimeQueryView(HoodieTableMetaClient metaClient,
                               String eagerLoadInstant)

The constructor.

Parameters:

metaClient - The table meta client.

eagerLoadInstant - The earliest instant time to eagerly load from, by default load last N days of completed instants.

Method Detail

isCompleted

public boolean isCompleted(String beginInstantTime)

Returns whether the instant is completed.

isArchived

public boolean isArchived(String instantTime)

Returns whether the instant is archived.

isCompletedBefore

public boolean isCompletedBefore(String baseInstant,
                                 String instantTime)

Returns whether the give instant time instantTime completed before the base instant baseInstant.

isSlicedAfterOrOn

public boolean isSlicedAfterOrOn(String baseInstant,
                                 String instantTime)

Returns whether the given instant time instantTime is sliced after or on the base instant baseInstant.

getCompletionTime

public Option<String> getCompletionTime(String baseInstant,
                                        String instantTime)

Get completion time with a base instant time as a reference to fix the compatibility.

Parameters:

baseInstant - The base instant

instantTime - The instant time to query the completion time with

Returns:

Probability fixed completion time.

getCompletionTime

public Option<String> getCompletionTime(String beginTime)

Queries the instant completion time with given start time.

Parameters:

beginTime - The start time.

Returns:

The completion time if the instant finished or empty if it is still pending.

getStartTimes

public List<String> getStartTimes(HoodieTimeline timeline,
                                  Option<String> rangeStart,
                                  Option<String> rangeEnd,
                                  InstantRange.RangeType rangeType)

Queries the instant start time with given completion time range.

By default, assumes there is at most 1 day time of duration for an instant to accelerate the queries.

Parameters:

timeline - The timeline.

rangeStart - The query range start completion time.

rangeEnd - The query range end completion time.

rangeType - The range type.

Returns:

The sorted instant time list.

getStartTimes

public List<String> getStartTimes(String rangeStart,
                                  String rangeEnd,
                                  Function<String,String> earliestInstantTimeFunc)

Queries the instant start time with given completion time range.

Parameters:

rangeStart - The query range start completion time.

rangeEnd - The query range end completion time.

earliestInstantTimeFunc - The function to generate the earliest start time boundary with the minimum completion time.

Returns:

The sorted instant time list.

getStartTimes

public List<String> getStartTimes(HoodieTimeline timeline,
                                  Option<String> rangeStart,
                                  Option<String> rangeEnd,
                                  InstantRange.RangeType rangeType,
                                  Function<String,String> earliestInstantTimeFunc)

Queries the instant start time with given completion time range.

Parameters:

timeline - The timeline.

rangeStart - The query range start completion time.

rangeEnd - The query range end completion time.

rangeType - The range type.

earliestInstantTimeFunc - The function to generate the earliest start time boundary with the minimum completion time.

Returns:

The sorted instant time list.

getCursorInstant

public String getCursorInstant()

isEmptyTable

public boolean isEmptyTable()

close

public void close()

Specified by:

close in interface AutoCloseable