§ Reference · Commands

pravo schema

Print the CUE definition of a resource, data source, ephemeral resource or function type, with the provider's documentation.

View as Markdown

On this page

Quick reference


Synopsis	`pravo schema TYPE [TYPE...] [--required]`
Changes infrastructure	No. It starts no provider after `pravo init`.
Provider	The prefix of the type up to the first underscore (`random_pet` is in `random`), or `provider/type` with the local name of the provider. The provider must be declared in the root.
Taught in	B1, Providers and resources.

Flags

Flag	Default	Meaning
`--required`	off	Show only the attributes that must be set, and the blocks that contain one.
`-t`, `--tag key=value`, `-T`	none	Tags, as for `pravo plan`.

The global flags apply. With --json, the output is one object that maps each argument to its definition as a string.

Exit codes

Code	Meaning
0	Every definition was printed.
6	The specification does not load or evaluate, no provider is declared for the type, or the provider has no such type.

Examples

Work in an empty directory named demo.

main.cue

package demo

import rnd "pravo.dev/providers/hashicorp/random"

$random: rnd.#Provider

Only what must be set

terminal

$pravo init > /dev/null

$pravo schema random_integer --required

// resource random_integer, from hashicorp/random
// Use it with:
//
//	import <alias> "pravo.dev/providers/hashicorp/random"
//
//	<provider>: <alias>.#Provider
//	<name>:     <provider>.#Resource.random_integer & {...}
//
// The definition:
// The resource `random_integer` generates random values from a given range, described by the `min` and `max` attributes of a given resource.
//
// This resource can be used in conjunction with resources that have the `create_before_destroy` lifecycle flag set, to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently.
random_integer: {
	// Identity: pravo treats a struct that carries these as a resource.
	$kind:   "resource"
	$type:   "random_integer"
	$source: "registry.opentofu.org/hashicorp/random"
	// The address the record had before this resource was written here. Moves
	// the record to this address at the next plan.
	$from?: __string
	// The id of an existing object to bring under management, as the provider
	// understands it. Read at the next plan; leave it in place afterwards.
	$import?: __string
	// Additional dependencies, as references to other resources.
	$depends_on?: [..._]
	$lifecycle?: #Lifecycle
	// The maximum inclusive value of the range.
	max: number
	// The minimum inclusive value of the range.
	min: number
}

The output starts with a usage hint. It shows the shape, with the placeholders <alias>, <provider> and <name>. It is not meant to be pasted as it stands. The definition follows, with the documentation of the provider as comments.

The whole definition

terminal

$pravo schema random_pet

// resource random_pet, from hashicorp/random
// Use it with:
//
//	import <alias> "pravo.dev/providers/hashicorp/random"
//
//	<provider>: <alias>.#Provider
//	<name>:     <provider>.#Resource.random_pet & {...}
//
// The definition:
// The resource `random_pet` generates random pet names that are intended to be used as unique identifiers for other resources.
//
// This resource can be used in conjunction with resources that have the `create_before_destroy` lifecycle flag set, to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently.
random_pet: {
	// Identity: pravo treats a struct that carries these as a resource.
	$kind:   "resource"
	$type:   "random_pet"
	$source: "registry.opentofu.org/hashicorp/random"
	// The address the record had before this resource was written here. Moves
	// the record to this address at the next plan.
	$from?: __string
	// The id of an existing object to bring under management, as the provider
	// understands it. Read at the next plan; leave it in place afterwards.
	$import?: __string
	// Additional dependencies, as references to other resources.
	$depends_on?: [..._]
	$lifecycle?: #Lifecycle
	// The random pet name.
	id: __string | null
	// Arbitrary map of values that, when changed, will trigger recreation of resource. See [the main provider documentation](../index.html) for more information.
	keepers?: {[string]: __string}
	// The length (in words) of the pet name. Defaults to 2
	length: __number | null
	// A string to prefix the name with.
	prefix?: __string
	// The character to separate words in the pet name. Defaults to "-"
	separator: __string | null
}

In the definition	Meaning
`$kind`, `$type`, `$source`	The identity fields. A struct that carries them is a resource of that type.
`$from`, `$import`, `$depends_on`, `$lifecycle`	The meta fields that every resource accepts.
`name: type`	A required attribute.
`name?: type`	An optional attribute.
`name: type \| null`	A computed attribute, or an optional one that has a default.

Several types, and the other form

Each argument is printed in turn. provider/type names the provider by its local name:

terminal

$pravo schema random/random_pet random_integer | grep '^// resource'

// resource random_pet, from hashicorp/random
// resource random_integer, from hashicorp/random

Types that do not resolve

terminalexit 6

$pravo schema aws_s3_bucket

Error: no provider "aws" for type aws_s3_bucket; declare a provider struct for it, or write provider/type

terminalexit 6

$pravo schema random_nope

Error: the provider has no type "random_nope"

When a name is both a resource and a data source, schema prints the resource. pravo providers schema NAME prints the whole provider package, with #Resource, #Data, #Ephemeral and #Function.

JSON

With --json, the keys are the arguments and the values are the definitions as strings.

terminal

$pravo schema random_integer random_pet --json | grep -o '^ "[a-z_]*"'

  "random_integer"
  "random_pet"