[doc](auditlog) update description of field sql_digest (#28340)

apache · Dec 13, 2023 · 524bce3 · 524bce3
1 parent 4f58214
commit 524bce3
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/en/docs/ecosystem/audit-plugin.md b/docs/en/docs/ecosystem/audit-plugin.md
@@ -100,7 +100,7 @@ create table doris_audit_db__.doris_audit_log_tbl__
     frontend_ip varchar(32) comment "Frontend ip of executing this statement",
     cpu_time_ms bigint comment "Total scan cpu time in millisecond of this query",
     sql_hash varchar(48) comment "Hash value for this query",
-    sql_digest varchar(48) comment "Sql digest for this query",
+    sql_digest varchar(48) comment "Sql digest of this query, will be empty if not a slow query",
     peak_memory_bytes bigint comment "Peak memory bytes used on all backends of this query",
     stmt string comment "The original statement, trimed if longer than 2G"
 ) engine=OLAP
@@ -136,7 +136,7 @@ create table doris_audit_db__.doris_slow_log_tbl__
     frontend_ip varchar(32) comment "Frontend ip of executing this statement",
     cpu_time_ms bigint comment "Total scan cpu time in millisecond of this query",
     sql_hash varchar(48) comment "Hash value for this query",
-    sql_digest varchar(48) comment "Sql digest for this query",
+    sql_digest varchar(48) comment "Sql digest of a slow query",
     peak_memory_bytes bigint comment "Peak memory bytes used on all backends of this query",
     stmt string comment "The original statement, trimed if longer than 2G "
 ) engine=OLAP

diff --git a/docs/zh-CN/docs/ecosystem/audit-plugin.md b/docs/zh-CN/docs/ecosystem/audit-plugin.md
@@ -106,7 +106,7 @@ create table doris_audit_db__.doris_audit_log_tbl__
     frontend_ip varchar(32) comment "Frontend ip of executing this statement",
     cpu_time_ms bigint comment "Total scan cpu time in millisecond of this query",
     sql_hash varchar(48) comment "Hash value for this query",
-    sql_digest varchar(48) comment "Sql digest for this query",
+    sql_digest varchar(48) comment "Sql digest of this query, will be empty if not a slow query",
     peak_memory_bytes bigint comment "Peak memory bytes used on all backends of this query",
     stmt string comment "The original statement, trimed if longer than 2G"
 ) engine=OLAP
@@ -142,7 +142,7 @@ create table doris_audit_db__.doris_slow_log_tbl__
     frontend_ip varchar(32) comment "Frontend ip of executing this statement",
     cpu_time_ms bigint comment "Total scan cpu time in millisecond of this query",
     sql_hash varchar(48) comment "Hash value for this query",
-    sql_digest varchar(48) comment "Sql digest for this query",
+    sql_digest varchar(48) comment "Sql digest of a slow query",
     peak_memory_bytes bigint comment "Peak memory bytes used on all backends of this query",
     stmt string comment "The original statement, trimed if longer than 2G "
 ) engine=OLAP

diff --git a/pytest/deploy/start.py b/pytest/deploy/start.py
@@ -192,7 +192,7 @@ def add_auditload_plugin():
               frontend_ip varchar(32) comment 'Frontend ip of executing this statement', \
               cpu_time_ms bigint comment 'Total scan cpu time in millisecond of this query', \
               sql_hash varchar(48) comment 'Hash value for this query', \
-              sql_digest varchar(48) comment 'Sql digest for this query', \
+              sql_digest varchar(48) comment 'Sql digest of this query, will be empty if not a slow query', \
               peak_memory_bytes bigint comment 'Peak memory bytes used on all backends of this query', \
               stmt string comment 'The original statement, trimed if longer than 2G ' \
           ) engine=OLAP \