← All recipes
Open source

Replace TOML table row

Recipe IDorg.openrewrite.toml.ReplaceTableRow
Artifactorg.openrewrite:rewrite-toml

Replace a TOML table row with new content. If a row with the same identifying property exists, replace it entirely.

Single recipeApache 2.0

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.toml.ReplaceTableRow --recipe-option "tableName=package.contributors" --recipe-option "row=name = "Alice Smith"\nemail = "alice@example.com"" --recipe-option "identifyingKey=name"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-toml:8.88.0

Options

NameTypeDescription
tableNamerequiredStringThe name of the TOML array table to replace rows in (e.g., 'package.contributors').
e.g. package.contributors
rowrequiredStringThe TOML key-value pairs to replace with. Should contain the objectIdentifyingProperty.
e.g. name = "Alice Smith"\nemail = "alice@example.com"
identifyingKeyrequiredStringThe property name used to match existing rows. When a row with this property value exists, it will be replaced; otherwise, a new row will not be inserted (see MergeTableRow).
e.g. name

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats