Package org.apache.iceberg

Class BaseReplaceSortOrder

java.lang.Object

org.apache.iceberg.BaseReplaceSortOrder

All Implemented Interfaces:

PendingUpdate<SortOrder>, ReplaceSortOrder, SortOrderBuilder<ReplaceSortOrder>

public class BaseReplaceSortOrder
extends java.lang.Object
implements ReplaceSortOrder

Method Summary

Modifier and Type	Method	Description
SortOrder	apply()	Apply the pending changes and return the uncommitted changes for validation.
ReplaceSortOrder	asc(Term term, NullOrder nullOrder)	Add an expression term to the sort, ascending with the given null order.
ReplaceSortOrder	caseSensitive(boolean caseSensitive)	Set case sensitivity of sort column name resolution.
void	commit()	Apply the pending changes and commit.
ReplaceSortOrder	desc(Term term, NullOrder nullOrder)	Add an expression term to the sort, descending with the given null order.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.iceberg.PendingUpdate

updateEvent

Methods inherited from interface org.apache.iceberg.SortOrderBuilder

asc, asc, asc, desc, desc, desc

Method Detail

apply

public SortOrder apply()

Description copied from interface: PendingUpdate

Apply the pending changes and return the uncommitted changes for validation.

This does not result in a permanent update.

Specified by:

apply in interface PendingUpdate<SortOrder>

Returns:

the uncommitted changes that would be committed by calling PendingUpdate.commit()

commit

public void commit()

Description copied from interface: PendingUpdate

Apply the pending changes and commit.

Changes are committed by calling the underlying table's commit method.

Once the commit is successful, the updated table will be refreshed.

Specified by:

commit in interface PendingUpdate<SortOrder>

asc

public ReplaceSortOrder asc(Term term,
                            NullOrder nullOrder)

Description copied from interface: SortOrderBuilder

Add an expression term to the sort, ascending with the given null order.

Specified by:

asc in interface SortOrderBuilder<ReplaceSortOrder>

Parameters:

term - an expression term

nullOrder - a null order (first or last)

Returns:

this for method chaining

desc

public ReplaceSortOrder desc(Term term,
                             NullOrder nullOrder)

Description copied from interface: SortOrderBuilder

Add an expression term to the sort, descending with the given null order.

Specified by:

desc in interface SortOrderBuilder<ReplaceSortOrder>

Parameters:

term - an expression term

nullOrder - a null order (first or last)

Returns:

this for method chaining

caseSensitive

public ReplaceSortOrder caseSensitive(boolean caseSensitive)

Description copied from interface: SortOrderBuilder

Set case sensitivity of sort column name resolution.

Specified by:

caseSensitive in interface SortOrderBuilder<ReplaceSortOrder>

Parameters:

caseSensitive - when true, column name resolution is case-sensitive

Returns:

this for method chaining