Refactor and update sample project build. #3816

ErikEJ · 2025-11-29T13:25:41Z

Scope: Make samples build with nor or minimal changes to actual snippets used in docs.

Added namespaces to organize code and prevent naming conflicts. Used filename as namespace, and for files with names of classes, added "CS" to namespace

Adjusted using directives to include necessary references to make build pass.

Wrapped code snippets in conditional compilation directives for mostly .NET Framework-specific APIs.

Made some changes to the .csproj file to enable local "dotnet build" - happy to revert as needed.

I will comment on any other type of changes made to a few samples.

Unsure about the sample for Microsoft.SqlServer.Server, but can revert these if needed. (and not build them)

Related to issue #3725

Scope: Make samples build with nor or minimal changes to actual snippets usied in docs. Added namespaces to organize code and prevent naming conflicts. Used filename as namespace, and for files with names of classes, added "CS" to namespace Adjusted `using` directives to include necessary references to make build pass. Wrapped code snippets in conditional compilation directives for mostly .NET Framework-specific APIs. Made some changes to the .csproj file to enable local "dotnet build" - happy to revert as needed.

Copilot

Pull request overview

This PR refactors sample code files to enable building with minimal changes to documentation snippets. The primary changes include adding namespace declarations to prevent naming conflicts and wrapping .NET Framework-specific code in conditional compilation directives.

Adds unique namespaces to all sample files, typically using the filename as the namespace name (with "CS" suffix for files with class names)
Wraps .NET Framework-specific code in #if NETFRAMEWORK directives
Adds missing using directives required for compilation
Updates project configuration to support multi-targeting (net8.0 and net462)

Reviewed changes

Copilot reviewed 228 out of 228 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
TransactionIsolationLevels.cs	Changed namespace from generic to filename-based
SqlVectorExample.cs	Added namespace, missing using directives, and changed async to sync method call
SqlUserDefinedType*.cs	Added namespaces and changed namespace references from Microsoft.Data.SqlClient.Server to Microsoft.SqlServer.Server
SqlRowUpdatingEventArgs.cs, SqlParameterCollection_*.cs, SqlDataAdapter_SelectCommand.cs, etc.	Wrapped .NET Framework-specific code in conditional compilation directives
SqlDataReader_DataDiscoveryAndClassification.cs	Fixed typo in Console method name
SqlDataAdapter_Properties.cs	Removed nested namespace and unnecessary using directive
SqlCommand_ExecuteNonQuery_SP_DML.cs	Removed unused variable declaration
SqlDataAdapter_SPIdentityReturn.cs	Changed Int to int for type consistency
SqlConfigurableRetryLogic_SqlCommand.cs	Added wrapper classes to separate code snippets
SqlClientEventSource.cs, SqlClientDiagnosticCounter.cs	Added namespaces and missing using directives
RegisterCustomKeyStoreProvider_*.cs	Added namespaces, using directives, and stub implementations for custom providers
SqlUserDefinedTypeAttribute_Type1.cs	Fixed typo in Convert.Toint method calls
Microsoft.Data.SqlClient.Samples.csproj	Added multi-targeting configuration and package reference
ConnectionStrings_Encrypt.cs	Renamed parameter for clarity

doc/samples/SqlVectorExample.cs

doc/samples/RegisterCustomKeyStoreProvider_ConnectionPrecedence.cs

doc/samples/RegisterCustomKeyStoreProvider_CommandPrecedence.cs

doc/samples/ConnectionStrings_Encrypt.cs

doc/samples/SqlConfigurableRetryLogic_SqlCommand.cs

doc/samples/Microsoft.Data.SqlClient.Samples.csproj

ErikEJ · 2025-11-29T13:28:22Z

doc/samples/AzureKeyVaultProviderWithEnclaveProviderExample.cs

