pyarrow.compute.match_substring#

pyarrow.compute.match_substring(strings, /, pattern, *, ignore_case=False, options=None, memory_pool=None)#

Match strings against literal pattern.

For each string in strings, emit true iff it contains a given pattern. Null inputs emit null. The pattern must be given in MatchSubstringOptions. If ignore_case is set, only simple case folding is performed.

Parameters
stringsArray-like or scalar-like

Argument to compute function.

patternstr

Substring pattern to look for inside input values.

ignore_casebool, default False

Whether to perform a case-insensitive match.

optionspyarrow.compute.MatchSubstringOptions, optional

Alternative way of passing options.

memory_poolpyarrow.MemoryPool, optional

If not passed, will allocate memory from the default memory pool.