ak.str.match_substring
----------------------

.. py:module: ak.str.match_substring

Defined in `awkward.operations.str.akstr_match_substring <https://github.com/scikit-hep/awkward/blob/ecb41df1a0678f2c38387f6f91203f0122fd0906/src/awkward/operations/str/akstr_match_substring.py>`__ on `line 13 <https://github.com/scikit-hep/awkward/blob/ecb41df1a0678f2c38387f6f91203f0122fd0906/src/awkward/operations/str/akstr_match_substring.py#L13>`__.

.. py:function:: ak.str.match_substring(array, pattern, *, ignore_case=False, highlevel=True, behavior=None, attrs=None)


    :param array: Array-like data (anything :py:obj:`ak.to_layout` recognizes).
    :param pattern: Substring pattern to look for inside ``array``.
    :type pattern: str or bytes
    :param ignore_case: If True, perform a case-insensitive match;
                    otherwise, the match is case-sensitive.
    :type ignore_case: bool
    :param highlevel: If True, return an :py:obj:`ak.Array`; otherwise, return
                  a low-level :py:obj:`ak.contents.Content` subclass.
    :type highlevel: bool
    :param behavior: Custom :py:obj:`ak.behavior` for the output array, if
                 high-level.
    :type behavior: None or dict
    :param attrs: Custom attributes for the output array, if
              high-level.
    :type attrs: None or dict

For each string in the array, determine whether it contains the given
literal ``pattern``.

Note: this function does not raise an error if the ``array`` does not
contain any string or bytestring data.

Requires the pyarrow library and calls
`pyarrow.compute.match_substring <https://arrow.apache.org/docs/python/generated/pyarrow.compute.match_substring.html>`__.

See also: :py:obj:`ak.str.match_substring_regex`.