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/en/developer/built_in_function_develop_guide.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -129,7 +129,7 @@ C++ built-in functions can use limited data types, including BOOL, Numeric, Stri
129
129
- Operator `new` operator or method `malloc` are forbidden in C++ built-in function implementation.
130
130
- In C++ built-in aggregate functions, it is permissible to use the `new` or `malloc` functions to allocate memory during initialization. However, it is crucial to ensure that the allocated space is released when the `output` generates the final result.
131
131
- Developers must call provided memory management APIs in order to archive space allocation for UDF output parameters:
132
-
-`hybridse::udf::v1::AllocManagedStringBuf(size)` to allocate space. OpenMLDB `ByteMemoryPool` will assign continous space to the function and will release it when safe.
132
+
-`hybridse::udf::v1::AllocManagedStringBuf(size)` to allocate space. OpenMLDB `ByteMemoryPool` will assign continuous space to the function and will release it when safe.
133
133
- If allocated size < 0, allocation will fail. `AllocManagedStringBuf` return null pointer.
134
134
- If allocated size exceed the MAX_ALLOC_SIZE which is 2048, the allocation will fail. `AllocManagedStringBuf` return null pointer.
135
135
-`hybridse::udf::v1::AllocManagedArray(ArrayRef<T>*, uint64_t)`: allocate space for array types
@@ -346,9 +346,9 @@ RegisterExternal("substring")
346
346
@endcode
347
347
348
348
@param str
349
-
@param pos: define the begining of the substring.
349
+
@param pos: define the beginning of the substring.
350
350
351
-
- If `pos` is positive, the begining of the substring is `pos` charactors from the start of string.
351
+
- If `pos` is positive, the beginning of the substring is `pos` characters from the start of string.
352
352
- If `pos` is negative, the beginning of the substring is `pos` characters from the end of the string, rather than the beginning.
353
353
354
354
@param len length of substring. If len is less than 1, the result is the empty string.
@@ -440,7 +440,7 @@ namespace hybridse {
440
440
}
441
441
```
442
442
443
-
Configure and register function into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
443
+
Configure and register function into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
444
444
445
445
```c++
446
446
# hybridse/src/udf/default_udf_library.cc
@@ -483,7 +483,7 @@ namespace hybridse {
483
483
}
484
484
```
485
485
486
-
Configure and register the function into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc). Note that if the function needs to return through parameter, `return_by_arg(true)` needs to be configured.
486
+
Configure and register the function into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc). Note that if the function needs to return through parameter, `return_by_arg(true)` needs to be configured.
487
487
488
488
```c++
489
489
# hybridse/src/udf/default_udf_library.cc
@@ -531,7 +531,7 @@ namespace hybridse {
531
531
}
532
532
```
533
533
534
-
Configure and register the function into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
534
+
Configure and register the function into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
535
535
536
536
```c++
537
537
# hybridse/src/udf/default_udf_library.cc
@@ -584,12 +584,12 @@ namespace hybridse {
584
584
}
585
585
```
586
586
587
-
Configure and register the function into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
587
+
Configure and register the function into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
#### Step 2: Register C++ Function to Default Library
640
640
641
-
Configure and register `month()` into `DefaultUdfLibary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
641
+
Configure and register `month()` into `DefaultUdfLibrary` in[hybridse/src/udf/default_udf_library.cc](https://github.com/4paradigm/OpenMLDB/blob/main/hybridse/src/udf/default_udf_library.cc):
Note, for `-c/--cluster`, the format is`<zk_cluster>/<zk_root_path>`, by default is `127.0.0.1:2181/openmldb`. If a different OpenMLDB cluster is used, please specify this parameter. Other settings are different as respect to each sub-command, you can use `-h` to check the detailed documentation.
19
19
@@ -57,7 +57,7 @@ Server:
57
57
58
58
Table:
59
59
{all healthy | unhealthy tables desc}
60
-
[]Fatal/Warn table, {read/write may fail or still work}, {repair immediatly or not}
60
+
[]Fatal/Warn table, {read/write may fail or still work}, {repair immediately or not}
61
61
{partition detail: if leader healthy, if has unhealthy replicas, if offset too large, related ops}
62
62
63
63
Make sure all servers online, and no ops for the table is running.
@@ -84,11 +84,11 @@ The `status` command is used to view the status of the OpenMLDB cluster, includi
84
84
85
85
```
86
86
openmldb_tool status -h
87
-
usage: openmldb_tool status [-h] [--helpfull] [--diff]
87
+
usage: openmldb_tool status [-h] [--helpful] [--diff]
88
88
89
89
optional arguments:
90
90
-h, --help show this help message and exit
91
-
--helpfull show full help message and exit
91
+
--helpful show full help message and exit
92
92
--diff check if all endpoints in conf are in cluster. If set, need to set `-f,--conf_file`
93
93
--conn check network connection of all servers
94
94
```
@@ -125,7 +125,7 @@ If you want to check the cluster status, it is recommended to use the one-click
@@ -291,4 +291,4 @@ You should input json like this, ignore round brackets in the key and double quo
291
291
292
292
## Additional Information
293
293
294
-
You can use `openmldb_tool --helpfull` to view all configuration options. For example, `--sdk_log` can print SDK logs (zk, glog) for debugging purposes.
294
+
You can use `openmldb_tool --helpful` to view all configuration options. For example, `--sdk_log` can print SDK logs (zk, glog) for debugging purposes.
Copy file name to clipboardExpand all lines: docs/en/maintain/monitoring.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ scrape_configs:
33
33
```
34
34
For complete configuration, refer to [openmldb_mixin/prometheus_example.yml](https://github.com/4paradigm/openmldb-exporter/blob/main/openmldb_mixin/prometheus_example.yml).
@@ -30,11 +30,11 @@ Here is the impact when update the configuration of tablet:
30
30
* If the table is multi-replica, we will migrate the leader partitions in the tablet to be updating to other tablets, and migrate back after the upgrade. If there is write traffic during the update, there may be data loss.
31
31
32
32
Steps for updating are as follows:
33
-
* Backup configuation
33
+
* Backup configuration
34
34
```bash
35
35
cp conf/tablet.flags conf/tablet.flags.bak
36
36
```
37
-
* Update configuation
37
+
* Update configuration
38
38
*`pre-upgrade`: to reduce the interruption to the online service before the restart (refer to [Operation Tool](./openmldb_ops.md))
0 commit comments