Skip to content
This repository has been archived by the owner on Aug 2, 2022. It is now read-only.

ODBC: Add user documentation for using Microsoft Excel on Mac #594

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added sql-odbc/docs/user/img/excel_credentials.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_data_load.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_data_preview_mac.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_export_csv.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_iodbc_auth.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_iodbc_dsn.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_iodbc_test_dsn.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_refresh_mac.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_select_database.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_select_dsn_mac.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added sql-odbc/docs/user/img/excel_table_list.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
89 changes: 89 additions & 0 deletions 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**.

<img src="img/excel_iodbc_dsn.png" width="650">

* Modify connection attributes accordingly.
* Click on **Ok**.
* Click on **Test**.
* Enter credentials if required and Click **Ok**.

<img src="img/excel_iodbc_auth.png" width="250">

* You should get a message as `The connection DSN was tested successfully, and can be used at this time.`

<img src="img/excel_iodbc_test_dsn.png" width="350">

## Load data

* Open blank workbook in Microsoft Excel.
* Click on **Data** > **New Database Query** > **From Database**.

<img src="img/excel_select_database.png" width="400">

* Select **ODFE SQL ODBC DSN**. Click **OK**.

<img src="img/excel_select_dsn_mac.png" width="400">

* Enter credentials if required and click on **OK**.

<img src="img/excel_credentials.png" width="250">

* Select a table from the list.

<img src="img/excel_table_list.png" width="500">

* Edit SQL statement if required and click on **Run**. Data preview will be loaded.

<img src="img/excel_data_preview_mac.png">

* Click on **Return Data**. Select sheet and click OK.

<img src="img/excel_select_worksheet.png" width="400">

* Data will be loaded in the spreadsheet.

<img src="img/excel_data_load.png">

## Refresh Data

To refresh the data click on **Table** > **Refresh**.

<img src="img/excel_refresh_mac.png" width=500>

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)**.

<img src="img/excel_export_csv.png" width="450">

* 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.