hotfix: uncomment regexp_match function docs

pull/4846/head
Scott Anderson 2023-04-03 09:50:28 -06:00
parent 0b5c13f99b
commit 274a6bd68f
1 changed files with 31 additions and 5 deletions

View File

@ -14,17 +14,15 @@ influxdb/cloud-iox/tags: [regular expressions, sql]
The InfluxDB SQL implementation uses the POSIX regular expression syntax and
supports the following regular expression functions:
<!-- - [regexp_match](#regexp_match) -->
- [regexp_match](#regexp_match)
- [regexp_replace](#regexp_replace)
<!--
## regexp_match
Returns a list of regular expression matches in a string.
```sql
regexp_match(str, regexp)
regexp_match(str, regexp, flags)
```
##### Arguments
@ -33,8 +31,36 @@ regexp_match(str, regexp)
Can be a constant, column, or function, and any combination of string operators.
- **regexp**: Regular expression to match against.
Can be a constant, column, or function.
- **flags**: Regular expression flags that control the behavior of the
regular expression. The following flags are supported.
- **i**: (insensitive) Ignore case when matching.
-->
{{< expand-wrapper >}}
{{% expand "View `regexp_replace` query example" %}}
_The following example uses the sample data set provided in
[Get started with InfluxDB tutorial](/influxdb/cloud-iox/get-started/write/#construct-line-protocol)._
{{% note %}}
`regexp_match` returns a _list_ Arrow type, which is not supported by InfluxDB.
Use _bracket notation_ to reference a value in the list.
Lists use 1-based indexing.
{{% /note %}}
```sql
SELECT DISTINCT
room,
regexp_match(room::STRING, '.{3}')[1] AS regexp_match
FROM home
```
| room | regexp_match |
| :---------- | :----------- |
| Kitchen | Kit |
| Living Room | Liv |
{{% /expand %}}
{{< /expand-wrapper >}}
## regexp_replace