feat: Query result display escaped newline (#187)

Co-authored-by: sundyli <543950155@qq.com>

Author: b41sh

README.md

@@ -115,6 +115,7 @@ prompt = ":) "
 | `output_format` | The output format to use. |
 | `time` | Whether to show the time elapsed when executing queries. |
 | `multi_line` | Whether to allow multi-line input. |
+| `replace_newline` | whether replace '\n' with '\\\n'. |
 
 
 ## Control commands in REPL

bindings/nodejs/src/lib.rs

@@ -220,12 +220,7 @@ impl Row {
     #[napi]
     pub fn values(&self) -> Vec<Value> {
         // FIXME: do not clone
-        self.0
-            .values()
-            .to_owned()
-            .into_iter()
-            .map(|v| Value(v))
-            .collect()
+        self.0.values().iter().map(|v| Value(v.clone())).collect()
     }
 }
 

cli/src/config.rs

@@ -37,6 +37,7 @@ pub struct SettingsConfig {
     pub progress_color: Option<String>,
     pub show_progress: Option<bool>,
     pub show_stats: Option<bool>,
+    pub replace_newline: Option<bool>,
 }
 
 #[derive(Clone, Debug)]
@@ -67,6 +68,8 @@ pub struct Settings {
 
     /// Multi line mode, default is true.
     pub multi_line: bool,
+    /// whether replace '\n' with '\\n', default true.
+    pub replace_newline: bool,
 }
 
 #[derive(ValueEnum, Clone, Debug, PartialEq, Deserialize)]
@@ -94,6 +97,9 @@ impl Settings {
         if let Some(show_stats) = cfg.show_stats {
             self.show_stats = show_stats;
         }
+        if let Some(replace_newline) = cfg.replace_newline {
+            self.replace_newline = replace_newline;
+        }
     }
 
     pub fn inject_ctrl_cmd(&mut self, cmd_name: &str, cmd_value: &str) -> Result<()> {
@@ -117,6 +123,7 @@ impl Settings {
             "max_display_rows" => self.max_display_rows = cmd_value.parse()?,
             "max_width" => self.max_width = cmd_value.parse()?,
             "max_col_width" => self.max_col_width = cmd_value.parse()?,
+            "replace_newline" => self.replace_newline = cmd_value.parse()?,
             _ => return Err(anyhow!("Unknown command: {}", cmd_name)),
         }
         Ok(())
@@ -169,6 +176,7 @@ impl Default for Settings {
             show_stats: false,
             time: false,
             multi_line: true,
+            replace_newline: true,
         }
     }
 }

cli/src/display.rs

@@ -44,7 +44,8 @@ pub struct FormatDisplay<'a> {
     settings: &'a Settings,
     query: &'a str,
     kind: QueryKind,
-    // whether replace '\n' with '\\n', only disable in explain/show create stmts
+    // whether replace '\n' with '\\n',
+    // disable in explain/show create stmts or user config setting false
     replace_newline: bool,
     schema: SchemaRef,
     data: RowProgressIterator,
@@ -67,10 +68,10 @@ impl<'a> FormatDisplay<'a> {
         Self {
             settings,
             query,
+            kind: QueryKind::from(query),
             replace_newline,
             schema,
             data,
-            kind: QueryKind::from(query),
             rows: 0,
             progress: None,
             start,
@@ -397,7 +398,7 @@ fn create_table(
     schema: SchemaRef,
     results: &[Row],
     replace_newline: bool,
-    mut max_rows: usize,
+    max_rows: usize,
     mut max_width: usize,
     max_col_width: usize,
 ) -> Result<Table> {
@@ -417,15 +418,12 @@ fn create_table(
         }
     }
 
-    if !replace_newline {
-        max_width = usize::MAX;
-        max_rows = usize::MAX;
-    }
-
     let row_count: usize = results.len();
     let mut rows_to_render = row_count.min(max_rows);
-
-    if row_count <= max_rows + 3 {
+    if !replace_newline {
+        max_width = usize::MAX;
+        rows_to_render = row_count;
+    } else if row_count <= max_rows + 3 {
         // hiding rows adds 3 extra rows
         // so hiding rows makes no sense if we are only slightly over the limit
         // if we are 1 row over the limit hiding rows will actually increase the number of lines we display!

cli/src/helper.rs

@@ -192,6 +192,10 @@ impl KeyWordCompleter {
                 }),
         );
 
-        (pos - hint.len(), results)
+        if pos >= hint.len() {
+            (pos - hint.len(), results)
+        } else {
+            (0, results)
+        }
     }
 }

cli/src/session.rs

@@ -317,7 +317,11 @@ impl Session {
                 Ok(false)
             }
             _ => {
-                let replace_newline = replace_newline_in_box_display(query);
+                let replace_newline = !if self.settings.replace_newline {
+                    false
+                } else {
+                    replace_newline_in_box_display(query)
+                };
                 let (schema, data) = self.conn.query_iter_ext(query).await?;
                 let mut displayer = FormatDisplay::new(
                     &self.settings,