Expand description
Doctor command — systematic diagnostic checks for common FraiseQL setup problems.
Usage: fraiseql doctor fraiseql doctor –config fraiseql.toml –schema schema.compiled.json fraiseql doctor –json
Structs§
- Doctor
Check - A single diagnostic check result.
Enums§
- Check
Status - Outcome of a single diagnostic check.
Functions§
- check_
database_ url_ set - Check whether
DATABASE_URLis set in the environment. - check_
db_ reachable - Attempt a TCP connection to the database host:port extracted from the URL.
- check_
jwt_ secret - Check whether
FRAISEQL_JWT_SECRETis set. - check_
redis_ reachable - Check Redis if
REDIS_URLis set. - check_
rls_ cache_ coherence - Cross-check: warn if caching is enabled without any authorization policy.
- check_
schema_ exists - Check that the compiled schema file exists and is readable.
- check_
schema_ parses - Check that the compiled schema file is valid JSON.
- check_
schema_ version - Check the schema format version field.
- check_
tls - Check TLS: if the TOML config enables TLS, the cert file must exist.
- check_
toml_ exists - Check whether
fraiseql.tomlexists. - check_
toml_ parses - Parse
fraiseql.toml. Only called when the file actually exists. - print_
json_ report - Print the doctor report as JSON to stdout.
- print_
text_ report - Print the doctor report in text format to stdout.
- run
- Execute the doctor command.
- run_
checks - Run all doctor checks and return the list of results.