pgrls
Configuration for pgrls, the Postgres Row-Level Security linter (pgrls.toml)
pgrls.toml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
pgrls.toml and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
extends | oneOf | Path, or list of paths, to base pgrls.toml file(s) merged beneath this one. Later list entries and this file's own keys take precedence. |
database | object | Database connection and scan scope. |
database.url | string | Postgres connection string. $VAR and ${VAR} are interpolated from the environment. Prefer leaving this unset and passing --database-url (or $DATABASE_URL) at runtime so secrets stay out of version control. |
database.schemas | array<string> | Schemas to lint. default: ["public"] |
lint | object | Lint behavior. |
lint.fail_on | string | — one of: "error", "warning", "info" |
lint.disable | array<string> | Rule IDs to disable entirely (case-insensitive), e.g. ["SEC022", "PERF002"]. |
lint.rules | object | Per-rule settings, keyed by rule ID — e.g. a [lint.rules.SEC001] table. |
diff | object | Behavior of `pgrls diff`. |
diff.fail_on | string | Change classification at or above which `pgrls diff` exits non-zero. default: "dangerous"one of: "safe", "breaking", "requires-review", "dangerous" |
Audit
What we found in this schema
- Declared draft: 2020-12
- 12 properties, 100% carrying a description, max nesting depth 6.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$defs | JSON Schema Core, draft 2020-12 | §8.2.4 — Schema Re-Use With "$defs" |
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
additionalProperties | JSON Schema Core, draft 2020-12 | §10.3.2.3 — "additionalProperties" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
oneOf | JSON Schema Core, draft 2020-12 | §10.2.1.3 — "oneOf" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.