.. _auto_string_replace:

*STRING REPLACE*
================

Performs a simple find-and-replace on a scalar string value. Provide the source string, the substring to search for, and the replacement substring; the worker returns the modified string. Use it in workflows wherever dynamic text substitution is needed (e.g. path construction, label formatting, keyword patching).

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

Classification: **process**.

Tagged: ``replace``, ``scalar``, ``search``, ``string``, ``substitution``, ``text``, ``transform``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - String
     - str
     - scalar
     - —
     - ✓
     - The source scalar string on which the find-and-replace operation will be performed.
   * - Search
     - search
     - scalar
     - —
     - ✓
     - The substring to search for within the source string; every occurrence will be replaced.
   * - Replace
     - replace
     - scalar
     - —
     - ✓
     - The replacement substring that will be substituted wherever the search string is found; use an empty string to effectively delete the search term.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - string_search_output_1
     - string_search_output_1
     - scalar
     - The resulting scalar string after all occurrences of the search substring have been replaced with the replacement value.

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

- data.dataset.transform

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=string_replace <https://www.d3view.com/api/workflow/example?id=string_replace>`_

.. raw:: html

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