Constructor Detail

• AlterTableOptions

  public AlterTableOptions()

Method Detail

• renameTable

  public AlterTableOptions renameTable(String newName)

  Change a table's name.

  Parameters:

  newName - new table's name, must be used to check progress

  Returns:

  this instance

• addColumn

  public AlterTableOptions addColumn(String name,
                            Type type,
                            Object defaultVal)

  Add a new column that's not nullable.

  Parameters:

  name - name of the new column

  type - type of the new column

  defaultVal - default value used for the currently existing rows

  Returns:

  this instance

• addNullableColumn

  public AlterTableOptions addNullableColumn(String name,
                                    Type type)

  Add a new column that's nullable, thus has no default value.

  Parameters:

  name - name of the new column

  type - type of the new column

  Returns:

  this instance

• dropColumn

  public AlterTableOptions dropColumn(String name)

  Drop a column.

  Parameters:

  name - name of the column

  Returns:

  this instance

• renameColumn

  public AlterTableOptions renameColumn(String oldName,
                               String newName)

  Change the name of a column.

  Parameters:

  oldName - old column's name, must exist

  newName - new name to use

  Returns:

  this instance

• addRangePartition

  public AlterTableOptions addRangePartition(PartialRow lowerBound,
                                    PartialRow upperBound)

  Add a range partition to the table with an inclusive lower bound and an exclusive upper bound. If either row is empty, then that end of the range will be unbounded. If a range column is missing a value, the logical minimum value for that column type will be used as the default. Multiple range partitions may be added as part of a single alter table transaction by calling this method multiple times. Added range partitions must not overlap with each other or any existing range partitions (unless the existing range partitions are dropped as part of the alter transaction first). The lower bound must be less than the upper bound. This client will immediately be able to write and scan the new tablets when the alter table operation returns success, however other existing clients may have to wait for a timeout period to elapse before the tablets become visible. This period is configured by the master's 'table_locations_ttl_ms' flag, and defaults to one hour.

  Parameters:

  lowerBound - inclusive lower bound, may be empty but not null

  upperBound - exclusive upper bound, may be empty but not null

  Returns:

  this instance

• addRangePartition

  public AlterTableOptions addRangePartition(PartialRow lowerBound,
                                    PartialRow upperBound,
                                    RangePartitionBound lowerBoundType,
                                    RangePartitionBound upperBoundType)

  Add a range partition to the table with a lower bound and upper bound. If either row is empty, then that end of the range will be unbounded. If a range column is missing a value, the logical minimum value for that column type will be used as the default. Multiple range partitions may be added as part of a single alter table transaction by calling this method multiple times. Added range partitions must not overlap with each other or any existing range partitions (unless the existing range partitions are dropped as part of the alter transaction first). The lower bound must be less than the upper bound. This client will immediately be able to write and scan the new tablets when the alter table operation returns success, however other existing clients may have to wait for a timeout period to elapse before the tablets become visible. This period is configured by the master's 'table_locations_ttl_ms' flag, and defaults to one hour.

  Parameters:

  lowerBound - lower bound, may be empty but not null

  upperBound - upper bound, may be empty but not null

  lowerBoundType - the type of the lower bound, either inclusive or exclusive

  upperBoundType - the type of the upper bound, either inclusive or exclusive

  Returns:

  this instance

• dropRangePartition

  public AlterTableOptions dropRangePartition(PartialRow lowerBound,
                                     PartialRow upperBound)

  Drop the range partition from the table with the specified inclusive lower bound and exclusive upper bound. The bounds must match exactly, and may not span multiple range partitions. If either row is empty, then that end of the range will be unbounded. If a range column is missing a value, the logical minimum value for that column type will be used as the default. Multiple range partitions may be dropped as part of a single alter table transaction by calling this method multiple times.

  Parameters:

  lowerBound - inclusive lower bound, can be empty but not null

  upperBound - exclusive upper bound, can be empty but not null

  Returns:

  this instance

• dropRangePartition

  public AlterTableOptions dropRangePartition(PartialRow lowerBound,
                                     PartialRow upperBound,
                                     RangePartitionBound lowerBoundType,
                                     RangePartitionBound upperBoundType)

  Drop the range partition from the table with the specified lower bound and upper bound. The bounds must match exactly, and may not span multiple range partitions. If either row is empty, then that end of the range will be unbounded. If a range column is missing a value, the logical minimum value for that column type will be used as the default. Multiple range partitions may be dropped as part of a single alter table transaction by calling this method multiple times.

  Parameters:

  lowerBound - inclusive lower bound, can be empty but not null

  upperBound - exclusive upper bound, can be empty but not null

  lowerBoundType - the type of the lower bound, either inclusive or exclusive

  upperBoundType - the type of the upper bound, either inclusive or exclusive

  Returns:

  this instance