From 6c8ac1859b4eeb2d231c8e96801d06f85c869df0 Mon Sep 17 00:00:00 2001 From: Chen Dai Date: Fri, 23 Apr 2021 10:53:26 -0700 Subject: [PATCH] Rename driver and DSN name to OpenSearch SQL ODBC Signed-off-by: Chen Dai --- docs/user/general/comments.rst | 2 +- docs/user/general/datatypes.rst | 174 +++++++++--------- docs/user/general/values.rst | 2 +- sql-odbc/docs/dev/BUILD_INSTRUCTIONS.md | 2 +- sql-odbc/docs/dev/run_tests.md | 2 +- sql-odbc/docs/test/data_connection_wizard.md | 2 +- sql-odbc/docs/test/excel_connection.md | 2 +- .../docs/test/microsoft_query_connection.md | 2 +- .../docs/test/odbc_data_source_connection.md | 2 +- sql-odbc/docs/test/query_wizard_connection.md | 2 +- sql-odbc/docs/user/mac_configure_dsn.md | 6 +- sql-odbc/docs/user/microsoft_excel_support.md | 4 +- .../docs/user/microsoft_excel_support_mac.md | 4 +- sql-odbc/docs/user/windows_configure_dsn.md | 4 +- sql-odbc/src/DSNInstaller/dsn_installer.cpp | 4 +- .../OdfeSqlOdbcPBIConnector.pq | 4 +- .../odfe_sql_odbc/connectionResolver.tdr | 2 +- .../odfe_sql_odbc_dev/connectionResolver.tdr | 2 +- sql-odbc/src/installer/Resources/README.txt | 4 +- .../src/installer/Resources/odfe_sql_odbc.tdc | 2 +- sql-odbc/src/installer/patch.xml | 12 +- 21 files changed, 120 insertions(+), 120 deletions(-) diff --git a/docs/user/general/comments.rst b/docs/user/general/comments.rst index ccbea946d7..86a6e43abc 100644 --- a/docs/user/general/comments.rst +++ b/docs/user/general/comments.rst @@ -13,7 +13,7 @@ Comments Overview ======== -ODFE SQL supports ANSI SQL and MySQL style comments, including single-line comments or block comments across multiple lines. Both can be used on separate line(s) or within a SQL statement if needed. +OpenSearch SQL supports ANSI SQL and MySQL style comments, including single-line comments or block comments across multiple lines. Both can be used on separate line(s) or within a SQL statement if needed. Single-line Comments diff --git a/docs/user/general/datatypes.rst b/docs/user/general/datatypes.rst index 9372dcef19..f8fc7aae61 100644 --- a/docs/user/general/datatypes.rst +++ b/docs/user/general/datatypes.rst @@ -13,97 +13,97 @@ Data Types Overview ======== -ODFE SQL Data Types -------------------- - -The ODFE SQL Engine support the following data types. - -+---------------+ -| ODFE SQL Type | -+===============+ -| boolean | -+---------------+ -| byte | -+---------------+ -| short | -+---------------+ -| integer | -+---------------+ -| long | -+---------------+ -| float | -+---------------+ -| double | -+---------------+ -| string | -+---------------+ -| text | -+---------------+ -| timestamp | -+---------------+ -| datetime | -+---------------+ -| date | -+---------------+ -| time | -+---------------+ -| interval | -+---------------+ -| ip | -+---------------+ -| geo_point | -+---------------+ -| binary | -+---------------+ -| struct | -+---------------+ -| array | -+---------------+ +OpenSearch SQL Data Types +------------------------- + +The OpenSearch SQL Engine support the following data types. + ++---------------------+ +| OpenSearch SQL Type | ++=====================+ +| boolean | ++---------------------+ +| byte | ++---------------------+ +| short | ++---------------------+ +| integer | ++---------------------+ +| long | ++---------------------+ +| float | ++---------------------+ +| double | ++---------------------+ +| string | ++---------------------+ +| text | ++---------------------+ +| timestamp | ++---------------------+ +| datetime | ++---------------------+ +| date | ++---------------------+ +| time | ++---------------------+ +| interval | ++---------------------+ +| ip | ++---------------------+ +| geo_point | ++---------------------+ +| binary | ++---------------------+ +| struct | ++---------------------+ +| array | ++---------------------+ Data Types Mapping ------------------ -The table below list the mapping between OpenSearch Data Type, ODFE SQL Data Type and SQL Type. - -+-----------------+---------------+-----------+ -| OpenSearch Type | ODFE SQL Type | SQL Type | -+=================+===============+===========+ -| boolean | boolean | BOOLEAN | -+-----------------+---------------+-----------+ -| byte | byte | TINYINT | -+-----------------+---------------+-----------+ -| short | byte | SMALLINT | -+-----------------+---------------+-----------+ -| integer | integer | INTEGER | -+-----------------+---------------+-----------+ -| long | long | BIGINT | -+-----------------+---------------+-----------+ -| float | float | REAL | -+-----------------+---------------+-----------+ -| half_float | float | FLOAT | -+-----------------+---------------+-----------+ -| scaled_float | float | DOUBLE | -+-----------------+---------------+-----------+ -| double | double | DOUBLE | -+-----------------+---------------+-----------+ -| keyword | string | VARCHAR | -+-----------------+---------------+-----------+ -| text | text | VARCHAR | -+-----------------+---------------+-----------+ -| date | timestamp | TIMESTAMP | -+-----------------+---------------+-----------+ -| ip | ip | VARCHAR | -+-----------------+---------------+-----------+ -| date | timestamp | TIMESTAMP | -+-----------------+---------------+-----------+ -| binary | binary | VARBINARY | -+-----------------+---------------+-----------+ -| object | struct | STRUCT | -+-----------------+---------------+-----------+ -| nested | array | STRUCT | -+-----------------+---------------+-----------+ - -Notes: Not all the ODFE SQL Type has correspond OpenSearch Type. e.g. data and time. To use function which required such data type, user should explicitly convert the data type. +The table below list the mapping between OpenSearch Data Type, OpenSearch SQL Data Type and SQL Type. + ++-----------------+---------------------+-----------+ +| OpenSearch Type | OpenSearch SQL Type | SQL Type | ++=================+=====================+===========+ +| boolean | boolean | BOOLEAN | ++-----------------+---------------------+-----------+ +| byte | byte | TINYINT | ++-----------------+---------------------+-----------+ +| short | byte | SMALLINT | ++-----------------+---------------------+-----------+ +| integer | integer | INTEGER | ++-----------------+---------------------+-----------+ +| long | long | BIGINT | ++-----------------+---------------------+-----------+ +| float | float | REAL | ++-----------------+---------------------+-----------+ +| half_float | float | FLOAT | ++-----------------+---------------------+-----------+ +| scaled_float | float | DOUBLE | ++-----------------+---------------------+-----------+ +| double | double | DOUBLE | ++-----------------+---------------------+-----------+ +| keyword | string | VARCHAR | ++-----------------+---------------------+-----------+ +| text | text | VARCHAR | ++-----------------+---------------------+-----------+ +| date | timestamp | TIMESTAMP | ++-----------------+---------------------+-----------+ +| ip | ip | VARCHAR | ++-----------------+---------------------+-----------+ +| date | timestamp | TIMESTAMP | ++-----------------+---------------------+-----------+ +| binary | binary | VARBINARY | ++-----------------+---------------------+-----------+ +| object | struct | STRUCT | ++-----------------+---------------------+-----------+ +| nested | array | STRUCT | ++-----------------+---------------------+-----------+ + +Notes: Not all the OpenSearch SQL Type has correspond OpenSearch Type. e.g. data and time. To use function which required such data type, user should explicitly convert the data type. Undefined Data Type diff --git a/docs/user/general/values.rst b/docs/user/general/values.rst index fead02a136..36c48d86c9 100644 --- a/docs/user/general/values.rst +++ b/docs/user/general/values.rst @@ -11,7 +11,7 @@ Data Types NULL and MISSING Values ======================= -ODFE SQL has two ways to represent missing information. (1) The presence of the field with a NULL for its value. and (2) the absence of the filed. +OpenSearch SQL has two ways to represent missing information. (1) The presence of the field with a NULL for its value. and (2) the absence of the filed. Please note, when response is in table format, the MISSING value is translate to NULL value. diff --git a/sql-odbc/docs/dev/BUILD_INSTRUCTIONS.md b/sql-odbc/docs/dev/BUILD_INSTRUCTIONS.md index 9e7d45ecf2..16c642c633 100644 --- a/sql-odbc/docs/dev/BUILD_INSTRUCTIONS.md +++ b/sql-odbc/docs/dev/BUILD_INSTRUCTIONS.md @@ -1,4 +1,4 @@ -# ODFE SQL ODBC Driver Build Instructions +# OpenSearch SQL ODBC Driver Build Instructions ## Windows diff --git a/sql-odbc/docs/dev/run_tests.md b/sql-odbc/docs/dev/run_tests.md index 3995d8cefb..3072e6551b 100644 --- a/sql-odbc/docs/dev/run_tests.md +++ b/sql-odbc/docs/dev/run_tests.md @@ -1,4 +1,4 @@ -# ODFE SQL ODBC Driver Testing +# OpenSearch SQL ODBC Driver Testing ## Requirements diff --git a/sql-odbc/docs/test/data_connection_wizard.md b/sql-odbc/docs/test/data_connection_wizard.md index cf2494021f..9f6525e7cd 100644 --- a/sql-odbc/docs/test/data_connection_wizard.md +++ b/sql-odbc/docs/test/data_connection_wizard.md @@ -9,7 +9,7 @@ -* Select **ODFE SQL ODBC DSN** and Click on **Next**. +* Select **OpenSearch SQL ODBC DSN** and Click on **Next**. diff --git a/sql-odbc/docs/test/excel_connection.md b/sql-odbc/docs/test/excel_connection.md index e73dfa27ec..50c14d9a64 100644 --- a/sql-odbc/docs/test/excel_connection.md +++ b/sql-odbc/docs/test/excel_connection.md @@ -3,7 +3,7 @@ ## Prerequisites * [Download and install](../../README.md) OpenSearch SQL ODBC Driver. * [Install and configure](https://opendistro.github.io/for-elasticsearch-docs/docs/install/) OpenSearch. -* Open ODBC Data Source Administrator. Click on **System DSN** > **ODFE SQL ODBC DSN** > **Configure**. +* 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`. ## Microsoft Excel Connectivity diff --git a/sql-odbc/docs/test/microsoft_query_connection.md b/sql-odbc/docs/test/microsoft_query_connection.md index 10acf07543..3bfcff801d 100644 --- a/sql-odbc/docs/test/microsoft_query_connection.md +++ b/sql-odbc/docs/test/microsoft_query_connection.md @@ -5,7 +5,7 @@ -* Select **Databases** > **ODFE SQL ODBC DSN**. +* Select **Databases** > **OpenSearch SQL ODBC DSN**. * Clear the **Use the Query Wizard to create/edit queries** check box, and then click on **OK**. diff --git a/sql-odbc/docs/test/odbc_data_source_connection.md b/sql-odbc/docs/test/odbc_data_source_connection.md index 855a4d49be..f52b9f60e5 100644 --- a/sql-odbc/docs/test/odbc_data_source_connection.md +++ b/sql-odbc/docs/test/odbc_data_source_connection.md @@ -5,7 +5,7 @@ -* Select **ODFE SQL ODBC DSN**. Click **OK**. +* Select **OpenSearch SQL ODBC DSN**. Click **OK**. diff --git a/sql-odbc/docs/test/query_wizard_connection.md b/sql-odbc/docs/test/query_wizard_connection.md index 823fef7bd1..eb62ed3787 100644 --- a/sql-odbc/docs/test/query_wizard_connection.md +++ b/sql-odbc/docs/test/query_wizard_connection.md @@ -5,7 +5,7 @@ -* Select **Databases** > **ODFE SQL ODBC DSN**. +* Select **Databases** > **OpenSearch SQL ODBC DSN**. * Ensure the **Use the Query Wizard to create/edit queries** check box is selected, and then click **OK**. diff --git a/sql-odbc/docs/user/mac_configure_dsn.md b/sql-odbc/docs/user/mac_configure_dsn.md index 5fcb40b77e..30414ccac5 100644 --- a/sql-odbc/docs/user/mac_configure_dsn.md +++ b/sql-odbc/docs/user/mac_configure_dsn.md @@ -7,11 +7,11 @@ ## Adding a Driver Entry -Note: In order to use the OpenSearch SQL ODBC driver with the [Tableau Connector](), the **Description of the Driver** field *must* start with `ODFE SQL ODBC`. +Note: In order to use the OpenSearch SQL ODBC driver with the [Tableau Connector](), the **Description of the Driver** field *must* start with `OpenSearch SQL ODBC`. 1. Go to the **ODBC Drivers** tab. 2. Click **Add a Driver**. - * **Description of the Driver**: The driver name used for ODBC connections (ex. `ODFE SQL ODBC Driver`) + * **Description of the Driver**: The driver name used for ODBC connections (ex. `OpenSearch SQL ODBC Driver`) * **Driver File Name**: The path to the driver file (default installed path: `/Library/ODBC/opensearch-sql-odbc/bin/libodfesqlodbc.dylib`) * **Setup File Name**: The path to the driver file (default installed path: `/Library/ODBC/opensearch-sql-odbc/bin/libodfesqlodbc.dylib`) * Set as a **User** driver @@ -29,7 +29,7 @@ This is not required if you are using the Tableau Connector, but will help with 1. Go to the **User DSN** tab 2. Select **Add** on the right side of the window. * Choose the Driver you added above. - * **Data Source Name (DSN)**: The name of the DSN used to store connection options (ex. `ODFE SQL ODBC DSN`) + * **Data Source Name (DSN)**: The name of the DSN used to store connection options (ex. `OpenSearch SQL ODBC DSN`) * **Comment**: Not required * Add key-value pairs by using the **'+'** button. Below is a picture of the recommended set of options for a default local OpenSearch installation. 3. Click **OK** to save the DSN configuration. diff --git a/sql-odbc/docs/user/microsoft_excel_support.md b/sql-odbc/docs/user/microsoft_excel_support.md index d2ea78166e..e5a4f6c3ce 100644 --- a/sql-odbc/docs/user/microsoft_excel_support.md +++ b/sql-odbc/docs/user/microsoft_excel_support.md @@ -11,7 +11,7 @@ * Open **ODBC Data Source Administrator**. * Click on **System DSN**. -* Select **ODFE SQL ODBC DSN**. +* Select **OpenSearch SQL ODBC DSN**. * Click on **Configure**. @@ -30,7 +30,7 @@ -* Select **ODFE SQL ODBC DSN**. Click **OK**. +* Select **OpenSearch SQL ODBC DSN**. Click **OK**. diff --git a/sql-odbc/docs/user/microsoft_excel_support_mac.md b/sql-odbc/docs/user/microsoft_excel_support_mac.md index 67182e888b..11d3d7ede4 100644 --- a/sql-odbc/docs/user/microsoft_excel_support_mac.md +++ b/sql-odbc/docs/user/microsoft_excel_support_mac.md @@ -14,7 +14,7 @@ `sudo /Applications/iODBC/iODBC\ Administrator64.app/Contents/MacOS/iODBC\ Administrator64` * Click on **System DSN**. -* Select **ODFE SQL ODBC DSN**. +* Select **OpenSearch SQL ODBC DSN**. * Click on **Configure**. @@ -37,7 +37,7 @@ -* Select **ODFE SQL ODBC DSN**. Click **OK**. +* Select **OpenSearch SQL ODBC DSN**. Click **OK**. diff --git a/sql-odbc/docs/user/windows_configure_dsn.md b/sql-odbc/docs/user/windows_configure_dsn.md index 52cb83ec01..cf49861b33 100644 --- a/sql-odbc/docs/user/windows_configure_dsn.md +++ b/sql-odbc/docs/user/windows_configure_dsn.md @@ -6,7 +6,7 @@ -2. Click on the `System DSN` tab. Select `ODFE SQL ODBC DSN` and click on `Configure`. +2. Click on the `System DSN` tab. Select `OpenSearch SQL ODBC DSN` and click on `Configure`. @@ -39,7 +39,7 @@ For example, if you can connect to server using following curl command -2. Select `ODFE SQL ODBC Driver` and click on `Finish`. +2. Select `OpenSearch SQL ODBC Driver` and click on `Finish`. diff --git a/sql-odbc/src/DSNInstaller/dsn_installer.cpp b/sql-odbc/src/DSNInstaller/dsn_installer.cpp index 8360d7b104..6551cab90f 100644 --- a/sql-odbc/src/DSNInstaller/dsn_installer.cpp +++ b/sql-odbc/src/DSNInstaller/dsn_installer.cpp @@ -39,9 +39,9 @@ // maintain null characters. using namespace std::string_literals; -std::wstring driver_name = L"ODFE SQL ODBC Driver"; +std::wstring driver_name = L"OpenSearch SQL ODBC Driver"; std::wstring driver_filename = L"libodfesqlodbc.dylib"; -std::wstring dsn_name = L"ODFE SQL ODBC DSN"; +std::wstring dsn_name = L"OpenSearch SQL ODBC DSN"; std::wstring dsn_ini_filename = L"odfesqlodbc.ini"; std::wstring driver_name_placeholder = L"%DRIVER_NAME%"; diff --git a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.pq b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.pq index 1ae78f11df..f72ec09ee0 100644 --- a/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.pq +++ b/sql-odbc/src/PowerBIConnector/OdfeSqlOdbcPBIConnector.pq @@ -57,7 +57,7 @@ OdfeSqlOdbcPBIConnectorImpl = (Server as text) as table => ], ConnectionString = [ - Driver = "ODFE SQL ODBC Driver", + Driver = "OpenSearch SQL ODBC Driver", Host = Server ], @@ -188,7 +188,7 @@ OdfeSqlOdbcPBIConnector = [ db = OdfeSqlOdbcPBIConnector.Contents(dsr[address][server]) in db, - GetFriendlyName = (dsr) => "ODFE SQL ODBC" + GetFriendlyName = (dsr) => "OpenSearch SQL ODBC" ] ], diff --git a/sql-odbc/src/TableauConnector/odfe_sql_odbc/connectionResolver.tdr b/sql-odbc/src/TableauConnector/odfe_sql_odbc/connectionResolver.tdr index ecf00d88a3..4cf2971019 100644 --- a/sql-odbc/src/TableauConnector/odfe_sql_odbc/connectionResolver.tdr +++ b/sql-odbc/src/TableauConnector/odfe_sql_odbc/connectionResolver.tdr @@ -21,7 +21,7 @@ - ODFE SQL ODBC* + OpenSearch SQL ODBC* diff --git a/sql-odbc/src/TableauConnector/odfe_sql_odbc_dev/connectionResolver.tdr b/sql-odbc/src/TableauConnector/odfe_sql_odbc_dev/connectionResolver.tdr index 80143227a9..43eedb8771 100644 --- a/sql-odbc/src/TableauConnector/odfe_sql_odbc_dev/connectionResolver.tdr +++ b/sql-odbc/src/TableauConnector/odfe_sql_odbc_dev/connectionResolver.tdr @@ -21,7 +21,7 @@ - ODFE SQL ODBC* + OpenSearch SQL ODBC* diff --git a/sql-odbc/src/installer/Resources/README.txt b/sql-odbc/src/installer/Resources/README.txt index 549c0613a2..86ec3cd375 100644 --- a/sql-odbc/src/installer/Resources/README.txt +++ b/sql-odbc/src/installer/Resources/README.txt @@ -3,7 +3,7 @@ All files are available in '/Library/ODBC/opensearch-sql-odbc' after installatio To setup a connection, you can use DSN to store your data source connection information, 1. Open 'iODBC Data Source Administrator'. 2. Go to 'User DSN'. -3. Select 'ODFE SQL ODBC DSN' and click on 'Configure'. +3. Select 'OpenSearch SQL ODBC DSN' and click on 'Configure'. 4. Update the connection string values. For the list of all supported options, check '/Library/ODBC/opensearch-sql-odbc/doc/README.md'. 5. Click 'Ok' to save changes. @@ -12,7 +12,7 @@ If using with ODBC compatible BI tools, refer to the tool documentation on confi For example, if you want to use Tableau with OpenSearch Server, 1. Open 'Tableau'. 2. Click on 'Other Databases (ODBC)'. -3. Select 'ODFE SQL ODBC DSN' from the DSN list or 'ODFE SQL ODBC Driver' from the driver list. If using driver, you need to enter connection string values. +3. Select 'OpenSearch SQL ODBC DSN' from the DSN list or 'OpenSearch SQL ODBC Driver' from the driver list. If using driver, you need to enter connection string values. 4. Click on 'Connect'. All connection attributes will be retrived. 5. Click on 'Sign In'. You will be successfully connected to OpenSearch server. diff --git a/sql-odbc/src/installer/Resources/odfe_sql_odbc.tdc b/sql-odbc/src/installer/Resources/odfe_sql_odbc.tdc index 7c36b1b72c..3574dfdbff 100644 --- a/sql-odbc/src/installer/Resources/odfe_sql_odbc.tdc +++ b/sql-odbc/src/installer/Resources/odfe_sql_odbc.tdc @@ -1,7 +1,7 @@ - + diff --git a/sql-odbc/src/installer/patch.xml b/sql-odbc/src/installer/patch.xml index 4305cc4acd..b334963aec 100644 --- a/sql-odbc/src/installer/patch.xml +++ b/sql-odbc/src/installer/patch.xml @@ -1,7 +1,7 @@ - + @@ -9,23 +9,23 @@ - + - + - + - - + +