You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/pipeline/pipeline-config.md
+51-3Lines changed: 51 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1071,7 +1071,28 @@ GreptimeDB supports the following four types of index for fields:
1071
1071
- `timestamp`: Specifies a column as a timestamp index column.
1072
1072
- `inverted`: Specifies a column to use the inverted index type.
1073
1073
- `fulltext`: Specifies a column to use the fulltext index type. The column must be of string type.
1074
-
- `skipping`: Specifies a column to use the skipping index type. The column must be of string type.
1074
+
- `skipping`: Specifies a column to use the skipping index type.
1075
+
1076
+
The `index` field supports both a shorthand string form and a detailed object form:
1077
+
1078
+
```yaml
1079
+
index: fulltext
1080
+
1081
+
index:
1082
+
type: fulltext
1083
+
options:
1084
+
analyzer: Chinese
1085
+
case_sensitive: true
1086
+
backend: bloom
1087
+
granularity: 2048
1088
+
false_positive_rate: 0.02
1089
+
```
1090
+
1091
+
The shorthand string form remains supported and uses the default index options.
1092
+
In the object form, `type` is required and `options` is optional.
1093
+
Only `fulltext` and `skipping` support `options`.
1094
+
Option names and validation rules are the same as the corresponding SQL index options described in [Data Index](/user-guide/manage-data/data-index.md).
1095
+
Each option value must be a scalar YAML value.
1075
1096
1076
1097
When `index` field is not provided, GreptimeDB doesn't create index on the column.
1077
1098
@@ -1087,11 +1108,38 @@ Specify which field uses the inverted index. Refer to the [Transform Example](#t
1087
1108
1088
1109
#### The Fulltext Index
1089
1110
1090
-
Specify which field will be used for full-text search using `index: fulltext`. This index greatly improves the performance of [log search](/user-guide/logs/fulltext-search.md). Refer to the [Transform Example](#transform-example) below for syntax.
1111
+
Specify which field will be used for full-text search using `index: fulltext`. This index greatly improves the performance of [log search](/user-guide/logs/fulltext-search.md).
1112
+
Use the detailed form when you need to set fulltext index options:
1113
+
1114
+
```yaml
1115
+
- field: message
1116
+
type: string
1117
+
index:
1118
+
type: fulltext
1119
+
options:
1120
+
analyzer: Chinese
1121
+
case_sensitive: true
1122
+
backend: bloom
1123
+
granularity: 2048
1124
+
false_positive_rate: 0.02
1125
+
```
1091
1126
1092
1127
#### The Skipping Index
1093
1128
1094
-
Specify which field uses the skipping index. This index speeds up the query on high cardinality fields but consumes far less storage for building index files. Refer to the [Transform Example](#transform-example) below for syntax.
1129
+
Specify which field uses the skipping index. This index speeds up the query on high cardinality fields but consumes far less storage for building index files.
1130
+
Unlike `fulltext`, `skipping` is not limited to string columns.
1131
+
Use the detailed form when you need to set skipping index options:
0 commit comments