CheckResultinterfaceno test imports itinterface CheckResultThe result of one check.
| Member | Type | What it is |
|---|---|---|
id | string | |
title | string | |
status | Status | |
detail | string | |
next? | string | What to do, where there is something. |
arcactl doctor (commons data 0046-arcactl): a read-only look at a PostgreSQL database against the arca models a configuration names. Each check says pass, warn, fail or that it could not check (a check that lacks a privilege never passes by default), what it found, and what to do. It writes nothing: the only statement that is not a SELECT sets the session's search path.
CheckResultinterfaceno test imports itinterface CheckResultThe result of one check.
| Member | Type | What it is |
|---|---|---|
id | string | |
title | string | |
status | Status | |
detail | string | |
next? | string | What to do, where there is something. |
checkIdsconstconst checkIds: readonly string[]The checks, by id.
doctorfunctionfunction doctor(driver: Driver, config: Arca, schema: LogicalSchema, options?: { readonly secrets?: readonly string[] | undefined; readonly only?: readonly string[] | undefined; }): Promise<Report>Runs the checks.
| Parameter | What it is |
|---|---|
driver | the database |
config | the configuration, with defaults |
schema | the logical schema of the models |
options | the secrets to keep out of what is said, and the checks to run (all by default) |
Returns: the report
renderReportfunctionno test imports itfunction renderReport(r: Report): stringThe report as text.