.. _auto_string_match:

*STRING MATCHES WITH*
=====================

Checks whether a needle string (treated as a regex pattern) exists within a haystack string and returns the match result. Use this worker whenever a workflow needs a simple string-search or pattern-match decision step.

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

Classification: **process**.

Tagged: ``match``, ``pattern``, ``regex``, ``scalar``, ``search``, ``string``, ``transformation``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Haystack
     - haystack
     - scalar
     - —
     - ✓
     - The source string to search within; provide any plain-text or serialized scalar value that should be inspected for the pattern.
   * - Needle
     - needle
     - scalar
     - —
     - ✓
     - The pattern (interpreted as a regex) to search for inside the haystack; e.g. 'error' or '[0-9]+' — no surrounding slashes needed, they are added automatically.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - string_match_output_1
     - string_match_output_1
     - scalar
     - The result of the regex match operation — typically the matched substring or a truthy/falsy scalar indicating whether the needle pattern was found in the haystack.

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

- platform.workflow

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

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

.. 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_match</code>. Schema hash: <code>5b63b7c9d37a</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>