You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/postgresql/migrate/oracle-schema-conversions/schema-conversions-overview.md
+63Lines changed: 63 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,6 +77,67 @@ An integrated feature in Visual Studio Code that provides guided prompts to help
77
77
- Code completion for complex transformations
78
78
- Integration with your existing development workflow
79
79
80
+
## Oracle connectivity modes
81
+
82
+
The schema conversion tool supports two connectivity modes for connecting to your source Oracle database: **thin** and **thick**. Understanding the difference helps you choose the right mode for your environment.
83
+
84
+
### Thin client mode (default)
85
+
86
+
Thin mode connects directly to Oracle Database without requiring any additional Oracle client libraries. This mode is the default and works out of the box.
87
+
88
+
- No Oracle Instant Client installation required
89
+
- Supports Oracle Database 12.1 and later
90
+
- Suitable for most schema conversion scenarios
91
+
- Connects using standard TCP/IP networking
92
+
93
+
### Thick client mode
94
+
95
+
Thick mode uses Oracle Instant Client libraries to connect to Oracle Database. This mode is required when thin mode can't establish a connection to your source Oracle environment.
96
+
97
+
### Identify whether your Oracle source requires thick client mode
98
+
99
+
You can determine whether thick client mode is required by checking the Oracle network configuration files in your source environment. Look for the following parameters in the `sqlnet.ora` file (typically located in `$ORACLE_HOME/network/admin/`):
100
+
101
+
| Parameter | Indicates thick mode is required |
102
+
| --- | --- |
103
+
|`SQLNET.CRYPTO_CHECKSUM_CLIENT`| Set to `REQUIRED` or `REQUESTED` for native network encryption |
104
+
|`SQLNET.ENCRYPTION_CLIENT`| Set to `REQUIRED` or `REQUESTED` for native network encryption |
105
+
106
+
If any of these parameters are configured in your source Oracle environment, select **Thick** client mode in the Migration Wizard and ensure Oracle Instant Client is installed.
107
+
108
+
### Install Oracle Instant Client
109
+
110
+
To use thick client mode, install Oracle Instant Client on the machine where VS Code and the schema conversion tool are running. Schema conversion is supported on **Windows** and **Linux** only.
111
+
112
+
1. Download the **Oracle Instant Client Basic** or **Basic Light** package from Oracle's website for your operating system.
113
+
1. Extract the package to a directory on the machine.
114
+
1. Add the Instant Client directory to the system **PATH** environment variable:
115
+
-**Windows**: Add the Instant Client directory to the `PATH` variable through **System Properties** > **Environment Variables**, or by using PowerShell.
116
+
-**Linux**: Add the Instant Client directory to `PATH` and set the `LD_LIBRARY_PATH` environment variable to include the directory. Ensure the `libaio` library is installed.
117
+
1. Restart VS Code to pick up the updated environment variables.
118
+
119
+
## Authentication for Azure OpenAI and Azure AI Foundry
120
+
121
+
The schema conversion tool supports two authentication methods for connecting to Azure OpenAI or Azure AI Foundry models:
122
+
123
+
### API key authentication
124
+
125
+
API key authentication uses a deployment-specific key to authorize requests. This method is straightforward and suitable for development and testing scenarios.
126
+
127
+
### Microsoft Entra ID authentication
128
+
129
+
Microsoft Entra ID (formerly Azure Active Directory) authentication provides token-based, identity-driven access to Azure OpenAI and Azure AI Foundry without managing API keys. This method is recommended for production environments and organizations with centralized identity management.
130
+
131
+
To use Microsoft Entra ID authentication:
132
+
133
+
1.**Assign the required role**: Ensure the signed-in user or service principal has the **Cognitive Services OpenAI User** role (or higher) on the Azure OpenAI resource. Assign the role in the Azure portal under **Access control (IAM)**.
134
+
1.**Sign in to Azure in VS Code**: Use the **Azure: Sign In** command from the Command Palette (`Ctrl+Shift+P`) to authenticate with your Microsoft Entra ID account.
135
+
1.**Select Entra ID authentication**: In the Migration Wizard language model configuration step, select **Microsoft Entra ID** as the authentication method instead of API key.
136
+
1.**Provide the endpoint**: Enter your Azure OpenAI or Azure AI Foundry endpoint URL. The tool acquires the authentication token automatically from your signed-in session.
137
+
138
+
> [!NOTE]
139
+
> Microsoft Entra ID authentication requires the **Azure Account** extension in VS Code. The extension must be signed in with an identity that has the appropriate role assignment on the Azure OpenAI resource.
140
+
80
141
## Security and networking
81
142
82
143
When you use the schema conversion feature, make sure your Visual Studio Code environment can securely connect to both your source Oracle database and the Azure Database for PostgreSQL flexible server instance that you use as the scratch database.
@@ -98,6 +159,8 @@ Converting Oracle schemas to Azure Database for PostgreSQL streamlines migration
98
159
-**AI-powered intelligence**: Uses Azure OpenAI for smart transformation decisions
99
160
-**Validation-first approach**: Uses the scratch database to ensure converted objects work correctly
100
161
-**Integrated workflow**: Works seamlessly within Visual Studio Code development environment
162
+
-**Flexible Oracle connectivity**: Supports both thin and thick client modes for connecting to Oracle databases
163
+
-**Multiple authentication options**: Supports API key and Microsoft Entra ID authentication for Azure OpenAI and Azure AI Foundry
101
164
-**Review and refinement**: Provides clear guidance for manual review tasks
102
165
-**Azure optimization**: Designed for Azure Database for PostgreSQL flexible server
Copy file name to clipboardExpand all lines: articles/postgresql/migrate/oracle-schema-conversions/schema-conversions-tutorial.md
+21-3Lines changed: 21 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -100,6 +100,19 @@ The following privileges are required on the Azure Database for PostgreSQL Flexi
100
100
-**HTTPS access** for Visual Studio Code extension marketplace and GitHub Copilot services
101
101
-**GitHub repository access** to https://github.com/microsoft/pgsql-tools/
102
102
103
+
### Oracle Instant Client (for thick client mode)
104
+
105
+
The schema conversion tool connects to Oracle using thin client mode by default, which requires no extra software. If your environment requires thick client mode, install Oracle Instant Client on the machine running VS Code.
106
+
107
+
### Azure OpenAI authentication
108
+
109
+
You need one of the following authentication methods configured for Azure OpenAI or Azure AI Foundry:
110
+
111
+
| Authentication method | Requirements |
112
+
| --- | --- |
113
+
|**API key**| Azure OpenAI endpoint URL and API key |
114
+
|**Microsoft Entra ID**| Azure Account extension signed in, **Cognitive Services OpenAI User** role assigned on the Azure OpenAI resource |
115
+
103
116
## Migration process
104
117
105
118
This section walks through the complete migration workflow: install the PostgreSQL extension, create, and test connections to your Oracle source and Azure Database for PostgreSQL target, open and initialize a migration project, configure Azure OpenAI for schema translation, run the Migration Wizard to discover and convert schemas, validate converted objects in a scratch database, and review or fix any flagged items before applying the generated PostgreSQL artifacts to your target.
@@ -150,6 +163,9 @@ This section walks through the complete migration workflow: install the PostgreS
150
163
- Port number
151
164
- Database or service name
152
165
- Username and password
166
+
1.**Select the client mode** for the Oracle connection:
167
+
-**Thin** (default): Connects directly without Oracle client libraries.
168
+
-**Thick**: Uses Oracle Instant Client libraries. Required when thin mode can't establish a connection to your source Oracle environment. Ensure Oracle Instant Client is installed and the PATH environment variable is configured on Windows or Linux before selecting this option.
153
169
1. Select **Load Schemas**.
154
170
1. The system **Tests the Oracle connection**.
155
171
1. If successful, it **Lists all user-defined schemas** available in Oracle.
@@ -170,10 +186,12 @@ This section walks through the complete migration workflow: install the PostgreS
170
186
171
187
1. Enter your **Azure OpenAI details** including:
172
188
- Endpoint URL
173
-
- API key
174
189
- Deployment name (must be gpt-4.1)
175
-
1. Select **Test Connection** to verify the configuration
176
-
1. Once the connection is **successful**, select **Create Migration Project**
190
+
1.**Select the authentication method**:
191
+
-**API key**: Enter the API key for your Azure OpenAI deployment.
192
+
-**Microsoft Entra ID**: Sign in with the Azure Account extension. The tool acquires the authentication token automatically. Ensure the signed-in identity has the **Cognitive Services OpenAI User** role on the Azure OpenAI resource.
193
+
1. Select **Test Connection** to verify the configuration.
194
+
1. Once the connection is **successful**, select **Create Migration Project**.
177
195
178
196
:::image type="content" source="media/schema-conversions-tutorial/language-model.png" alt-text="Screenshot of language model configuration.":::
0 commit comments