From c54a89b47a2d22f075fa59d3e90635c4c824d28a Mon Sep 17 00:00:00 2001 From: wade zhang <95411902+gccgdb1234@users.noreply.github.com> Date: Wed, 25 Sep 2024 09:01:38 +0800 Subject: [PATCH] Update 99-parser-plugin.md --- docs/zh/06-advanced/05-data-in/99-parser-plugin.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/zh/06-advanced/05-data-in/99-parser-plugin.md b/docs/zh/06-advanced/05-data-in/99-parser-plugin.md index 7138fc28be..976a5e2c04 100644 --- a/docs/zh/06-advanced/05-data-in/99-parser-plugin.md +++ b/docs/zh/06-advanced/05-data-in/99-parser-plugin.md @@ -3,7 +3,7 @@ title: "数据解析插件" sidebar_label: "数据解析插件" --- -接入消息中间时,如果使用 json/regex 等模式解析器无法满足解析需求,同时 UDT 也无法满足性能需求的情况,可以自定义数据解析插件。 +接入消息中间件时,如果使用 json/regex 等模式解析器无法满足解析需求,同时使用 UDT(自定义解析器) 也无法满足性能需求的情况,可以自定义数据解析插件。 ## 插件概述 @@ -27,4 +27,4 @@ taosX Parser 插件是一个要求用 C/Rust 语言开发的 C ABI 兼容动态 | const char* parser_version() | 版本,方便定位问题。 | 无 | 字符串 | | struct parser_resp_t {
char* e; // Error if null.
void* p; // Success if contains.
}
parser_resp_t parser_new(char* ctx, uint32_t len); | 使用用户自定义配置生成解析器对象或返回错误信息。| char* ctx: 用户自定义配置字符串。
uint32_t len: 该字符串的二进制长度(不含 `\0`)。 | 返回值为结构体。
struct parser_resp_t {
char* e; // Error if null.
void* p; // Success if contains.
}
当创建对象失败时,第一个指针 e 不为 NULL。
当创建成功时,e 为 NULL,p 为解析器对象。 | | const char* parser_mutate(
void* parser,
const uint8_t* in_ptr, uint32_t in_len,
const void* uint8_t* out_ptr, uint32_t* out_len
) | 使用解析器对象对输入 payload 进行解析,返回结果为 JSON 格式 [u8] 。
返回的 JSON 将使用默认的 JSON 解析器进行完全解码(展开根数组和所有的对象)。 | void* parser: parser_new 生成的对象指针。
const uint8_t* in_ptr, uint32_t in_len:输入 Payload 的指针和 bytes 长度(不含 `\0`)。
const void* uint8_t* out_ptr, uint32_t * out_len:输出 JSON 字符串的指针和长度(不含 `\0`)。当 out_ptr 指向为空时,表示输出为空。当 out_ptr 不为空时,应用(taosx)在使用完毕后应当释放该内存空间。| 字符串指针。
当调用成功时,返回值为 NULL。
当调用失败时,返回错误信息字符串。 | -| void parser_free(void* parser); | 释放解析器对象内存。 | void* parser: parser_new 生成的对象指针。 | 无。 | \ No newline at end of file +| void parser_free(void* parser); | 释放解析器对象内存。 | void* parser: parser_new 生成的对象指针。 | 无。 |