quasar_postgres/retention

Periodic, bounded PostgreSQL cleanup for terminal Quasar jobs.

Types

Config

opaque </>

pub opaque type Config

Event

</>

pub type Event {
  BatchCompleted(
    status: String,
    requested: Int,
    deleted: Int,
    duration_ms: Int,
  )
  BatchFailed(status: String, reason: pog.QueryError)
  CycleCompleted(deleted: Int)
}

Constructors

BatchCompleted(
  status: String,
  requested: Int,
  deleted: Int,
  duration_ms: Int,
)

BatchFailed(status: String, reason: pog.QueryError)

```
CycleCompleted(deleted: Int)
```

Runtime

opaque </>

pub opaque type Runtime

StartError

</>

pub type StartError {
  InvalidConfig
  ActorStart(actor.StartError)
}

Constructors

```
InvalidConfig
```
```
ActorStart(actor.StartError)
```

Values

new

</>

pub fn new(
  connection: pog.Connection,
  policy: retention.Policy,
) -> Config

Builds a conservative cleanup configuration.

Defaults: 1,000 rows per batch, 100 ms between batches, and one cycle per minute. Disabled policy states are never touched.

start

</>

pub fn start(config: Config) -> Result(Runtime, StartError)

Starts a linked retention worker. Stop it before closing the Pog pool.

stop

</>

pub fn stop(runtime: Runtime) -> Nil

with_batch_size

</>

pub fn with_batch_size(config: Config, rows rows: Int) -> Config

with_interval

</>

pub fn with_interval(
  config: Config,
  milliseconds milliseconds: Int,
) -> Config

with_pause

</>

pub fn with_pause(
  config: Config,
  milliseconds milliseconds: Int,
) -> Config

with_reporter

</>

pub fn with_reporter(
  config: Config,
  report: fn(Event) -> Nil,
) -> Config