Package org.apache.iceberg

Interface SortOrderBuilder<R>

All Known Subinterfaces:
ReplaceSortOrder
All Known Implementing Classes:
BaseReplaceSortOrder, SortOrder.Builder
public interface SortOrderBuilder<R>
Methods for building a sort order.

  • Method Summary

    Modifier and Type
    Method
    Description
    default R
    asc(String name)
    Add a field to the sort by field name, ascending with nulls first.
    default R
    asc(String name, NullOrder nullOrder)
    Add a field to the sort by field name, ascending with the given null order.
    default R
    asc(Term term)
    Add an expression term to the sort, ascending with nulls first.
    R
    asc(Term term, NullOrder nullOrder)
    Add an expression term to the sort, ascending with the given null order.
    default R
    caseSensitive(boolean caseSensitive)
    Set case sensitivity of sort column name resolution.
    default R
    desc(String name)
    Add a field to the sort by field name, descending with nulls first.
    default R
    desc(String name, NullOrder nullOrder)
    Add a field to the sort by field name, descending with the given null order.
    default R
    desc(Term term)
    Add an expression term to the sort, descending with nulls first.
    R
    desc(Term term, NullOrder nullOrder)
    Add an expression term to the sort, descending with the given null order.

  • Method Details

    • asc

      default R asc(String name)
      Add a field to the sort by field name, ascending with nulls first.
      Parameters:
      name - a field name
      Returns:
      this for method chaining

    • asc

      default R asc(String name, NullOrder nullOrder)
      Add a field to the sort by field name, ascending with the given null order.
      Parameters:
      name - a field name
      nullOrder - a null order (first or last)
      Returns:
      this for method chaining

    • asc

      default R asc(Term term)
      Add an expression term to the sort, ascending with nulls first.
      Parameters:
      term - an expression term
      Returns:
      this for method chaining

    • asc

      R asc(Term term, NullOrder nullOrder)
      Add an expression term to the sort, ascending with the given null order.
      Parameters:
      term - an expression term
      nullOrder - a null order (first or last)
      Returns:
      this for method chaining

    • desc

      default R desc(String name)
      Add a field to the sort by field name, descending with nulls first.
      Parameters:
      name - a field name
      Returns:
      this for method chaining

    • desc

      default R desc(String name, NullOrder nullOrder)
      Add a field to the sort by field name, descending with the given null order.
      Parameters:
      name - a field name
      nullOrder - a null order (first or last)
      Returns:
      this for method chaining

    • desc

      default R desc(Term term)
      Add an expression term to the sort, descending with nulls first.
      Parameters:
      term - an expression term
      Returns:
      this for method chaining

    • desc

      R desc(Term term, NullOrder nullOrder)
      Add an expression term to the sort, descending with the given null order.
      Parameters:
      term - an expression term
      nullOrder - a null order (first or last)
      Returns:
      this for method chaining

    • caseSensitive

      default R caseSensitive(boolean caseSensitive)
      Set case sensitivity of sort column name resolution.
      Parameters:
      caseSensitive - when true, column name resolution is case-sensitive
      Returns:
      this for method chaining