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: docs/language-extensions/install/windows-java.md
+47-52Lines changed: 47 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,15 @@ Learn how to install the [Java Language Extension](../java-overview.md) componen
23
23
24
24
## Pre-install checklist
25
25
26
-
+ SQL Server 2019 Setup is required if you want to install support for Java Language Extension.
26
+
+ SQL Server 2019 Setup is required if you want to install support for the Java Language Extension.
27
27
28
28
+ A database engine instance is required. You cannot install just the Java Language Extension features, although you can add them incrementally to an existing instance.
29
29
30
30
+ For business continuity, [Always On Availability Groups](../../database-engine/availability-groups/windows/overview-of-always-on-availability-groups-sql-server.md) are supported for Language Extensions. You have to install language extensions, and configure packages, on each node.
31
31
32
-
+ Installing Language Extensions is supported on a failover cluster in SQL Server 2019.
32
+
+ Installing the Java Language Extension is supported on a failover cluster in SQL Server 2019.
33
33
34
-
+ Do not install SQL Server Language Extensions on a domain controller. The Language Extensions portion of setup will fail.
34
+
+ Do not install SQL Server Language Extensions or the Java Language Extension on a domain controller. The Language Extensions portion of setup will fail.
35
35
36
36
+ Language Extensions and [Machine Learning Services](../../machine-learning/index.yml) are installed by default on SQL Server Big Data Clusters. If you use Big Data Clusters, you do not need to follow the steps in this article. For more information, see [Use Machine Learning Services (Python and R) on Big Data Clusters](../../big-data-cluster/machine-learning-services.md).
37
37
@@ -63,11 +63,11 @@ For local installations, you must run Setup as an administrator. If you install
63
63
64
64
1. Start the setup wizard for SQL Server 2019.
65
65
66
-
2. On the **Installation** tab, select **New SQL Server stand-alone installation or add features to an existing installation**.
66
+
1. On the **Installation** tab, select **New SQL Server stand-alone installation or add features to an existing installation**.
67
67
68
68

69
69
70
-
3. On the **Feature Selection** page, select these options:
70
+
1. On the **Feature Selection** page, select these options:
71
71
72
72
-**Database Engine Services**
73
73
@@ -79,13 +79,13 @@ For local installations, you must run Setup as an administrator. If you install
79
79
80
80
- If you want to install the default Java runtime, Zulu Open JRE 11.0.3, select **Machine Learning Services and Language Extensions** and **Java**.
81
81
82
-
- If you want to use your own Java runtime, select **Machine Learning Services and Language Extensions**. Do not select Java.
82
+
- If you want to use your own Java runtime, select **Machine Learning Services and Language Extensions**. Do not select **Java**.
83
83
84
84
If you want to use R and Python, see [Install SQL Server Machine Learning Services on Windows](../../machine-learning/install/sql-machine-learning-services-windows-install.md).
85
85
86
86