@@ -1,4 +1,5 @@
-using System;
+/*


Excluded this from build, as it contains obsolete APIs

ErikEJ · 2025-11-29T13:29:49Z

doc/samples/ConnectionStringsWeb_Encrypt.cs

@@ -1,4 +1,8 @@
-using System;
+/*


Could not make this build, so commented out

ErikEJ · 2025-11-29T13:30:21Z

doc/samples/ConnectionStrings_Encrypt.cs

    }
    // <Snippet1>
-    static void ToggleConfigEncryption(string exeFile)
+    static void ToggleConfigEncryption(string exeConfigName)


Corrected parameter name to make build pass

ErikEJ · 2025-11-29T13:31:05Z

doc/samples/Microsoft.Data.SqlClient.Samples.csproj

 <Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
+    <TargetFrameworks>net8.0;net462</TargetFrameworks>


Added to make "dotnet build" work

ErikEJ · 2025-11-29T13:31:34Z

doc/samples/Microsoft.Data.SqlClient.Samples.csproj

    <PackageReference Include="Microsoft.Data.SqlClient" />
    <PackageReference Include="Microsoft.Data.SqlClient.AlwaysEncrypted.AzureKeyVaultProvider" />
    <PackageReference Include="Newtonsoft.Json" />
+    <PackageReference Include="System.Configuration.ConfigurationManager" />


Added to make build pass

ErikEJ · 2025-11-29T13:31:58Z

doc/samples/Microsoft.Data.SqlClient.Samples.csproj


  <!-- .NET Framework references -->
-  <ItemGroup Condition="$(TargetGroup) == 'netfx'">
+  <ItemGroup Condition="'$(TargetFramework)' == 'net462'">


Added to make local "dotnet build" work

ErikEJ · 2025-11-29T13:32:37Z

doc/samples/Microsoft.SqlServer.Server/csharp/SqlUserDefinedTypeAttribute_Type1.cs

        Point pt = new Point();
-        pt.X = Convert.Toint(xy[0]);
-        pt.Y = Convert.Toint(xy[1]);
+        pt.X = Convert.ToInt32(xy[0]);


Fix of incorrect sample code

ErikEJ · 2025-11-29T13:33:13Z

doc/samples/RegisterCustomKeyStoreProvider_CommandPrecedence.cs

 class Program
 {
-    static void Main()
+    static void Main(string connectionString)


Added missing parameter to make build pass

ErikEJ · 2025-11-29T13:33:41Z

doc/samples/RegisterCustomKeyStoreProvider_CommandPrecedence.cs

            {
                customKeyStoreProviders.Clear();
-                SqlColumnEncryptionAzureKeyVaultProvider azureKeyVaultProvider = new SqlColumnEncryptionAzureKeyVaultProvider();
+                SqlColumnEncryptionAzureKeyVaultProvider azureKeyVaultProvider = new SqlColumnEncryptionAzureKeyVaultProvider(new DefaultAzureCredential());


Uses the updated API to make build pass

ErikEJ · 2025-11-29T13:34:21Z

doc/samples/RegisterCustomKeyStoreProvider_CommandPrecedence.cs

 }
 // </Snippet1>
+
+class MyCustomKeyStoreProvider : SqlColumnEncryptionKeyStoreProvider


Added dummy class to make build pass (not part of snippet)

ErikEJ · 2025-11-29T13:34:50Z

doc/samples/RegisterCustomKeyStoreProvider_ConnectionPrecedence.cs

 class Program
 {
-    static void Main()
+    static void Main(string connectionString)


added missing parameter to make build pass

ErikEJ · 2025-11-29T13:35:11Z

doc/samples/RegisterCustomKeyStoreProvider_ConnectionPrecedence.cs

        {
            customKeyStoreProviders.Clear();
-            SqlColumnEncryptionAzureKeyVaultProvider azureKeyVaultProvider = new SqlColumnEncryptionAzureKeyVaultProvider();
+            SqlColumnEncryptionAzureKeyVaultProvider azureKeyVaultProvider = new SqlColumnEncryptionAzureKeyVaultProvider(new DefaultAzureCredential());


Use the updated API to make build pass

ErikEJ · 2025-11-29T13:35:46Z

doc/samples/RegisterCustomKeyStoreProvider_ConnectionPrecedence.cs

 }
 // </Snippet1>
+
+class MyCustomKeyStoreProvider : SqlColumnEncryptionKeyStoreProvider


Added dummy class to make build pass (not part of snippet)

ErikEJ · 2025-11-29T13:36:11Z

doc/samples/RegisterCustomKeyStoreProvider_Example.cs

        {
            // Create a new SqlColumnEncryptionAzureKeyVaultProvider with the user's credentials and save it for future use
-            azureKeyVaultProvider = new SqlColumnEncryptionAzureKeyVaultProvider();
+            azureKeyVaultProvider = new SqlColumnEncryptionAzureKeyVaultProvider(new DefaultAzureCredential());


Use the updated API to make build pass

ErikEJ · 2025-11-29T13:36:38Z

doc/samples/RegisterCustomKeyStoreProvider_Example.cs

        {
            // Create a new SqlColumnEncryptionAzureKeyVaultProvider with the user's credentials and save it for future use
-            azureKeyVaultProvider = new SqlColumnEncryptionAzureKeyVaultProvider();
+            azureKeyVaultProvider = new SqlColumnEncryptionAzureKeyVaultProvider(new DefaultAzureCredential());


Use the updated API to make build pass

ErikEJ · 2025-11-29T13:39:27Z

doc/samples/SqlCommand_BeginExecuteNonQueryForm.cs

@@ -1,3 +1,4 @@
+/* This does not compile, as multiple methods are missing.


Removed for build, as this is just code fragments

ErikEJ · 2025-11-29T13:40:23Z

doc/samples/SqlCommand_ExecuteNonQuery_SP_DML.cs

        {
            using (SqlConnection connection = new SqlConnection(connectionString))
            {
-                SqlCommand command = new SqlCommand(connection);


Removed to make build pass

ErikEJ · 2025-11-29T13:41:08Z

doc/samples/SqlConfigurableRetryLogic_SqlCommand.cs

        cmd.ExecuteNonQuery();
    }
 // </Snippet2>
+private class RetryCommandSample2


Added multiple classes to avoid name clashes

ErikEJ · 2025-11-29T13:41:30Z

doc/samples/SqlConfigurableRetryLogic_SqlCommand.cs

        await cmd.ExecuteNonQueryAsync();
    }
 // </Snippet3>
+}


Added multiple classes to avoid name clashes (outside of snippet)

ErikEJ · 2025-11-29T13:43:20Z

doc/samples/SqlDataAdapter_Properties.cs

 }

-namespace CSDataAdapterOperations.Properties
+internal sealed partial class Settings : System.Configuration.ApplicationSettingsBase


Removed namespace to make code build.

ErikEJ · 2025-11-29T13:44:04Z

doc/samples/SqlDataAdapter_SPIdentityReturn.cs


            // Retrieve the ReturnValue.
-            Int rowCount = (Int)adapter.InsertCommand.Parameters["@RowCount"].Value;
+            int rowCount = (int)adapter.InsertCommand.Parameters["@RowCount"].Value;


Fix typo to make code build

ErikEJ · 2025-11-29T13:44:35Z

doc/samples/SqlDataReader_DataDiscoveryAndClassification.cs

                }
            }
-            Console.Writeline($"reader.SensitivityClassification.SensitivityRank : {reader.SensitivityClassification.SensitivityRank.ToString()}");
+            Console.WriteLine($"reader.SensitivityClassification.SensitivityRank : {reader.SensitivityClassification.SensitivityRank.ToString()}");


Fix typo to make code build

ErikEJ · 2025-11-29T13:45:29Z

doc/samples/SqlDataRecord.cs

 using System.Data.Sql;
 using System.Data.SqlTypes;
-using Microsoft.Data.SqlClient.Server;
+using Microsoft.SqlServer.Server;


@cheenamalhotra Unsure if this should have been left with the Obsolete classes?

doc/samples/SqlFunction.cs

doc/samples/SqlMetaData.cs

ErikEJ · 2025-11-29T13:46:56Z

doc/samples/SqlMethod.cs

 using System.Data;
 // <Snippet1>
-using Microsoft.Data.SqlClient.Server;
+using Microsoft.SqlServer.Server;


@cheenamalhotra Unsure if this should have been left with the Obsolete classes?

No, I think this was missed out, thanks for fixing it.

ErikEJ · 2025-11-29T13:47:44Z

doc/samples/SqlUserDefinedType.cs

 using System.Data;
 // <Snippet1>
-using Microsoft.Data.SqlClient.Server;
+using Microsoft.SqlServer.Server;


@cheenamalhotra Unsure if this should have been left with the Obsolete classes?

ErikEJ · 2025-11-29T13:48:19Z

doc/samples/SqlVectorExample.cs

        cmd.Parameters.Add(p);

-        await cmd.PrepareAsync();
+        cmd.Prepare();


Make sample build on NetFX

Copilot AI review requested due to automatic review settings November 29, 2025 13:25

ErikEJ requested a review from a team as a code owner November 29, 2025 13:25

Copilot AI reviewed Nov 29, 2025

View reviewed changes

ErikEJ commented Nov 29, 2025

View reviewed changes

doc/samples/ConnectionStringsWeb_Encrypt.cs

@@ -1,4 +1,8 @@

using System;

/*

Copy link

Contributor Author

ErikEJ Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could not make this build, so commented out

ErikEJ commented Nov 29, 2025

View reviewed changes

doc/samples/SqlFunction.cs Show resolved Hide resolved

ErikEJ commented Nov 29, 2025

View reviewed changes

doc/samples/SqlMetaData.cs Show resolved Hide resolved

ErikEJ commented Nov 29, 2025

View reviewed changes

		@@ -1,3 +1,4 @@
		/* This does not compile, as multiple methods are missing.

Refactor and update sample project build. #3816

Are you sure you want to change the base?

Refactor and update sample project build. #3816

Conversation

ErikEJ commented Nov 29, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ErikEJ Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ErikEJ Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

ErikEJ Nov 29, 2025 •

edited

Loading

ErikEJ Nov 29, 2025 •

edited

Loading