schema

• ResourceSchemaChange
• SchemaDiffResult
• schema_diff_cmd
• schema_show_cmd

Symbol Details

class: ResourceSchemaChange

• source

  Since: 0.4.0

class ResourceSchemaChange(BaseModel):
    resource_type: str
    path: str
    kind: Literal[added, removed, changed]
    tags: list[str] = ...

Field	Type	Default	Since
resource_type	str	-	0.4.0
path	str	-	0.4.0
kind	Literal[added, removed, changed]	-	0.4.0
tags	list[str]	...	0.4.0

Changes

Version	Change
0.4.0	Made public

class: SchemaDiffResult

• source

  Since: 0.4.0

class SchemaDiffResult(BaseModel):
    format_version: int = 1
    from_label: str
    to_label: str
    resources_added: list[str] = ...
    resources_removed: list[str] = ...
    changes: list[ResourceSchemaChange] = ...

Field	Type	Default	Since
format_version	int	1	0.4.0
from_label	str	-	0.4.0
to_label	str	-	0.4.0
resources_added	list[str]	...	0.4.0
resources_removed	list[str]	...	0.4.0
changes	list[ResourceSchemaChange]	...	0.4.0

Changes

Version	Change
0.4.0	Made public

cli_command: schema_diff_cmd

• source

  Since: 0.4.0

def schema_diff_cmd(*, provider: str = ..., source: str | None = None, from_constraint: str | None = None, to_constraint: str | None = None, resource: str | None = None, path_parts: list[str] = [], no_cache: bool = False, as_json: bool = False, output: Path | None = None) -> None:
    ...

Compare resource schemas for two version constraints or for registry vs local dev plugin.

Examples: tfdo schema diff --provider mongodbatlas --from 1.18.0 --to 1.19.0 tfdo schema diff --provider aws --source hashicorp/aws --from 5.0.0 --to 5.1.0 --json tfdo schema diff --provider mongodbatlas --from 1.18.0 tfdo schema diff --provider mongodbatlas --from 1.18.0 --to dev tfdo schema diff --provider mongodbatlas --to 1.19.0 tfdo schema diff --provider mongodbatlas --from 1.18.0 --to 1.19.0 --resource mongodbatlas_cluster --path region

CLI Options:

Flag	Type	Default	Description
--provider	str	required	required_providers local name (e.g. mongodbatlas)
--source	str | None	None	Registry source namespace/type (optional when tfdo has a built-in default for --provider)
--from	str | None	None	Version constraint or literal 'dev'; omit when --to is a version to compare dev plugin to that version
--to	str | None	None	Version constraint or literal 'dev'; omit when --from is a version to compare that version to dev plugin
--resource	str | None	None	Single resource type to diff (same semantics as schema show)
--path	list[str]	[]	Limit attribute/block detail rows to this path or descendants (repeatable); does not filter resource add/remove lists
--no-cache	bool	False	Skip schema cache read and write
--json	bool	False	Print JSON to stdout
--output, -o	Path | None	None	Write JSON here instead of stdout (requires --json)

Changes

Version	Change
0.4.0	Made public

cli_command: schema_show_cmd

• source

  Since: 0.4.0

def schema_show_cmd(*, provider: str = ..., source: str | None = None, version: str = '>= 1.0', resource: str | None = None, no_cache: bool = False, as_json: bool = False, output: Path | None = None) -> None:
    ...

CLI Options:

Flag	Type	Default	Description
--provider	str	required	required_providers local name (e.g. mongodbatlas)
--source	str | None	None	Registry source namespace/type (optional when tfdo has a built-in default for --provider)
--version	str	'>= 1.0'	required_providers version constraint
--resource	str | None	None	Resource type; omit to list types for the provider
--no-cache	bool	False	Skip schema cache read and write
--json	bool	False	Print JSON to stdout
--output, -o	Path | None	None	Write JSON here instead of stdout (requires --json)

Changes

Version	Change
0.4.0	Made public