Implement HTTP API: SHOW CONFIGS/VARIABLES/CONFIG/VARIABLE, SET CONFI…

…G/VARIABLE (#1207) ### What problem does this PR solve? Implement HTTP API: SHOW CONFIGS/VARIABLES/CONFIG/VARIABLE, SET CONFIG/VARIABLE Issue link:#1180 ### Type of change - [x] New Feature (non-breaking change which adds functionality) - [x] Documentation Update --------- Signed-off-by: Jin Hai <[email protected]>
infiniflow · May 15, 2024 · 25e14ce · 25e14ce
1 parent c6060d2
commit 25e14ce
Show file tree

Hide file tree

Showing 8 changed files with 721 additions and 110 deletions.
diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md
@@ -762,38 +762,6 @@ curl --request GET \
 }
 ```
 
-## Show variable
-
-Get a system variable.
-
-#### Request
-
-```
-curl --request GET \
-     --url localhost:23820/variables/{variable_name} \
-     --header 'accept: application/json'
-```
-
-#### Response
-
-- 200 Success.
-
-```
-{
-    "error_code": 0,
-    "query_count": 30
-}
-```
-
-- 500 Error.
-
-```
-{
-    "error_code": 3027,
-    "error_message": "No variable {variable_name}."
-}
-```
-
 ## Show segments
 
 Show all segments of a specified table.
@@ -986,4 +954,220 @@ curl --request GET \
     "error_code": 3072,
     "error_message": "Block: {block_id} doesn't exist."
 }
+```
+
+## Show variables
+
+Get all global variables.
+
+#### Request
+
+```
+curl --request GET \
+     --url localhost:23820/variables \
+     --header 'accept: application/json'
+```
+
+#### Response
+
+- 200 Success.
+
+```
+{
+    "error_code":0,
+    "active_txn_count":"1",
+    "active_wal_filename":"/var/infinity/wal/wal.log",
+    "buffer_object_count":"6",
+    "buffer_usage":"0B/4.00GB",
+    "current_timestamp":"16774",
+    "delta_log_count":"1",
+    "next_transaction_id":"6",
+    "profile_record_capacity":"128",
+    "query_count":"0",
+    "schedule_policy":"round robin",
+    "session_count":"1",
+    "total_commit_count":"0",
+    "total_rollback_count":"0",
+    "unused_buffer_object":"0"
+}
+```
+
+## Show variable
+
+Get a global variable.
+
+#### Request
+
+```
+curl --request GET \
+     --url localhost:23820/variables/{variable_name} \
+     --header 'accept: application/json'
+```
+
+#### Response
+
+- 200 Success.
+
+```
+{
+    "error_code": 0,
+    "buffer_object_count":"6"
+}
+```
+
+- 500 Error.
+
+```
+{
+    "error_code": 3027,
+    "error_message": "No such system variable {variable_name}."
+}
+```
+
+## Set a variable
+
+Set a variable with value.
+
+#### Request
+
+```
+curl --request POST \
+     --url localhost:23820/variables/{variable_name} \
+     --header 'accept: application/json' \
+     --header 'content-type: application/json' \
+     --data ' { "profile_record_capacity" : 120 } '
+```
+
+#### Response
+
+- 200 Success.
+
+```
+{
+    "error_code": 0
+}
+```
+
+- 500 Error.
+
+```
+{
+    "error_code": 3076,
+    "error_message": "Invalid command: unknown global variable {variable_name}"
+}
+```
+
+## Show configs
+
+Get all configs.
+
+#### Request
+
+```
+curl --request GET \
+     --url localhost:23820/configs \
+     --header 'accept: application/json'
+```
+
+#### Response
+
+- 200 Success.
+
+```
+{
+    "buffer_manager_size":"4294967296",
+    "cleanup_interval":"10",
+    "client_port":"23817",
+    "compact_interval":"10",
+    "connection_pool_size":"256",
+    "cpu_limit":"16",
+    "data_dir":"/var/infinity/data",
+    "delta_checkpoint_interval":"5",
+    "delta_checkpoint_threshold":"67108864",
+    "error_code":0,
+    "full_checkpoint_interval":"30",
+    "http_port":"23820",
+    "log_dir":"/var/infinity/log",
+    "log_file_max_size":"1073741824",
+    "log_file_rotate_count":"8",
+    "log_filename":"infinity.log",
+    "log_level":"Info",
+    "log_to_stdout":"False",
+    "mem_index_capacity":"1048576",
+    "optimize_interval":"10",
+    "postgres_port":"5432",
+    "resource_dir":"/var/infinity/resource",
+    "server_address":"0.0.0.0",
+    "temp_dir":"/var/infinity/tmp",
+    "time_zone":"UTC+8",
+    "version":"0.2.0",
+    "wal_compact_threshold":"1073741824",
+    "wal_dir":"/var/infinity/wal",
+    "wal_flush":"FlushAtOnce"
+}
+```
+
+## Show config
+
+Get a config.
+
+#### Request
+
+```
+curl --request GET \
+     --url localhost:23820/configs/{config_name} \
+     --header 'accept: application/json'
+```
+
+#### Response
+
+- 200 Success.
+
+```
+{
+    "error_code": 0,
+    "version":"0.2.0"
+}
+```
+
+- 500 Error.
+
+```
+{
+    "error_code": 1008,
+    "error_message": "Attempt to get option: {config_name} which doesn't exist."
+}
+```
+
+## Set a config
+
+Set a config with value.
+
+#### Request
+
+```
+curl --request POST \
+     --url localhost:23820/configs/{config_name} \
+     --header 'accept: application/json' \
+     --header 'content-type: application/json' \
+     --data ' { "log_level" : "trace" } '
+```
+
+#### Response
+
+- 200 Success.
+
+```
+{
+    "error_code": 0
+}
+```
+
+- 500 Error.
+
+```
+{
+    "error_code": 3028,
+    "error_message": "log level value range is trace, debug, info, warning, error, critical"
+}
 ```
