Feature: SQL result and table export to CSV files:

gerdwagner · gerdwagner · commit 39ab3b149300 · 2024-12-01T20:59:52.000+01:00
New info button behind the CSV radio button informs about the way the export handles
  values containing the separator character, line breaks, double quotes.
diff --git a/sql12/core/doc/changes.txt b/sql12/core/doc/changes.txt
@@ -6,6 +6,10 @@ Not yet released, available in our GIT repository, snapshots and future releases
 
 Enhancements:
 
+SQL result and table export to CSV files:
+  New info button behind the CSV radio button informs about the way the export handles
+  values containing the separator character, line breaks, double quotes.
+
 #433 | Pull request: https://github.com/squirrel-sql-client/squirrel-sql-code/pull/51
   To change the statement separator during SQL execution, use the following command on a separate line:
   --#SET TERMINATOR <separator>
diff --git a/sql12/core/src/net/sourceforge/squirrel_sql/fw/gui/action/fileexport/DataExportCSVWriter.java b/sql12/core/src/net/sourceforge/squirrel_sql/fw/gui/action/fileexport/DataExportCSVWriter.java
@@ -39,8 +39,8 @@
 public class DataExportCSVWriter extends AbstractDataExportFileWriter
 {
 
-   private List<String> headerCells = new ArrayList<String>();
-   private List<String> aRow = new ArrayList<String>();
+   private List<String> headerCells = new ArrayList<>();
+   private List<String> aRow = new ArrayList<>();
    private BufferedWriter bw;
 
 
diff --git a/sql12/core/src/net/sourceforge/squirrel_sql/fw/gui/action/fileexport/ExportDlg.java b/sql12/core/src/net/sourceforge/squirrel_sql/fw/gui/action/fileexport/ExportDlg.java
@@ -144,8 +144,7 @@ private JPanel getExportFormatPanel(boolean enableColoring)
       GridBagConstraints gbc;
 
       gbc = new GridBagConstraints(0, 0, 1, 1, 0, 0, GridBagConstraints.NORTHWEST, GridBagConstraints.NONE, new Insets(0, 0, 0, 5), 0, 0);
-      radFormatCSV = new JRadioButton(s_stringMgr.getString("TableExportCsvDlg.formatCSV"));
-      ret.add(radFormatCSV, gbc);
+      ret.add(createCSVFormatPanel(), gbc);
 
 
       gbc = new GridBagConstraints(0, 1, 1, 1, 0, 0, GridBagConstraints.NORTHWEST, GridBagConstraints.NONE, new Insets(10, 0, 0, 0), 0, 0);
@@ -177,6 +176,22 @@ private JPanel getExportFormatPanel(boolean enableColoring)
       return ret;
    }
 
+   private JPanel createCSVFormatPanel()
+   {
+      JPanel ret = new JPanel(new GridBagLayout());
+
+      GridBagConstraints gbc;
+
+      gbc = new GridBagConstraints(0, 0, 1, 1, 0, 0, GridBagConstraints.WEST, GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0);
+      radFormatCSV = new JRadioButton(s_stringMgr.getString("TableExportCsvDlg.formatCSV"));
+      ret.add(radFormatCSV, gbc);
+
+      gbc = new GridBagConstraints(1, 0, 1, 1, 0, 0, GridBagConstraints.WEST, GridBagConstraints.NONE, new Insets(0, 0, 0, 0), 0, 0);
+      ret.add(new SmallToolTipInfoButton(s_stringMgr.getString("TableExportCsvDlg.formatCSV.info")).getButton(), gbc);
+
+      return ret;
+   }
+
    private JPanel createExcelPanel(boolean enableColoring)
    {
       JPanel ret = new JPanel(new GridBagLayout());
diff --git a/sql12/core/src/net/sourceforge/squirrel_sql/fw/gui/action/fileexport/I18NStrings.properties b/sql12/core/src/net/sourceforge/squirrel_sql/fw/gui/action/fileexport/I18NStrings.properties
@@ -72,6 +72,14 @@ TableExportCsvDlg.formatXLS=Export MS Excel (XLS) file
 TableExportCsvDlg.formatXML=Export XML file
 TableExportCsvDlg.formatJSON=Export JSON file
 
+TableExportCsvDlg.formatCSV.info=<html>If an export value contains\
+  <dl>\
+      <dd>- the separator character,</dd>\
+      <dd>- line breaks,</dd>\
+      <dd>- double quotes, (")</dd>\
+  </dl>\
+  then the value will be enclosed in double quotes, and any double quotes within the value will be duplicated.</html>
+
 TableExportCsvDlg.useGlobalPrefsFormatingExcel=Use formatting as configured in Global Prefs (recommended for MS Excel)
 
 ResultSetExportCommand.errorExecuteStatement=An error was encountered while attempting to build the data set for export. See logs for details.

Original file line number	Diff line number	Diff line change
`@@ -39,8 +39,8 @@`
`39`	`39`	`public class DataExportCSVWriter extends AbstractDataExportFileWriter`
`40`	`40`	`{`
`41`	`41`
`42`		`- private List<String> headerCells = new ArrayList<String>();`
`43`		`- private List<String> aRow = new ArrayList<String>();`
	`42`	`+ private List<String> headerCells = new ArrayList<>();`
	`43`	`+ private List<String> aRow = new ArrayList<>();`
`44`	`44`	`private BufferedWriter bw;`
`45`	`45`
`46`	`46`