diff --git a/bi-connectors/PowerBIConnector/AmazonOpenSearchService.md b/bi-connectors/PowerBIConnector/AmazonOpenSearchService.md index 8f665b9..408e9b0 100644 --- a/bi-connectors/PowerBIConnector/AmazonOpenSearchService.md +++ b/bi-connectors/PowerBIConnector/AmazonOpenSearchService.md @@ -13,8 +13,8 @@ ## Prerequisites * Microsoft Power BI Desktop -* [OpenSearch](https://opensearch.org/docs/latest/opensearch/install/index/) -* [OpenSearch SQL ODBC driver](https://opensearch.org/docs/latest/search-plugins/sql/odbc/) +* [OpenSearch](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) +* [OpenSearch SQL ODBC driver](https://opensearch.org/docs/latest/search-plugins/sql/sql/odbc/) ## Capabilities supported * Import @@ -52,7 +52,7 @@ ## Troubleshooting -* If you get the following error, please install the [OpenSearch SQL ODBC Driver](https://docs-beta.opensearch.org/search-plugins/sql/odbc/). +* If you get the following error, please install the [OpenSearch SQL ODBC Driver](https://opensearch.org/docs/latest/search-plugins/sql/sql/odbc/). @@ -69,11 +69,7 @@ There are known limitations and issues that are tracked by OpenSearch including the items listed below. | Issue | Description | -| ---- | ----------- | -| [Visualizations without numerical columns](https://github.com/opensearch-project/sql/issues/347) | Visualizations is only supported if there is a numerical column included due to a known limitation in OpenSearch regarding subqueries. An exception to this would be visualizations with columns only of type string is supported as well. | +| ----- | ----------- | | [Visualizations with First or Last options selected are not yet supported](https://github.com/opensearch-project/sql/issues/279) | First and Last options generate an sql query that uses MAX and MIN for strings which is not yet supported in OpenSearch | | [Visualizations with aggregate functions selected are not yet supported](https://github.com/opensearch-project/sql/issues/363) | Specifically Minimum, Maximum, Standard deviation, Variance, or Median options are not yet supported. | -| [Basic filtering limitations](https://github.com/opensearch-project/sql/issues/347) | Selecting more than one value is not yet supported when using basic filtering. Due to the issue in the first row of this table, selecting one value for basic filtering when there is no numerical column is not yet supported. | | [Top N filtering limitations](https://opensearch.org/docs/latest/search-plugins/sql/limitation/) | OpenSearch has limitations on subquery which does not yet support the Top N filtering functionality. | -| [Advanced filtering limitations](https://github.com/opensearch-project/sql/issues/308) | `does not contain` and `does not start with` filters for string columns are not yet supported. All advanced filtering for numerical columns are not yet supported except for `is` and `is blank`. All advanced filtering for date and time columns are not yet supported except for `is blank` and `is not blank`. | -| [Relative Date filtering limitations](https://github.com/opensearch-project/sql/issues/364) | Due to a known timestamp issue in OpenSearch, all relative date filtering is not yet supported. | diff --git a/bi-connectors/PowerBIConnector/OpenSearchProject.md b/bi-connectors/PowerBIConnector/OpenSearchProject.md index 7153d56..4e5c489 100644 --- a/bi-connectors/PowerBIConnector/OpenSearchProject.md +++ b/bi-connectors/PowerBIConnector/OpenSearchProject.md @@ -13,8 +13,8 @@ ## Prerequisites * Microsoft Power BI Desktop -* [OpenSearch](https://opensearch.org/docs/latest/opensearch/install/index/) -* [OpenSearch SQL ODBC driver](https://opensearch.org/docs/latest/search-plugins/sql/odbc/) +* [OpenSearch](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) +* [OpenSearch SQL ODBC driver](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) ## Capabilities supported * Import @@ -52,7 +52,7 @@ ## Troubleshooting -* If you get the following error, please install the [OpenSearch SQL ODBC Driver](https://docs-beta.opensearch.org/search-plugins/sql/odbc/). +* If you get the following error, please install the [OpenSearch SQL ODBC Driver](https://opensearch.org/docs/latest/search-plugins/sql/sql/odbc/). @@ -69,11 +69,7 @@ There are known limitations and issues that are tracked by OpenSearch including the items listed below. | Issue | Description | -| ---- | ----------- | -| [Visualizations without numerical columns](https://github.com/opensearch-project/sql/issues/347) | Visualizations is only supported if there is a numerical column included due to a known limitation in OpenSearch regarding subqueries. An exception to this would be visualizations with columns only of type string is supported as well. | +| ----- | ----------- | | [Visualizations with First or Last options selected are not yet supported](https://github.com/opensearch-project/sql/issues/279) | First and Last options generate an sql query that uses MAX and MIN for strings which is not yet supported in OpenSearch | | [Visualizations with aggregate functions selected are not yet supported](https://github.com/opensearch-project/sql/issues/363) | Specifically Minimum, Maximum, Standard deviation, Variance, or Median options are not yet supported. | -| [Basic filtering limitations](https://github.com/opensearch-project/sql/issues/347) | Selecting more than one value is not yet supported when using basic filtering. Due to the issue in the first row of this table, selecting one value for basic filtering when there is no numerical column is not yet supported. | | [Top N filtering limitations](https://opensearch.org/docs/latest/search-plugins/sql/limitation/) | OpenSearch has limitations on subquery which does not yet support the Top N filtering functionality. | -| [Advanced filtering limitations](https://github.com/opensearch-project/sql/issues/308) | `does not contain` and `does not start with` filters for string columns are not yet supported. All advanced filtering for numerical columns are not yet supported except for `is` and `is blank`. All advanced filtering for date and time columns are not yet supported except for `is blank` and `is not blank`. | -| [Relative Date filtering limitations](https://github.com/opensearch-project/sql/issues/364) | Due to a known timestamp issue in OpenSearch, all relative date filtering is not yet supported. | diff --git a/bi-connectors/PowerBIConnector/power_bi_support.md b/bi-connectors/PowerBIConnector/power_bi_support.md index 2c5451a..d4fa7fa 100644 --- a/bi-connectors/PowerBIConnector/power_bi_support.md +++ b/bi-connectors/PowerBIConnector/power_bi_support.md @@ -1,9 +1,9 @@ -# Connecting OpenSearch to Microsoft Power BI Desktop +# Connecting OpenSearch to Microsoft Power BI Desktop ## Prerequisites * Microsoft Power BI Desktop -* [OpenSearch](https://docs-beta.opensearch.org/opensearch/install/index/) -* [OpenSearch SQL ODBC driver](https://docs-beta.opensearch.org/search-plugins/sql/odbc/) +* [OpenSearch](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) +* [OpenSearch SQL ODBC driver](https://opensearch.org/docs/latest/search-plugins/sql/sql/odbc/) * [OpenSearchProject.mez](OpenSearchProject.mez) or [AmazonOpenSearchService.mez](AmazonOpenSearchService.mez) * Optional: [sqlodbc_import.pbids](PBIDSExamples/sqlodbc_import.pbids) to help with repeated connections to the same server @@ -54,7 +54,7 @@ ## Using .PBIDS Files -More info: https://docs.microsoft.com/en-us/power-bi/connect-data/desktop-data-sources#using-pbids-files-to-get-data +More info: https://learn.microsoft.com/en-us/power-bi/connect-data/desktop-data-sources#using-pbids-files-to-get-data Example PBIDS file for OpenSearch: (available here: [sqlodbc_import.pbids](PBIDSExamples/sqlodbc_import.pbids)) ```json @@ -86,7 +86,7 @@ It will take you straight to the **Navigator** window for selecting the tables f ## Troubleshooting -* If you get an following error, please install [OpenSearch SQL ODBC Driver](https://docs-beta.opensearch.org/search-plugins/sql/odbc/). +* If you get an following error, please install [OpenSearch SQL ODBC Driver](https://opensearch.org/docs/latest/search-plugins/sql/sql/odbc/). diff --git a/docs/dev/Pagination.md b/docs/dev/Pagination.md index ff2a862..a793260 100644 --- a/docs/dev/Pagination.md +++ b/docs/dev/Pagination.md @@ -3,7 +3,7 @@ ## Overview OpenSearch ODBC Driver supports forward-only cursor. This document illustrates how the cursor(pagination) is handled in the driver. -For information on how the pagination is supported on OpenSearch server, check [OpenSearch SQL Cursor (Pagination) Support](https://github.com/opensearch-project/sql/blob/main/docs/dev/Pagination.md). +For information on how the pagination is supported on OpenSearch server, check [OpenSearch SQL Cursor (Pagination) Support](https://github.com/opensearch-project/sql/blob/main/docs/dev/Pagination-v2.md). ## Data Flow