diff --git a/src/executor/operator/physical_command.cpp b/src/executor/operator/physical_command.cpp
@@ -82,7 +82,7 @@ bool PhysicalCommand::Execute(QueryContext *query_context, OperatorState *operat
                             return true;
                         }
                         case GlobalVariable::kInvalid: {
-                            RecoverableError(Status::InvalidCommand(fmt::format("Unknown global variable: {}", set_command->var_name())));
+                            RecoverableError(Status::InvalidCommand(fmt::format("unknown global variable {}", set_command->var_name())));
                         }
                         default: {
                             RecoverableError(Status::InvalidCommand(fmt::format("Global variable: {} is read-only", set_command->var_name())));
@@ -97,31 +97,37 @@ bool PhysicalCommand::Execute(QueryContext *query_context, OperatorState *operat
                         case GlobalOptionIndex::kLogLevel: {
                             if (set_command->value_str() == "trace") {
                                 SetLogLevel(LogLevel::kTrace);
+                                config->SetLogLevel(LogLevel::kTrace);
                                 return true;
                             }
 
                             if (set_command->value_str() == "debug") {
                                 SetLogLevel(LogLevel::kDebug);
+                                config->SetLogLevel(LogLevel::kDebug);
                                 return true;
                             }
 
                             if (set_command->value_str() == "info") {
                                 SetLogLevel(LogLevel::kInfo);
+                                config->SetLogLevel(LogLevel::kInfo);
                                 return true;
                             }
 
                             if (set_command->value_str() == "warning") {
                                 SetLogLevel(LogLevel::kWarning);
+                                config->SetLogLevel(LogLevel::kWarning);
                                 return true;
                             }
 
                             if (set_command->value_str() == "error") {
                                 SetLogLevel(LogLevel::kError);
+                                config->SetLogLevel(LogLevel::kError);
                                 return true;
                             }
 
                             if (set_command->value_str() == "critical") {
                                 SetLogLevel(LogLevel::kCritical);
+                                config->SetLogLevel(LogLevel::kCritical);
                                 return true;
                             }