Check against your doze

PostgreSQL

OfficialSigned

Real local Postgres, declared not scripted.

doze/postgres

$ doze add postgres

Newest: 0.2.4 · 2 Nov 2026
Needs: any doze
Runs: Postgres 14 – 18
Platforms: macOS arm64 · Linux arm64 · Linux x86_64
Licence: Apache-2.0
Source: doze-modules

Reference

For release 0.2.4 · the module's own description

Arguments

Set directly in module postgres "…" { }. The database they describe is named after the instance.

Argument	Type	Default	Since	Description
`version`	numberrequired	none	0.2.1	Engine major to run — 14, 15, 16, 17 or 18.
`owner`	string	none	0.2.1	Owner role for the instance's default database.
`encoding`	string	`UTF8`	0.2.1	Character-set encoding for the database.
`locale`	string	none	0.2.1	Locale (LC_COLLATE + LC_CTYPE) for the database.
`lc_collate`	string	none	0.2.1	Collation order, overriding locale.
`lc_ctype`	string	none	0.2.1	Character classification, overriding locale.
`template`	string	none	0.2.1	Template database to create from.
`connection_limit`	number	`-1`	0.2.1	Max concurrent connections to the database.
`is_template`	bool	`false`	0.2.1	Mark the database as a template.
`allow_connections`	bool	`true`	0.2.1	Whether the database accepts connections.
`tablespace`	string	none	0.2.1	Tablespace the database lives in.
`comment`	string	none	0.2.1	COMMENT applied to the database.
`shared_buffers`	string	`16MB`	0.2.1	shared_buffers server setting, e.g. "256MB".
`max_connections`	number	`50`	0.2.1	max_connections server setting.
`fsync`	bool	`false`	0.2.1	fsync server setting (off for the dev tuning profile).
`autovacuum`	bool	`true`	0.2.1	autovacuum server setting.
`extensions`	list(string)	none	0.2.1	Shorthand list of extensions to CREATE (or use extension blocks).Catalog names: coming in postgres 0.3
`settings`	map(string)	none	0.2.1	Arbitrary postgresql.conf settings, applied verbatim.

`role "<name>"`

13 arguments · repeatable

A login role / user, converged on the server. With login = false, a group role to hang grants on.

Argument	Type	Default	Since	Description
`password`	string	none	0.2.1	Login password.
`login`	bool	`true`	0.2.1	Whether the role may log in.
`superuser`	bool	`false`	0.2.1	Grant SUPERUSER.
`createdb`	bool	`false`	0.2.1	Allow creating databases.
`createrole`	bool	`false`	0.2.1	Allow creating other roles.
`replication`	bool	`false`	0.2.1	Allow streaming replication.
`inherit`	bool	`true`	0.2.1	Inherit privileges of member-of roles.
`bypassrls`	bool	`false`	0.2.1	Bypass row-level security.
`connection_limit`	number	`-1`	0.2.1	Per-role connection cap.
`valid_until`	string	none	0.2.1	Password expiry timestamp.
`member_of`	list(string)	none	0.2.1	Roles this role is granted membership in.
`comment`	string	none	0.2.1	COMMENT applied to the role.
`config`	map(string)	none	0.2.1	Per-role ALTER ROLE … SET settings.

`schema "<name>"`

1 argument: owner · repeatable

A schema within the database.

Argument	Type	Default	Since	Description
`owner`	string	none	0.2.1	Role that owns the schema.

`extension "<name>"`

5 arguments · repeatable

A Postgres extension to install (pgvector, postgis, …).

module postgres "postgres" {
  version = 18
  extension "vector" { version = "0.8.7" }
}

Coming in postgres 0.3
Catalog names such as vector are fetched by doze from postgres 0.3. Today a name must ship with Postgres (contrib) or come with a source.

Argument	Type	Default	Since	Description
`version`	string	none	0.2.1	Specific extension version.
`schema`	string	none	0.2.1	Schema to install the extension into.
`source`	string	none	0.2.1	Path to a local extension bundle to install from.
`optional`	bool	`false`	0.2.1	Skip (don't fail) if the extension is unavailable.
`cascade`	bool	`false`	0.2.1	CREATE EXTENSION … CASCADE for dependencies.

`grant "<role>"`

5 arguments · repeatable

A privilege grant to a role. The label is the role that receives it: grant "orders" { privileges = ["ALL"], schema = "orders", objects = "tables" }.

Argument	Type	Default	Since	Description
`privileges`	list(string)required	none	0.2.1	Privileges to grant (SELECT, INSERT, ALL, …).
`database`	string	none	0.2.1	Target database.
`schema`	string	none	0.2.1	Target schema.
`objects`	string	none	0.2.1	Object class the grant applies to (tables, sequences, …).
`with_grant_option`	bool	`false`	0.2.1	Allow the grantee to re-grant.

Fields every module takes

7 from doze itself: port, listen, enabled, count, for_each, after, sleep

doze reads these on every module block, whatever the module: port, listen, enabled, count, for_each, after, sleep. The doze docs describe each.

Since is the module release that added an argument. Every argument here is in 0.2.1, the oldest release in the index (from doze-modules history; releases do not yet record this, so the column is derived). Descriptions and defaults are the module's own (describe.go on main), so this page cannot drift from what doze accepts.