diff --git a/sql-odbc/docs/user/img/excel_credentials.png b/sql-odbc/docs/user/img/excel_credentials.png new file mode 100644 index 0000000000..ad52f7d8fe Binary files /dev/null and b/sql-odbc/docs/user/img/excel_credentials.png differ diff --git a/sql-odbc/docs/user/img/excel_data_load.png b/sql-odbc/docs/user/img/excel_data_load.png new file mode 100644 index 0000000000..f794aaa2de Binary files /dev/null and b/sql-odbc/docs/user/img/excel_data_load.png differ diff --git a/sql-odbc/docs/user/img/excel_data_preview_mac.png b/sql-odbc/docs/user/img/excel_data_preview_mac.png new file mode 100644 index 0000000000..7d822dee93 Binary files /dev/null and b/sql-odbc/docs/user/img/excel_data_preview_mac.png differ diff --git a/sql-odbc/docs/user/img/excel_export_csv.png b/sql-odbc/docs/user/img/excel_export_csv.png new file mode 100644 index 0000000000..2fa3afa89b Binary files /dev/null and b/sql-odbc/docs/user/img/excel_export_csv.png differ diff --git a/sql-odbc/docs/user/img/excel_iodbc_auth.png b/sql-odbc/docs/user/img/excel_iodbc_auth.png new file mode 100644 index 0000000000..a7d5a65400 Binary files /dev/null and b/sql-odbc/docs/user/img/excel_iodbc_auth.png differ diff --git a/sql-odbc/docs/user/img/excel_iodbc_dsn.png b/sql-odbc/docs/user/img/excel_iodbc_dsn.png new file mode 100644 index 0000000000..d175005f1c Binary files /dev/null and b/sql-odbc/docs/user/img/excel_iodbc_dsn.png differ diff --git a/sql-odbc/docs/user/img/excel_iodbc_test_dsn.png b/sql-odbc/docs/user/img/excel_iodbc_test_dsn.png new file mode 100644 index 0000000000..557f11aea5 Binary files /dev/null and b/sql-odbc/docs/user/img/excel_iodbc_test_dsn.png differ diff --git a/sql-odbc/docs/user/img/excel_refresh_mac.png b/sql-odbc/docs/user/img/excel_refresh_mac.png new file mode 100644 index 0000000000..d8b3aa8f9e Binary files /dev/null and b/sql-odbc/docs/user/img/excel_refresh_mac.png differ diff --git a/sql-odbc/docs/user/img/excel_select_database.png b/sql-odbc/docs/user/img/excel_select_database.png new file mode 100644 index 0000000000..59e886c8fb Binary files /dev/null and b/sql-odbc/docs/user/img/excel_select_database.png differ diff --git a/sql-odbc/docs/user/img/excel_select_dsn_mac.png b/sql-odbc/docs/user/img/excel_select_dsn_mac.png new file mode 100644 index 0000000000..0cb22f2b34 Binary files /dev/null and b/sql-odbc/docs/user/img/excel_select_dsn_mac.png differ diff --git a/sql-odbc/docs/user/img/excel_select_worksheet.png b/sql-odbc/docs/user/img/excel_select_worksheet.png new file mode 100644 index 0000000000..825cbecbfd Binary files /dev/null and b/sql-odbc/docs/user/img/excel_select_worksheet.png differ diff --git a/sql-odbc/docs/user/img/excel_table_list.png b/sql-odbc/docs/user/img/excel_table_list.png new file mode 100644 index 0000000000..cbd01583b7 Binary files /dev/null and b/sql-odbc/docs/user/img/excel_table_list.png differ diff --git a/sql-odbc/docs/user/microsoft_excel_support_mac.md b/sql-odbc/docs/user/microsoft_excel_support_mac.md new file mode 100644 index 0000000000..ba21fbd8e7 --- /dev/null +++ b/sql-odbc/docs/user/microsoft_excel_support_mac.md @@ -0,0 +1,89 @@ +# Micosoft Excel on Mac OS + +## Prerequisites + +* Microsoft Excel 2016 and higher +* [Open Distro for Elasticsearch](https://opendistro.github.io/for-elasticsearch-docs/docs/install/) +* [Open Distro for Elasticsearch SQL ODBC driver](https://opendistro.github.io/for-elasticsearch-docs/docs/sql/odbc/) +* A preconfigured [User or System DSN](mac_configure_dsn.md) + +## Test Successful Connection + +* Open **iODBC Data Source Administrator** using command + +`sudo /Applications/iODBC/iODBC\ Administrator64.app/Contents/MacOS/iODBC\ Administrator64` + +* Click on **System DSN**. +* Select **ODFE SQL ODBC DSN**. +* Click on **Configure**. + + + +* Modify connection attributes accordingly. +* Click on **Ok**. +* Click on **Test**. +* Enter credentials if required and Click **Ok**. + + + +* You should get a message as `The connection DSN was tested successfully, and can be used at this time.` + + + +## Load data + +* Open blank workbook in Microsoft Excel. +* Click on **Data** > **New Database Query** > **From Database**. + + + +* Select **ODFE SQL ODBC DSN**. Click **OK**. + + + +* Enter credentials if required and click on **OK**. + + + +* Select a table from the list. + + + +* Edit SQL statement if required and click on **Run**. Data preview will be loaded. + + + +* Click on **Return Data**. Select sheet and click OK. + + + +* Data will be loaded in the spreadsheet. + + + +## Refresh Data + +To refresh the data click on **Table** > **Refresh**. + + + +Alternately, **Data** > **Refresh** option can also be used to refresh the data. + +## Export as CSV files + +* Click on **File** > **Save As**. +* Type the file name. +* Select Location to Save file. +* Set File Format to **CSV UTF-8(Comma delimited)(*.csv)**. + + + +* Click **Save**. +* Data will be exported to selected location in CSV format. + +## Troubleshooting + +* If the table has large number of datarows, increase [the keepalive](https://github.com/opendistro-for-elasticsearch/sql/blob/master/docs/dev/Pagination.md#opendistrosqlcursorkeep_alive) value accordlingly. + +* You might need to remove `;` from SQL statement to load data preview. +