.. _auto_text_replace:

*REPLACE PATTERNS OF TEXT*
==========================

Performs regex-based find-and-replace on a source text string. Supply a regular-expression search pattern and a replacement string to transform the input text; the substituted result is returned as a new text value.

When to use
-----------

Classification: **process**.

Tagged: ``find_replace``, ``pattern``, ``regex``, ``replace``, ``string``, ``text``, ``transform``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Source Text
     - text
     - text
     - —
     - 
     - The source text to be searched and modified; accepts any plain-text string or multi-line block.
   * - Pattern
     - search
     - string
     - —
     - 
     - Regular-expression pattern to locate within the source text (e.g. '\\bfoo\\b' to match the whole word 'foo'); leave empty to skip substitution.
   * - Replace
     - replace
     - string
     - —
     - 
     - Replacement string to substitute wherever the search pattern matches; may include regex back-references (e.g. '$1'); leave empty to delete matched substrings.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - text_replace_output_1
     - text_replace_output_1
     - text
     - The resulting text after all regex pattern matches in the source have been replaced with the supplied replacement string.

Disciplines
-----------

- data.dataset.transform

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>text_replace</code>. Schema hash: <code>9a671ca7e351</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>