-
Notifications
You must be signed in to change notification settings - Fork 293
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
XML Documentation Fixes - Batch 4 (#2863)
* Batch 4 * Touching up and fixing mistakes * Tabs to spaces * Using new sample file
- Loading branch information
Showing
13 changed files
with
4,396 additions
and
2,108 deletions.
There are no files selected for viewing
967 changes: 529 additions & 438 deletions
967
doc/snippets/Microsoft.Data.SqlClient/SqlCommandBuilder.xml
Large diffs are not rendered by default.
Oops, something went wrong.
66 changes: 38 additions & 28 deletions
66
doc/snippets/Microsoft.Data.SqlClient/SqlCommandColumnEncryptionSetting.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,39 @@ | ||
<docs> | ||
<members name="SqlCommandColumnEncryptionSetting"> | ||
<SqlCommandColumnEncryptionSetting> | ||
<summary>Note that these settings cannot be used to bypass encryption and gain access to plaintext data. For details, see <see href="https://docs.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine">Always Encrypted (Database Engine)</see>. | ||
</summary> | ||
<remarks> | ||
<format type="text/markdown"><![CDATA[ | ||
## Remarks | ||
- If Always Encrypted is disabled for a query and the query has parameters that need to be encrypted (parameters that correspond to encrypted columns), the query will fail. | ||
- If Always Encrypted is disabled for a query and the query returns results from encrypted columns, the query will return encrypted values. The encrypted values will have the varbinary datatype. | ||
]]></format> | ||
</remarks> | ||
</SqlCommandColumnEncryptionSetting> | ||
<Disabled> | ||
<summary>Specifies the connection does not use Always Encrypted. Should be used if no queries sent over the connection access encrypted columns.</summary> | ||
</Disabled> | ||
<Enabled> | ||
<summary>Enables Always Encrypted for the query.</summary> | ||
</Enabled> | ||
<ResultSetOnly> | ||
<summary>Specifies that only the results of the command should be processed by the Always Encrypted routine in the driver. Use this value when the command has no parameters that require encryption.</summary> | ||
</ResultSetOnly> | ||
<UseConnectionSetting> | ||
<summary>Specifies that the command should default to the Always Encrypted setting in the connection string.</summary> | ||
</UseConnectionSetting> | ||
</members> | ||
<docs> | ||
<members name="SqlCommandColumnEncryptionSetting"> | ||
<SqlCommandColumnEncryptionSetting> | ||
<summary> | ||
Note that these settings cannot be used to bypass encryption and gain access to plaintext data. For details, see <see href="https://docs.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine">Always Encrypted (Database Engine)</see>. | ||
</summary> | ||
<remarks> | ||
<list type="bullet"> | ||
<item> | ||
If Always Encrypted is disabled for a query and the query has parameters that need to be encrypted (parameters that correspond to encrypted columns), the query will fail. | ||
</item> | ||
<item> | ||
If Always Encrypted is disabled for a query and the query returns results from encrypted columns, the query will return encrypted values. The encrypted values will have the varbinary datatype. | ||
</item> | ||
</list> | ||
</remarks> | ||
</SqlCommandColumnEncryptionSetting> | ||
<Disabled> | ||
<summary> | ||
Specifies the connection does not use Always Encrypted. Should be used if no queries sent over the connection access encrypted columns. | ||
</summary> | ||
</Disabled> | ||
<Enabled> | ||
<summary> | ||
Enables Always Encrypted for the query. | ||
</summary> | ||
</Enabled> | ||
<ResultSetOnly> | ||
<summary> | ||
Specifies that only the results of the command should be processed by the Always Encrypted routine in the driver. Use this value when the command has no parameters that require encryption. | ||
</summary> | ||
</ResultSetOnly> | ||
<UseConnectionSetting> | ||
<summary> | ||
Specifies that the command should default to the Always Encrypted setting in the connection string. | ||
</summary> | ||
</UseConnectionSetting> | ||
</members> | ||
</docs> |
364 changes: 249 additions & 115 deletions
364
doc/snippets/Microsoft.Data.SqlClient/SqlConfigurableRetryFactory.xml
Large diffs are not rendered by default.
Oops, something went wrong.
4,645 changes: 3,325 additions & 1,320 deletions
4,645
doc/snippets/Microsoft.Data.SqlClient/SqlConnection.xml
Large diffs are not rendered by default.
Oops, something went wrong.
64 changes: 40 additions & 24 deletions
64
doc/snippets/Microsoft.Data.SqlClient/SqlConnectionAttestationProtocol.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,41 @@ | ||
<docs> | ||
<members name="SqlConnectionAttestationProtocol"> | ||
<SqlConnectionAttestationProtocol> | ||
<summary> | ||
Specifies a value for Attestation Protocol. | ||
</summary> | ||
</SqlConnectionAttestationProtocol> | ||
<NotSpecified> | ||
<summary>If the attestation protocol is not specified. Use this as default value.</summary> | ||
<value>0</value> | ||
</NotSpecified> | ||
<AAS> | ||
<summary>Attestation portocol for Azure Attestation Service</summary> | ||
<value>1</value> | ||
</AAS> | ||
<None> | ||
<summary>Attestation protocol for no attestation. Only compatible with Virtualization-based security (VBS) enclaves. An Enclave Attestation Url is not required when using this protocol.</summary> | ||
<value>2</value> | ||
</None> | ||
<HGS> | ||
<summary>Attestation protocol for Host Guardian Service</summary> | ||
<value>3</value> | ||
</HGS> | ||
</members> | ||
<docs> | ||
<members name="SqlConnectionAttestationProtocol"> | ||
<SqlConnectionAttestationProtocol> | ||
<summary> | ||
Specifies a value for Attestation Protocol. | ||
</summary> | ||
</SqlConnectionAttestationProtocol> | ||
<NotSpecified> | ||
<summary> | ||
If the attestation protocol is not specified. Use this as default value. | ||
</summary> | ||
<value> | ||
0 | ||
</value> | ||
</NotSpecified> | ||
<AAS> | ||
<summary> | ||
Attestation protocol for Azure Attestation Service | ||
</summary> | ||
<value> | ||
1 | ||
</value> | ||
</AAS> | ||
<None> | ||
<summary> | ||
Attestation protocol for no attestation. Only compatible with Virtualization-based security (VBS) enclaves. An Enclave Attestation Url is not required when using this protocol. | ||
</summary> | ||
<value> | ||
2 | ||
</value> | ||
</None> | ||
<HGS> | ||
<summary> | ||
Attestation protocol for Host Guardian Service | ||
</summary> | ||
<value> | ||
3 | ||
</value> | ||
</HGS> | ||
</members> | ||
</docs> |
32 changes: 18 additions & 14 deletions
32
doc/snippets/Microsoft.Data.SqlClient/SqlConnectionColumnEncryptionSetting.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,19 @@ | ||
<?xml version="1.0"?> | ||
<docs> | ||
<members name="SqlConnectionColumnEncryptionSetting"> | ||
<SqlConnectionColumnEncryptionSetting> | ||
<summary>Note that these settings cannot be used to bypass encryption and gain access to plaintext data. For details, see <see href="https://docs.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine">Always Encrypted (Database Engine)</see>.</summary> | ||
<remarks>To be added.</remarks> | ||
</SqlConnectionColumnEncryptionSetting> | ||
<Disabled> | ||
<summary>Specifies the connection does not use Always Encrypted. Should be used if no queries sent over the connection access encrypted columns.</summary> | ||
</Disabled> | ||
<Enabled> | ||
<summary>Enables Always Encrypted functionality for the connection. Query parameters that correspond to encrypted columns will be transparently encrypted and query results from encrypted columns will be transparently decrypted.</summary> | ||
</Enabled> | ||
</members> | ||
<docs> | ||
<members name="SqlConnectionColumnEncryptionSetting"> | ||
<SqlConnectionColumnEncryptionSetting> | ||
<summary> | ||
Note that these settings cannot be used to bypass encryption and gain access to plaintext data. For details, see <see href="https://docs.microsoft.com/sql/relational-databases/security/encryption/always-encrypted-database-engine">Always Encrypted (Database Engine)</see>. | ||
</summary> | ||
</SqlConnectionColumnEncryptionSetting> | ||
<Disabled> | ||
<summary> | ||
Specifies the connection does not use Always Encrypted. Should be used if no queries sent over the connection access encrypted columns. | ||
</summary> | ||
</Disabled> | ||
<Enabled> | ||
<summary> | ||
Enables Always Encrypted functionality for the connection. Query parameters that correspond to encrypted columns will be transparently encrypted and query results from encrypted columns will be transparently decrypted. | ||
</summary> | ||
</Enabled> | ||
</members> | ||
</docs> |
62 changes: 38 additions & 24 deletions
62
doc/snippets/Microsoft.Data.SqlClient/SqlConnectionEncryptOption.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 37 additions & 39 deletions
76
doc/snippets/Microsoft.Data.SqlClient/SqlConnectionIPAddressPreference.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,38 @@ | ||
<docs> | ||
<members name="SqlConnectionIPAddressPreference"> | ||
<SqlConnectionIPAddressPreferenceNetfx> | ||
<summary> | ||
Specifies a value for IP address preference during a TCP connection. | ||
</summary> | ||
<remarks> | ||
<format type="text/markdown"><![CDATA[ | ||
## Remarks | ||
If `Multi Subnet Failover` or "Transparent Network IP Resolution" is set to `true`, this setting has no effect. | ||
]]></format> | ||
</remarks> | ||
</SqlConnectionIPAddressPreferenceNetfx> | ||
<SqlConnectionIPAddressPreference> | ||
<summary> | ||
Specifies a value for IP address preference during a TCP connection. | ||
</summary> | ||
<remarks> | ||
<format type="text/markdown"><![CDATA[ | ||
## Remarks | ||
If `Multi Subnet Failover` is set to `true`, this setting has no effect. | ||
]]></format> | ||
</remarks> | ||
</SqlConnectionIPAddressPreference> | ||
<IPv4First> | ||
<summary>Connects using IPv4 address(es) first. If the connection fails, try IPv6 address(es), if provided. This is the default value.</summary> | ||
<value>0</value> | ||
</IPv4First> | ||
<IPv6First> | ||
<summary>Connect using IPv6 address(es) first. If the connection fails, try IPv4 address(es), if available.</summary> | ||
<value>1</value> | ||
</IPv6First> | ||
<UsePlatformDefault> | ||
<summary>Connects with IP addresses in the order the underlying platform or operating system provides them.</summary> | ||
<value>2</value> | ||
</UsePlatformDefault> | ||
</members> | ||
<docs> | ||
<members name="SqlConnectionIPAddressPreference"> | ||
<SqlConnectionIPAddressPreferenceNetfx> | ||
<summary> | ||
Specifies a value for IP address preference during a TCP connection. | ||
</summary> | ||
<remarks> | ||
If <c>Multi Subnet Failover</c> or <c>Transparent Network IP Resolution</c> is set to <c>true</c>, this setting has no effect. | ||
</remarks> | ||
</SqlConnectionIPAddressPreferenceNetfx> | ||
<SqlConnectionIPAddressPreference> | ||
<summary> | ||
Specifies a value for IP address preference during a TCP connection. | ||
</summary> | ||
<remarks> | ||
If <c>Multi Subnet Failover</c> is set to <c>true</c>, this setting has no effect. | ||
</remarks> | ||
</SqlConnectionIPAddressPreference> | ||
<IPv4First> | ||
<summary> | ||
Connects using IPv4 address(es) first. If the connection fails, try IPv6 address(es), if provided. This is the default value. | ||
</summary> | ||
<value>0</value> | ||
</IPv4First> | ||
<IPv6First> | ||
<summary> | ||
Connect using IPv6 address(es) first. If the connection fails, try IPv4 address(es), if available. | ||
</summary> | ||
<value>1</value> | ||
</IPv6First> | ||
<UsePlatformDefault> | ||
<summary> | ||
Connects with IP addresses in the order the underlying platform or operating system provides them. | ||
</summary> | ||
<value>2</value> | ||
</UsePlatformDefault> | ||
</members> | ||
</docs> |
40 changes: 24 additions & 16 deletions
40
doc/snippets/Microsoft.Data.SqlClient/SqlConnectionOverrides.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,25 @@ | ||
<docs> | ||
<members name="SqlConnectionOverrides"> | ||
<SqlConnectionOverrides> | ||
<summary> | ||
Specifies a value for Overrides. | ||
</summary> | ||
</SqlConnectionOverrides> | ||
<None> | ||
<summary>No overrides.</summary> | ||
<value>0</value> | ||
</None> | ||
<OpenWithoutRetry> | ||
<summary>Disable transient fault handling during the initial SqlConnection Open attempt.</summary> | ||
<value>1</value> | ||
</OpenWithoutRetry> | ||
</members> | ||
<docs> | ||
<members name="SqlConnectionOverrides"> | ||
<SqlConnectionOverrides> | ||
<summary> | ||
Specifies a value for Overrides. | ||
</summary> | ||
</SqlConnectionOverrides> | ||
<None> | ||
<summary> | ||
No overrides. | ||
</summary> | ||
<value> | ||
0 | ||
</value> | ||
</None> | ||
<OpenWithoutRetry> | ||
<summary> | ||
Disable transient fault handling during the initial <see cref="T:Microsoft.Data.SqlClient.SqlConnection" /> <see cref="M:Microsoft.Data.SqlClient.SqlConnection.Open" /> attempt. | ||
</summary> | ||
<value> | ||
1 | ||
</value> | ||
</OpenWithoutRetry> | ||
</members> | ||
</docs> |
Oops, something went wrong.