diff --git a/python/datafusion/functions/__init__.py b/python/datafusion/functions/__init__.py index 291957490..bfa71379f 100644 --- a/python/datafusion/functions/__init__.py +++ b/python/datafusion/functions/__init__.py @@ -1761,6 +1761,11 @@ def regexp_like( Tests a string using a regular expression returning true if at least one match, false otherwise. + Args: + string: Data to test against the regular expression. + regex: Regular expression to search for. + flags: Flags to control regex behavior. + Examples: >>> ctx = dfn.SessionContext() >>> df = ctx.from_pydict({"a": ["hello123"]}) @@ -1797,6 +1802,11 @@ def regexp_match( Returns an array with each element containing the leftmost-first match of the corresponding index in ``regex`` to string in ``string``. + Args: + string: Data to match against the regular expression. + regex: Regular expression to search for. + flags: Flags to control regex behavior. + Examples: >>> ctx = dfn.SessionContext() >>> df = ctx.from_pydict({"a": ["hello 42 world"]}) @@ -1839,6 +1849,13 @@ def regexp_replace( Supported flags with the addition of 'g' can be found at + Args: + string: Data to search for the regular expression match. + pattern: Regular expression to search for. + replacement: Text substituted for each match. + flags: Flags to control regex behavior. Add ``g`` to replace every + match rather than only the first. + Examples: >>> ctx = dfn.SessionContext() >>> df = ctx.from_pydict({"a": ["hello 42"]}) @@ -1885,6 +1902,12 @@ def regexp_count( Optional start position (the first position is 1) to search for the regular expression. + Args: + string: Data to search for the regular expression match. + pattern: Regular expression to search for. + start: Position to start the search (the first position is 1). + flags: Flags to control regex behavior. + Examples: >>> ctx = dfn.SessionContext() >>> df = ctx.from_pydict({"a": ["abcabc"]}) @@ -1929,10 +1952,10 @@ def regexp_instr( Args: values: Data to search for the regular expression match. regex: Regular expression to search for. - start: Optional position to start the search (the first position is 1). - n: Optional occurrence of the match to find (the first occurrence is 1). - flags: Optional regular expression flags to control regex behavior. - sub_expr: Optionally capture group position instead of the entire match. + start: Position to start the search (the first position is 1). + n: Occurrence of the match to find (the first occurrence is 1). + flags: Flags to control regex behavior. + sub_expr: Capture group position instead of the entire match. Examples: >>> ctx = dfn.SessionContext()