From b1a41ca1ac9adfce768e80523255360123377bda Mon Sep 17 00:00:00 2001 From: RounakDhillon <162090200+RounakDhillon@users.noreply.github.com> Date: Fri, 13 Dec 2024 16:39:59 +0530 Subject: [PATCH] Docs: MSSQL Troubleshooting Doc Updation (#19045) Co-authored-by: Rounak Dhillon --- .../content/v1.5.x/collate-menu.md | 2 + .../connectors/database/mssql/troubleshoot.md | 55 +++++++++++++++++++ openmetadata-docs/content/v1.5.x/menu.md | 2 + .../content/v1.6.x/collate-menu.md | 2 + .../connectors/database/mssql/troubleshoot.md | 55 +++++++++++++++++++ openmetadata-docs/content/v1.6.x/menu.md | 2 + .../content/v1.7.x-SNAPSHOT/collate-menu.md | 2 + .../connectors/database/mssql/troubleshoot.md | 55 +++++++++++++++++++ .../content/v1.7.x-SNAPSHOT/menu.md | 2 + 9 files changed, 177 insertions(+) create mode 100644 openmetadata-docs/content/v1.5.x/connectors/database/mssql/troubleshoot.md create mode 100644 openmetadata-docs/content/v1.6.x/connectors/database/mssql/troubleshoot.md create mode 100644 openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/mssql/troubleshoot.md diff --git a/openmetadata-docs/content/v1.5.x/collate-menu.md b/openmetadata-docs/content/v1.5.x/collate-menu.md index c143dd9ed18..d37422b99d5 100644 --- a/openmetadata-docs/content/v1.5.x/collate-menu.md +++ b/openmetadata-docs/content/v1.5.x/collate-menu.md @@ -136,6 +136,8 @@ site_menu: url: /connectors/database/mssql - category: Connectors / Database / MSSQL / Run Externally url: /connectors/database/mssql/yaml + - category: Connectors / Database / MSSQL / Troubleshooting + url: /connectors/database/mssql/troubleshooting - category: Connectors / Database / MySQL url: /connectors/database/mysql - category: Connectors / Database / MySQL / Run Externally diff --git a/openmetadata-docs/content/v1.5.x/connectors/database/mssql/troubleshoot.md b/openmetadata-docs/content/v1.5.x/connectors/database/mssql/troubleshoot.md new file mode 100644 index 00000000000..44032b985ab --- /dev/null +++ b/openmetadata-docs/content/v1.5.x/connectors/database/mssql/troubleshoot.md @@ -0,0 +1,55 @@ +--- +title: Troubleshooting for MSSQL +slug: /connectors/database/mssql/troubleshooting +--- + +# Resolving SQL Server Authentication Issue for Windows User + +This guide addresses a common issue when connecting to a SQL Server instance using Windows OS. If you encounter the error below, follow the steps outlined to resolve it effectively. + +## Error Description +When attempting to connect to SQL Server using a Windows user, the following error appears: + +``` +(pyodbc.InterfaceError) ('28000', "[28000] [Microsoft][ODBC Driver 18 for SQL Server][SQL Server]Login failed for user 'domain\\user'. (18456)") +``` + +Additionally, the SQL Server logs display: + +``` +Login failed for user 'domain\user'. Reason: Attempting to use an NT account name with SQL Server Authentication. +``` +## Root Cause +The error occurs because the connection is configured to use SQL Server Authentication instead of Windows Authentication. Windows Authentication requires a connection scheme that supports integrated security. + +## Resolution + +### Step 1: Verify Connection Configuration +1. Ensure that you are connecting to SQL Server using **Windows Authentication**. +2. Update the connection scheme to use `mssql+pymssql` instead of `mssql.pyodbc`. + +### Step 2: Update the Connection Details in Collate +1. Navigate to **MSSQL Service Configuration** in the Collate UI. +2. Update the **Connection Scheme** to `mssql+pymssql`. +3. Retain the following connection details: + - **Host and Port**: e.g., `10.121.89.148:62452`. + - **Database**: Specify the target database (e.g., `OneSumx_Stoging`). + - **Username**: Use the Windows account username, e.g., `domain\user`. +4. Save the updated configuration. + +### Step 3: Test the Connection +1. After saving the changes, click **Test Connection** in the Collate UI. +2. Confirm that the following steps pass successfully: + - **CheckAccess** + - **GetDatabases** + - **GetSchemas** + - **GetTables** + - **GetViews** + - **GetQueries** + +### Expected Outcome +After updating the connection scheme, the connection should succeed. The status will display: + +``` +Connection Status: Success +``` diff --git a/openmetadata-docs/content/v1.5.x/menu.md b/openmetadata-docs/content/v1.5.x/menu.md index 39a5f3bb1e8..c7d1f8f67c3 100644 --- a/openmetadata-docs/content/v1.5.x/menu.md +++ b/openmetadata-docs/content/v1.5.x/menu.md @@ -332,6 +332,8 @@ site_menu: url: /connectors/database/mssql - category: Connectors / Database / MSSQL / Run Externally url: /connectors/database/mssql/yaml + - category: Connectors / Database / MSSQL / Troubleshooting + url: /connectors/database/mssql/troubleshooting - category: Connectors / Database / MySQL url: /connectors/database/mysql - category: Connectors / Database / MySQL / Run Externally diff --git a/openmetadata-docs/content/v1.6.x/collate-menu.md b/openmetadata-docs/content/v1.6.x/collate-menu.md index c89a6e1bd98..611e80ec084 100644 --- a/openmetadata-docs/content/v1.6.x/collate-menu.md +++ b/openmetadata-docs/content/v1.6.x/collate-menu.md @@ -151,6 +151,8 @@ site_menu: url: /connectors/database/mssql - category: Connectors / Database / MSSQL / Run Externally url: /connectors/database/mssql/yaml + - category: Connectors / Database / MSSQL / Troubleshooting + url: /connectors/database/mssql/troubleshooting - category: Connectors / Database / MySQL url: /connectors/database/mysql - category: Connectors / Database / MySQL / Run Externally diff --git a/openmetadata-docs/content/v1.6.x/connectors/database/mssql/troubleshoot.md b/openmetadata-docs/content/v1.6.x/connectors/database/mssql/troubleshoot.md new file mode 100644 index 00000000000..44032b985ab --- /dev/null +++ b/openmetadata-docs/content/v1.6.x/connectors/database/mssql/troubleshoot.md @@ -0,0 +1,55 @@ +--- +title: Troubleshooting for MSSQL +slug: /connectors/database/mssql/troubleshooting +--- + +# Resolving SQL Server Authentication Issue for Windows User + +This guide addresses a common issue when connecting to a SQL Server instance using Windows OS. If you encounter the error below, follow the steps outlined to resolve it effectively. + +## Error Description +When attempting to connect to SQL Server using a Windows user, the following error appears: + +``` +(pyodbc.InterfaceError) ('28000', "[28000] [Microsoft][ODBC Driver 18 for SQL Server][SQL Server]Login failed for user 'domain\\user'. (18456)") +``` + +Additionally, the SQL Server logs display: + +``` +Login failed for user 'domain\user'. Reason: Attempting to use an NT account name with SQL Server Authentication. +``` +## Root Cause +The error occurs because the connection is configured to use SQL Server Authentication instead of Windows Authentication. Windows Authentication requires a connection scheme that supports integrated security. + +## Resolution + +### Step 1: Verify Connection Configuration +1. Ensure that you are connecting to SQL Server using **Windows Authentication**. +2. Update the connection scheme to use `mssql+pymssql` instead of `mssql.pyodbc`. + +### Step 2: Update the Connection Details in Collate +1. Navigate to **MSSQL Service Configuration** in the Collate UI. +2. Update the **Connection Scheme** to `mssql+pymssql`. +3. Retain the following connection details: + - **Host and Port**: e.g., `10.121.89.148:62452`. + - **Database**: Specify the target database (e.g., `OneSumx_Stoging`). + - **Username**: Use the Windows account username, e.g., `domain\user`. +4. Save the updated configuration. + +### Step 3: Test the Connection +1. After saving the changes, click **Test Connection** in the Collate UI. +2. Confirm that the following steps pass successfully: + - **CheckAccess** + - **GetDatabases** + - **GetSchemas** + - **GetTables** + - **GetViews** + - **GetQueries** + +### Expected Outcome +After updating the connection scheme, the connection should succeed. The status will display: + +``` +Connection Status: Success +``` diff --git a/openmetadata-docs/content/v1.6.x/menu.md b/openmetadata-docs/content/v1.6.x/menu.md index e518443ef00..1f3711f7de3 100644 --- a/openmetadata-docs/content/v1.6.x/menu.md +++ b/openmetadata-docs/content/v1.6.x/menu.md @@ -336,6 +336,8 @@ site_menu: url: /connectors/database/mssql - category: Connectors / Database / MSSQL / Run Externally url: /connectors/database/mssql/yaml + - category: Connectors / Database / MSSQL / Troubleshooting + url: /connectors/database/mssql/troubleshooting - category: Connectors / Database / MySQL url: /connectors/database/mysql - category: Connectors / Database / MySQL / Run Externally diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md index 5963638c1e3..9c63a8d0ed9 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/collate-menu.md @@ -155,6 +155,8 @@ site_menu: url: /connectors/database/mssql - category: Connectors / Database / MSSQL / Run Externally url: /connectors/database/mssql/yaml + - category: Connectors / Database / MSSQL / Troubleshooting + url: /connectors/database/mssql/troubleshooting - category: Connectors / Database / MySQL url: /connectors/database/mysql - category: Connectors / Database / MySQL / Run Externally diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/mssql/troubleshoot.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/mssql/troubleshoot.md new file mode 100644 index 00000000000..44032b985ab --- /dev/null +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/mssql/troubleshoot.md @@ -0,0 +1,55 @@ +--- +title: Troubleshooting for MSSQL +slug: /connectors/database/mssql/troubleshooting +--- + +# Resolving SQL Server Authentication Issue for Windows User + +This guide addresses a common issue when connecting to a SQL Server instance using Windows OS. If you encounter the error below, follow the steps outlined to resolve it effectively. + +## Error Description +When attempting to connect to SQL Server using a Windows user, the following error appears: + +``` +(pyodbc.InterfaceError) ('28000', "[28000] [Microsoft][ODBC Driver 18 for SQL Server][SQL Server]Login failed for user 'domain\\user'. (18456)") +``` + +Additionally, the SQL Server logs display: + +``` +Login failed for user 'domain\user'. Reason: Attempting to use an NT account name with SQL Server Authentication. +``` +## Root Cause +The error occurs because the connection is configured to use SQL Server Authentication instead of Windows Authentication. Windows Authentication requires a connection scheme that supports integrated security. + +## Resolution + +### Step 1: Verify Connection Configuration +1. Ensure that you are connecting to SQL Server using **Windows Authentication**. +2. Update the connection scheme to use `mssql+pymssql` instead of `mssql.pyodbc`. + +### Step 2: Update the Connection Details in Collate +1. Navigate to **MSSQL Service Configuration** in the Collate UI. +2. Update the **Connection Scheme** to `mssql+pymssql`. +3. Retain the following connection details: + - **Host and Port**: e.g., `10.121.89.148:62452`. + - **Database**: Specify the target database (e.g., `OneSumx_Stoging`). + - **Username**: Use the Windows account username, e.g., `domain\user`. +4. Save the updated configuration. + +### Step 3: Test the Connection +1. After saving the changes, click **Test Connection** in the Collate UI. +2. Confirm that the following steps pass successfully: + - **CheckAccess** + - **GetDatabases** + - **GetSchemas** + - **GetTables** + - **GetViews** + - **GetQueries** + +### Expected Outcome +After updating the connection scheme, the connection should succeed. The status will display: + +``` +Connection Status: Success +``` diff --git a/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md b/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md index 7fbf661c240..9b58803dbdd 100644 --- a/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md +++ b/openmetadata-docs/content/v1.7.x-SNAPSHOT/menu.md @@ -340,6 +340,8 @@ site_menu: url: /connectors/database/mssql - category: Connectors / Database / MSSQL / Run Externally url: /connectors/database/mssql/yaml + - category: Connectors / Database / MSSQL / Troubleshooting + url: /connectors/database/mssql/troubleshooting - category: Connectors / Database / MySQL url: /connectors/database/mysql - category: Connectors / Database / MySQL / Run Externally