Skip to content

Commit 6bf004a

Browse files
committed
docs: Fix UUF documentation issues with editorial improvements
- Update TDE EKM example to use RSA_2048 (security best practice) - Remove duplicate LastRunFinishDateTime column in sysjobhistory example - Fix JDBC setStatementPoolingCacheSize parameter type (boolean -> int) - Fix PHP sqlsrv_connect check (!== false for resource type) - Apply Microsoft Writing Style Guide improvements to all files - Standardize Related content sections (replace 'See Also') - Update ms.date to 01/20/2026 and add ai-usage tags Fixes: AB#305743, AB#323305, AB#350656, AB#317652
1 parent 0a4eb8a commit 6bf004a

4 files changed

Lines changed: 32 additions & 23 deletions

File tree

docs/connect/jdbc/reference/setstatementpoolingcachesize-method-sqlserverdatasource.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: "setStatementPoolingCacheSize Method (SQLServerDataSource)"
33
description: "setStatementPoolingCacheSize Method (SQLServerDataSource)"
44
author: David-Engel
55
ms.author: davidengel
6-
ms.date: "01/19/2018"
6+
ms.date: 01/20/2026
7+
ai-usage: ai-assisted
78
ms.service: sql
89
ms.subservice: connectivity
910
ms.topic: reference
@@ -17,7 +18,7 @@ ms.topic: reference
1718

1819
```
1920
20-
public void setStatementPoolingCacheSize(boolean statementPoolingCacheSize);
21+
public void setStatementPoolingCacheSize(int statementPoolingCacheSize);
2122
```
2223

2324
#### Parameters
@@ -31,7 +32,8 @@ public void setStatementPoolingCacheSize(boolean statementPoolingCacheSize);
3132
## Remarks
3233
This method is available from JDBC driver version 6.4 and onward.
3334

34-
## See Also
35+
## Related content
36+
3537
[SQLServerDataSource Members](../../../connect/jdbc/reference/sqlserverdatasource-members.md)
3638
[SQLServerDataSource Class](../../../connect/jdbc/reference/sqlserverdatasource-class.md)
3739

docs/connect/php/step-4-connect-resiliently-to-sql-with-php.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: "Step 4: Connect resiliently to SQL with PHP"
33
description: Step 4 is a demo program designed to showcase how transient errors during an attempt to connect leads to a retry.
44
author: David-Engel
55
ms.author: davidengel
6-
ms.date: 05/05/2021
6+
ms.date: 01/20/2026
7+
ai-usage: ai-assisted
78
ms.service: sql
89
ms.subservice: connectivity
910
ms.topic: how-to
@@ -12,11 +13,11 @@ ms.topic: how-to
1213

1314
[!INCLUDE[Driver_PHP_Download](../../includes/driver_php_download.md)]
1415

15-
The demo program is designed so that a transient error during an attempt to connect leads to a retry. (Transient error codes start with the prefix '08' as listed in this [appendix](../../odbc/reference/appendixes/appendix-a-odbc-error-codes.md).) But a transient error during query command causes the program to discard the connection and create a new connection, before retrying the query command. We don't recommend or discourage this design choice. The demo program illustrates some of the design flexibility that is available to you.
16+
The demo program is designed so that a transient error during an attempt to connect leads to a retry. (Transient error codes start with the prefix '08' as listed in this [appendix](../../odbc/reference/appendixes/appendix-a-odbc-error-codes.md).) But a transient error during a query command causes the program to discard the connection and create a new connection, before retrying the query command. We don't recommend or discourage this design choice. The demo program illustrates some of the design flexibility that's available to you.
1617

1718
The length of this code sample is due mostly to the catch exception logic.
1819

19-
The [sqlsrv_query()](sqlsrv-query.md) function can be used to retrieve a result set from a query against SQL Database. This function essentially accepts any query and connection object and returns a result set, which can be iterated over with the use of [sqlsrv_fetch_array()](sqlsrv-fetch-array.md).
20+
You can use the [sqlsrv_query()](sqlsrv-query.md) function to retrieve a result set from a query against SQL Database. This function accepts any query and connection object and returns a result set, which can be iterated over with the use of [sqlsrv_fetch_array()](sqlsrv-fetch-array.md).
2021

2122
```php
2223

@@ -34,7 +35,7 @@ The [sqlsrv_query()](sqlsrv-query.md) function can be used to retrieve a result
3435
for ($cc = 1; $cc <= $maxCountTriesConnectAndQuery; $cc++) {
3536
// [A.2] Connect, which proceeds to issue a query command.
3637
$conn = sqlsrv_connect($serverName, $connectionOptions);
37-
if ($conn === true) {
38+
if ($conn !== false) {
3839
echo "Connection was established";
3940
echo "<br>";
4041

@@ -91,3 +92,8 @@ The [sqlsrv_query()](sqlsrv-query.md) function can be used to retrieve a result
9192
}
9293
?>
9394
```
95+
96+
## Related content
97+
98+
- [Connection resiliency](connection-resiliency.md)
99+
- [Step 3: Proof of concept connecting to SQL using PHP](step-3-proof-of-concept-connecting-to-sql-using-php.md)

docs/relational-databases/security/encryption/enable-tde-on-sql-server-using-ekm.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ description: Enable transparent data encryption in SQL Server to protect a datab
44
author: rwestMSFT
55
ms.author: randolphwest
66
ms.reviewer: vanto
7-
ms.date: 09/07/2025
7+
ms.date: 01/20/2026
8+
ai-usage: ai-assisted
89
ms.service: sql
910
ms.subservice: security
1011
ms.topic: how-to
@@ -24,24 +25,24 @@ TDE encrypts the storage of an entire database by using a symmetric key called t
2425

