Project¶

project.yaml at the root of a project: the database-wide settings, and the objects that belong to the database rather than to a schema.

Properties¶

Property	Type	Required	Description
`name`	`string`	yes	The name of the database that is saved in the build artifact when generating a dump.
`encoding`	`string`	—	The database encoding to use. Default: `"UTF8"`.
`stdstrings`	`boolean`	—	Turn standard confirming strings on/off in the created build artifact. Default: `true`.
`superuser`	`string`	—	The PostgreSQL super user. Default: `"postgres"`.
`extensions`	array of `object`	—	An array of PostgreSQL extensions to load into the database.
`foreign_data_wrappers`	array of foreign_data_wrapper	—	An array of Foreign Data Wrappers to create in the database.
`languages`	array of `object`	—	An array of Procedural Languages to load into the database.

Property	Type	Required	Description
`name`	`string`	yes	The name of the extension to be installed. PostgreSQL will create the extension using details from the file SHAREDIR/extension/extension_name.control.
`schema`	`string`	—	The name of the schema in which to install the extension's objects, given that the extension allows its contents to be relocated.
`version`	`string`	—	The version of the extension to install. This can be written as either an identifier or a string literal. The default version is whatever is specified in the extension's control file.
`cascade`	`boolean`	—	Automatically install any extensions that this extension depends on that are not already installed. Default: `false`.
`comment`	`string`	—	An optional comment about the extension.

Property	Type	Required	Description
`name`	`string`	yes	The name of the language to load.
`comment`	`string`	—	An optional comment about the language.
`trusted`	`boolean`	—	Specifies if the language grants access to data that the user would not otherwise have access to. Default: `false`.
`replace`	`boolean`	—	Use CREATE or REPLACE syntax. Default: `false`.
`handler`	`string`	—	Specifies the name of a previously registered function that will be called to execute the procedural language's functions.
`inline_handler`	`string`	—	Specifies the name of a previously registered function that will be called to execute an anonymous code block (DO command) in this language.
`validator`	`string`	—	Specifies the name of a previously registered function that will be called when a new function in the language is created, to validate the new function.

No other properties are accepted.