87
87
88
-
4. If you choose **Java** in the previous step to install the default Java runtime, the **Java Install Location** page will show up.
88
+
1. If you choose **Java** in the previous step to install the default Java runtime, the **Java Install Location** page will show up.
89
89
90
90
Select the **Install Open JRE 11.0.3 included with this installation**.
91
91
@@ -94,7 +94,7 @@ For local installations, you must run Setup as an administrator. If you install
94
94
> [!NOTE]
95
95
> The **Provide the location of a different version that has been installed on this computer** is not used for Language Extensions.
96
96
97
-
5. On the **Ready to Install** page, verify that these selections are included, and select **Install**.
97
+
1. On the **Ready to Install** page, verify that these selections are included, and select **Install**.
98
98
99
99
+ Database Engine Services
100
100
+ Machine Learning Services and Language Extensions
@@ -113,17 +113,17 @@ For local installations, you must run Setup as an administrator. If you install
113
113
114
114
Depending on your SQL Server installation path or if you chose another Java runtime, your location of the JDK or JRE might be different than the example path above. Even if you have a JDK installed, you often will get a JRE sub folder as part of that installation, so point to the JRE folder in that case. The Java extension will attempt to load the `jvm.dll` from the path `%JRE_HOME%\bin\server`.
115
115
116
-
2. In Control Panel, open **System and Security**, open **System**, and select **Advanced System Properties**.
116
+
1. In Control Panel, open **System and Security**, open **System**, and select **Advanced System Properties**.
117
117
118
-
3. Select **Environment Variables**.
118
+
1. Select **Environment Variables**.
119
119
120
-
4. Create a new system variable for `JRE_HOME` with the value of the JDK/JRE path (found in step 1).
120
+
1. Create a new system variable for `JRE_HOME` with the value of the JDK/JRE path (found in step 1).
1. Open [SQL Server Configuration Manager](../../relational-databases/sql-server-configuration-manager.md).
125
125
126
-
2. Under SQL Server Services, right-click SQL Server Launchpad and select **Restart**.
126
+
1. Under SQL Server Services, right-click SQL Server Launchpad and select **Restart**.
127
127
128
128
<aname="perms-nonwindows"></a>
129
129
@@ -141,48 +141,43 @@ If you did not install the default Zulu Open JRE that was included with SQL Serv
141
141
142
142
You can skip this step if you installed the JDK/JRE in the default folder under program files on Windows.
143
143
144
-
2. Give AppContainer permissions
144
+
1. Give AppContainer permissions
145
145
146
146
```cmd
147
147
icacls “<PATH to JRE>” /grant *S-1-15-2-1:(OI)(CI)RX /T
148
148
```
149
-
149
+
150
150
> [!NOTE]
151
151
> The above command grants permissions to the computer SID **S-1-15-2-1**, which is equivalent to **ALL APPLICATION PACKAGES** on an English version of Windows. Alternatively, you can use `icacls "<PATH to JRE>" /grant "ALL APPLICATION PACKAGES":(OI)(CI)RX /T` on an English version of Windows.
152
-
152
+
153
+
## Restart the service
154
+
155
+
When the installation is complete, restart the database engine before continuing to the next step, enabling script execution.
156
+
157
+
Restarting the service also automatically restarts the related SQL Server Launchpad service.
158
+
159
+
You can restart the service using the right-click **Restart** command for the instance in SSMS, or by using the **Services** panel in Control Panel, or by using [SQL Server Configuration Manager](../../relational-databases/sql-server-configuration-manager.md).
160
+
153
161
## Enable script execution
154
162
155
163
1. Open [!INCLUDE[ssManStudioFull](../../includes/ssmanstudiofull-md.md)].
156
164
157
-
> [!TIP]
158
-
> You can download and install the appropriate version from this page: [Download SQL Server Management Studio (SSMS)](../../ssms/download-sql-server-management-studio-ssms.md).
159
-
>
160
-
> You can also use [Azure Data Studio](../../azure-data-studio/what-is.md), which supports administrative tasks and queries against SQL Server.
161
-
162
-
2. Connect to the instance where you installed Language Extensions, click **New Query** to open a query window, and run the following command:
165
+
1. Connect to the instance where you installed Language Extensions, click **New Query** to open a query window, and run the following command:
163
166
164
167
```sql
165
168
sp_configure
166
169
```
167
170
168
171
The value for the property, `external scripts enabled`, should be **0** at this point. The feature is turned off by default and must be explicitly enabled by an administrator before you can run Java code.
169
-
170
-
3. To enable the external scripting feature, run the following statement:
171
-
172
+
173
+
1. To enable the external scripting feature, run the following statement:
174
+
172
175
```sql
173
-
EXEC sp_configure 'external scripts enabled', 1
176
+
EXEC sp_configure 'external scripts enabled', 1
174
177
RECONFIGURE WITH OVERRIDE
175
178
```
176
-
177
-
If you have already enabled the feature for Machine Learning Services, don't run reconfigure a second time for Language Extensions. The underlying extensibility platform supports both.
178
-
179
-
## Restart the service
180
-
181
-
When the installation is complete, restart the database engine before continuing to the next, enabling script execution.
182
-
183
-
Restarting the service also automatically restarts the related SQL Server Launchpad service.
184
179
185
-
You can restart the service using the right-click **Restart** command for the instance in SSMS, or by using the **Services** panel in Control Panel, or by using [SQL Server Configuration Manager](../../relational-databases/sql-server-configuration-manager.md).
180
+
If you have already enabled the feature for Machine Learning Services, don't run reconfigure a second time for Language Extensions. The underlying extensibility platform supports both.
186
181
187
182
<a name="register_external_language"></a>
188
183
@@ -207,15 +202,15 @@ Check the installation status of the instance in the setup logs.
207
202
Use the following steps to verify that all components used to launch external script are running.
208
203
209
204
1. In SQL Server Management Studio or Azure Data Studio, open a new query window, and run the following statement:
210
-
205
+
211
206
```sql
212
-
EXEC sp_configure 'external scripts enabled'
207
+
EXEC sp_configure 'external scripts enabled'
213
208
```
214
209
215
210
The **run_value** is now set to 1.
216
-
217
-
2. Open the **Services** panel or SQL Server Configuration Manager, and verify **SQL Server Launchpad service** is running. You should have one service for every database engine instance that has language extensions installed. For more information about the service, see [Extensibility framework](../concepts/extensibility-framework.md).
218
-
211
+
212
+
1. Open the **Services** panel or SQL Server Configuration Manager, and verify **SQL Server Launchpad service** is running. You should have one service for every database engine instance that has language extensions installed. For more information about the service, see [Extensibility framework](../concepts/extensibility-framework.md).
213
+
219
214
## Additional configuration
220
215
221
216
If the verification step was successful, you can run Java Code from SQL Server Management Studio, Azure Data Studio, Visual Studio Code, or any other client that can send T-SQL statements to the server.
@@ -224,35 +219,35 @@ If you got an error when running the command, review the additional configuratio
224
219
225
220
At the instance level, additional configuration might include:
226
221
227
-
* [Firewall configuration for SQL Server Machine Learning Services](../../machine-learning/security/firewall-configuration.md)
+ [Create a login for SQLRUserGroup](../../machine-learning/security/create-a-login-for-sqlrusergroup.md)
231
226
232
-
<a name="bkmk_configureAccounts"></a>
233
-
<a name="permissions-external-script"></a>
227
+
<a name="bkmk_configureAccounts"></a>
228
+
<a name="permissions-external-script"></a>
234
229
235
230
On the database, you might need the following configuration updates:
236
231
237
-
* [Give users permission to SQL Server Machine Learning Services](../../machine-learning/security/user-permission.md)
238
-
* [Give users permission to execute a specific language](../../t-sql/statements/create-external-language-transact-sql.md#permissions)
232
+
+ [Give users permission to SQL Server Machine Learning Services](../../machine-learning/security/user-permission.md)
233
+
+ [Give users permission to execute a specific language](../../t-sql/statements/create-external-language-transact-sql.md#permissions)
239
234
240
235
> [!NOTE]
241
236
> Whether additional configuration is required depends on your security schema, where you installed SQL Server, and how you expect users to connect to the database and run external scripts.
242
237
243
238
## Suggested optimizations
244
239
245
-
Now that you have everything working, you might also want to optimize the server to support language extensions.
240
+
Now that you have everything working, you might also want to optimize the server to support Java Language Extension.
246
241
247
-
### Optimize the server for language extensions
242
+
### Optimize the server for Java Language Extension
248
243
249
244
The default settings for [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] setup are intended to optimize the balance of the server for a variety of services that are supported by the database engine, which might include extract, transform, and load (ETL) processes, reporting, auditing, and applications that use [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] data. Therefore, under the default settings, you might find that resources for language extensions are sometimes restricted or throttled, particularly in memory-intensive operations.
250
245
251
246
To ensure that language extensions jobs are prioritized and resourced appropriately, we recommend that you use SQL Server Resource Governor to configure an external resource pool. You might also want to change the amount of memory that's allocated to the [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] database engine, or increase the number of accounts that run under the [!INCLUDE[rsql_launchpad](../../includes/rsql-launchpad-md.md)] service.
252
247
253
-
- To configure a resource pool for managing external resources, see [Create an external resource pool](../../t-sql/statements/create-external-resource-pool-transact-sql.md).
248
+
+ To configure a resource pool for managing external resources, see [Create an external resource pool](../../t-sql/statements/create-external-resource-pool-transact-sql.md).
254
249
255
-
- To change the amount of memory reserved for the database, see [Server memory configuration options](../../database-engine/configure-windows/server-memory-server-configuration-options.md).
250
+
+ To change the amount of memory reserved for the database, see [Server memory configuration options](../../database-engine/configure-windows/server-memory-server-configuration-options.md).
256
251
257
252
If you are using Standard Edition and do not have Resource Governor, you can use Dynamic Management Views (DMVs) and Extended Events, as well as Windows event monitoring, to help manage the server resources.
0 commit comments