Package io.deephaven.configuration

Class CheckpointControl

java.lang.Object

io.deephaven.configuration.CheckpointControl

public final class CheckpointControl
extends Object

Programmatic API to examine and repair the checkpoint records (table.size files) that describe table locations on disk.

This class is the entry point for both command-line tools and query scripts.

Repair inspects every existing location of every selected table. A location that is not a directory, or is an empty directory, should be deleted; a location whose checkpoint record is missing or predates the current version should be regenerated or upgraded. Nothing is modified unless CheckpointControl.RepairOptions.force() is set: by default problems are only reported.

The usual namespace ACL tests are skipped - the only requirement is that the process runs with sufficient filesystem permissions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CheckpointControl.RepairOptions	Configuration for a repair request: the tables to inspect, whether to actually make changes, and a logger.
static final record	CheckpointControl.TableKey	A single table selected by namespace and name.

Method Summary

Modifier and Type	Method	Description
static @NotNull CheckpointRepairResult	repair(@NotNull CheckpointControl.RepairOptions options)	Report on (and, when CheckpointControl.RepairOptions.force() is set, repair) the checkpoint records of every location of every table selected by the given CheckpointControl.RepairOptions.

Methods inherited from class java.lang.Object

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

Method Details

repair

@ScriptApi
@NotNull
public static @NotNull CheckpointRepairResult repair(@NotNull
 @NotNull CheckpointControl.RepairOptions options)

Report on (and, when CheckpointControl.RepairOptions.force() is set, repair) the checkpoint records of every location of every table selected by the given CheckpointControl.RepairOptions.

Parameters:

options - the options describing the tables to inspect and execution details

Returns:

composite result in a new CheckpointRepairResult instance

Throws:

IllegalArgumentException - if a selected namespace or table does not exist, or is not a legal name