@@ -14,7 +14,7 @@ For information on how the pagination is supported on OpenSearch server, check [ * Step 5 will send a request to close cursor whenever the connection is closed. * ODBC Driver will provide an option to define fetch size as a connection parameter. * If fetch size is zero, query will fallback to non-cursor behavior. - * If fetch size is not given then the number of rows per request will be as per server-defined [default fetch size](https://github.com/opensearch-project/sql/blob/main/docs/dev/Pagination.md#42-salient-points). + * If fetch size is not given then the number of rows per request will be as per server-defined default fetch size. * ODBC Driver will send the request to close cursor whenever the connection is closed. ## Detailed Design diff --git a/docs/dev/run_tests.md b/docs/dev/run_tests.md index 6d7dd14..29a82cd 100644 --- a/docs/dev/run_tests.md +++ b/docs/dev/run_tests.md @@ -8,7 +8,7 @@ ### Set up test datasets -Loading a dataset requires an [OpenSearch](https://docs-beta.opensearch.org/opensearch/install/index/) service running with [OpenSearch Dashboards](https://docs-beta.opensearch.org/dashboards/index/). If either of these are missing, please refer to the documentation on how to set them up. +Loading a dataset requires an [OpenSearch](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) service running with [OpenSearch Dashboards](https://opensearch.org/docs/latest/dashboards/). If either of these are missing, please refer to the documentation on how to set them up. Note, if you wish to work with SSL/TLS, you need to configure OpenSearch and OpenSearch Dashboards to support it. See the [build instructions](./BUILD_INSTRUCTIONS.md) for more info. diff --git a/docs/test/excel_connection.md b/docs/test/excel_connection.md index 562ac1c..e80a1cc 100644 --- a/docs/test/excel_connection.md +++ b/docs/test/excel_connection.md @@ -2,7 +2,7 @@ ## Prerequisites * [Download and install](../../README.md) OpenSearch SQL ODBC Driver. -* [Install and configure](https://docs-beta.opensearch.org/opensearch/install/index/) OpenSearch. +* [Install and configure](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) OpenSearch. * Open ODBC Data Source Administrator. Click on **System DSN** > **OpenSearch SQL ODBC DSN** > **Configure**. * Set all connection options & Click on **Test**. Connection test should return `Connection Successful`. diff --git a/docs/user/microsoft_excel_support.md b/docs/user/microsoft_excel_support.md index 1d53c11..7549c25 100644 --- a/docs/user/microsoft_excel_support.md +++ b/docs/user/microsoft_excel_support.md @@ -3,8 +3,8 @@ ## Prerequisites * Microsoft Excel 2016 and higher -* [OpenSearch](https://docs-beta.opensearch.org/opensearch/install/index/) -* [OpenSearch SQL ODBC driver](https://docs-beta.opensearch.org/search-plugins/sql/odbc/) +* [OpenSearch](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) +* [OpenSearch SQL ODBC driver](https://opensearch.org/docs/latest/search-plugins/sql/sql/odbc/) * A preconfigured [User or System DSN](../../README.md) ## Test Successful Connection @@ -70,7 +70,7 @@ Alternately, **Data** > **Refresh** option can also be used to refresh the data. ## Troubleshooting -* If the table has large number of datarows, increase [the keepalive](https://github.com/opensearch-project/sql/blob/main/docs/dev/Pagination.md#opendistrosqlcursorkeep_alive) value accordlingly. +* If the table has large number of datarows, increase [the keepalive](https://github.com/opensearch-project/sql/blob/main/docs/dev/Pagination-v2.md#Cursor-Keep-Alive-Timeout) value accordlingly. * If the table has nested or object type column, you might get an error as below. @@ -82,7 +82,3 @@ In this case, please use advanced options while connecting to the data source. -Also, make sure query doesn't include the name of nested or object type column name. For example, `SELECT products FROM opensearch_dashboards_sample_data_ecommerce` where product is nested type column might have data loss. - -This issue will be resolved when [Object field is missing in SELECT result](https://github.com/opendistro-for-elasticsearch/sql/issues/564) is fixed. - diff --git a/docs/user/microsoft_excel_support_mac.md b/docs/user/microsoft_excel_support_mac.md index 7d0e852..c9288f7 100644 --- a/docs/user/microsoft_excel_support_mac.md +++ b/docs/user/microsoft_excel_support_mac.md @@ -3,8 +3,8 @@ ## Prerequisites * Microsoft Excel 2016 and higher -* [OpenSearch](https://docs-beta.opensearch.org/opensearch/install/index/) -* [OpenSearch SQL ODBC driver](https://docs-beta.opensearch.org/search-plugins/sql/odbc/) +* [OpenSearch](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) +* [OpenSearch SQL ODBC driver](https://opensearch.org/docs/latest/search-plugins/sql/sql/odbc/) * A preconfigured [User or System DSN](mac_configure_dsn.md) ## Test Successful Connection @@ -50,7 +50,6 @@ * Edit SQL statement if required and click on **Run**. Data preview will be loaded. -> **NOTE**: Excel for Mac currently will not show an error if you provide an incorrect query ([Github issue here](https://github.com/opendistro-for-elasticsearch/sql/issues/601)). If no data appears, check your OpenSearch server logs to see if the query failed. @@ -84,7 +83,7 @@ Alternately, **Data** > **Refresh** option can also be used to refresh the data. ## Troubleshooting -* If the table has large number of datarows, increase [the keepalive](https://github.com/opensearch-project/sql/blob/main/docs/dev/Pagination.md#opendistrosqlcursorkeep_alive) value accordlingly. +* If the table has large number of datarows, increase [the keepalive](https://github.com/opensearch-project/sql/blob/main/docs/dev/Pagination-v2.md#Cursor-Keep-Alive-Timeout) value accordlingly. * You might need to remove `;` from SQL statement to load data preview.