2526
## Limitations
2627

27-
You must be a high privileged user (such as a system administrator) to create a database encryption key and encrypt a database. The EKM module must be able to authenticate that user.
28+
You must be a high privileged user (such as a system administrator) to create a database encryption key and encrypt a database. The EKM module must be able to authenticate you.
2829

29-
At startup, the [!INCLUDE [ssDE](../../../includes/ssde-md.md)] must open the database. You should create a credential that will be authenticated by the EKM, and add it to a login that is based on an asymmetric key. Users can't sign in using that login, but the [!INCLUDE [ssDE](../../../includes/ssde-md.md)] can authenticate itself with the EKM device.
30+
At startup, the [!INCLUDE [ssDE](../../../includes/ssde-md.md)] must open the database. Create a credential that the EKM authenticates, and add it to a login based on an asymmetric key. Users can't sign in using that login, but the [!INCLUDE [ssDE](../../../includes/ssde-md.md)] can authenticate itself with the EKM device.
3031

31-
If the asymmetric key stored in the EKM module is lost, the database can't be opened by [!INCLUDE [ssNoVersion](../../../includes/ssnoversion-md.md)]. If the EKM provider lets you back up the asymmetric key, you should create a backup and store it in a secure location.
32+
If you lose the asymmetric key stored in the EKM module, [!INCLUDE [ssNoVersion](../../../includes/ssnoversion-md.md)] can't open the database. If your EKM provider lets you back up the asymmetric key, create a backup and store it in a secure location.
3233

33-
The options and parameters required by your EKM provider can differ from what is provided in the following code example. For more information, see your EKM provider.
34+
The options and parameters required by your EKM provider might differ from what's provided in the following code example. For more information, see your EKM provider.
3435

3536
## Permissions
3637

37-
This article uses the following permissions:
38+
You need the following permissions:
3839

39-
- To change a configuration option and run the `RECONFIGURE` statement, you must be granted the `ALTER SETTINGS` server-level permission. The `ALTER SETTINGS` permission is implicitly held by the **sysadmin** and **serveradmin** fixed server roles.
40+
- To change a configuration option and run the `RECONFIGURE` statement, you need the `ALTER SETTINGS` server-level permission. The **sysadmin** and **serveradmin** fixed server roles implicitly hold the `ALTER SETTINGS` permission.
4041

41-
- Requires `ALTER ANY CREDENTIAL` permission.
42-
- Requires `ALTER ANY LOGIN` permission.
43-
- Requires `CREATE ASYMMETRIC KEY` permission.
44-
- Requires `CONTROL` permission on the database to encrypt the database.
42+
- `ALTER ANY CREDENTIAL` permission.
43+
- `ALTER ANY LOGIN` permission.
44+
- `CREATE ASYMMETRIC KEY` permission.
45+
- `CONTROL` permission on the database to encrypt the database.
4546

4647
<a id="TsqlProcedure"></a>
4748

@@ -97,7 +98,7 @@ This article uses the following permissions:
9798

9899
CREATE ASYMMETRIC KEY ekm_login_key
99100
FROM PROVIDER [EKM_Prov]
100-
WITH ALGORITHM = RSA_512,
101+
WITH ALGORITHM = RSA_2048,
101102
PROVIDER_KEY_NAME = 'SQL_Server_Key';
102103
GO
103104

docs/relational-databases/system-tables/dbo-sysjobhistory-transact-sql.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ description: Contains information about the execution of scheduled jobs by the S
44
author: VanMSFT
55
ms.author: vanto
66
ms.reviewer: randolphwest
7-
ms.date: 03/27/2024
7+
ms.date: 01/20/2026
8+
ai-usage: ai-assisted
89
ms.service: sql
910
ms.subservice: system-objects
1011
ms.topic: "reference"
@@ -25,7 +26,7 @@ dev_langs:
2526
Contains information about the execution of scheduled jobs by the [SQL Server Agent](/ssms/agent/sql-server-agent).
2627

2728
> [!NOTE]
28-
> In most cases, the data is updated only after the job step completes, and the table typically contains no records for job steps that are currently in progress. In some cases, underlying processes *do* provide information about in progress job steps.
29+
> In most cases, the data updates only after the job step completes, and the table typically contains no records for job steps that are currently in progress. In some cases, underlying processes *do* provide information about in-progress job steps.
2930
3031
This table is stored in the `msdb` database.
3132

@@ -68,8 +69,7 @@ SELECT sj.name AS Name,
6869
LEN(CAST(sh.run_duration AS VARCHAR)) - 4) AS INT) % 24 AS VARCHAR), 2)
6970
+ ':' + STUFF(CAST(RIGHT(CAST(sh.run_duration AS VARCHAR), 4) AS VARCHAR(6)), 3, 0, ':')
7071
ELSE STUFF(STUFF(RIGHT(REPLICATE('0', 6) + CAST(sh.run_duration AS VARCHAR(6)), 6), 3, 0, ':'), 6, 0, ':')
71-
END AS [LastRunDuration (d.HH:MM:SS)],
72-
DATEADD(SECOND, shp.LastRunDurationSeconds, shp.LastRunStartDateTime) AS LastRunFinishDateTime
72+
END AS [LastRunDuration (d.HH:MM:SS)]
7373
FROM msdb.dbo.sysjobs sj
7474
INNER JOIN msdb.dbo.sysjobhistory sh ON sj.job_id = sh.job_id
7575
CROSS APPLY (SELECT DATETIMEFROMPARTS(sh.run_date / 10000, -- years

0 commit comments

Comments
 (0)