The UTF8String sample for SQL Server 2005 demonstrates the implementation of a user-defined data type. This sample shows the implementation of a UTF8 user-defined data type that extends the type system of the database to provide storage for UTF8-encoded values. This type also implements code to convert Unicode strings to and from UTF8.

Note:
When you compile common language runtime integration samples, the path of the version of the Microsoft .NET Framework compiler that was distributed with SQL Server 2005 must be the first Framework directory in the PATH environment variable. The location of the compiler that is included with SQL Server 2005 is either drive:\WINNT\Microsoft.NET\Framework\v2.0.xxxxx or drive:\Windows\Microsoft.NET\Framework\v2.0.xxxxx, where drive is the installation drive and xxxxx is the version of the .NET Framework that is included with SQL Server 2005.

The default installation directory is drive:\Program Files\Microsoft SQL Server\90\Samples\Engine\Programmability\CLR\UTF8String.

Scenario

A developer wants to represent, persist, and manipulate strings using the single byte Unicode encoding.

Languages

Transact-SQL, Visual C# and Visual Basic.

Features

The UTF8String sample uses the following features of SQL Server 2005:

Application Area Features

Overall

CLR

Prerequisites

Before running this sample, make sure the following software is installed:

  • SQL Server 2005 or SQL Server 2005 Express Edition (SQL Server Express). You can obtain SQL Server Express free of charge from the SQL Server 2005 Express Edition Documentation and Samples Web site.

  • The AdventureWorks database that is included with SQL Server 2005. It is also available at the SQL Server 2005 Express Edition Documentation and Samples Web site.

  • The SQL Server 2005 Database Engine samples. These samples are included with SQL Server 2005, and are also included with the Microsoft Microsoft .NET Framework version 2.0 SDK 2.0.

  • .NET Framework SDK 2.0 or Microsoft Visual Studio 2005. You can obtain .NET Framework SDK free of charge. See Installing the .NET Framework SDK.

Building the Sample

To build the sample, do the following:

Build the sample

  1. CD to the install directory and execute the following at a .NET Framework or Microsoft Visual Studio 2005 command prompt:

    sn -k keypair.snk

  2. Compile the sample by using Visual Studio 2005 and the provided Visual Studio solution, or by using , which is included in the .NET Framework SDK 2.0, by executing a command similar to the following at the command prompt:

    msbuild /nologo /verbosity:quiet /property:Configuration=Debug CS\UTF8String.sln

  3. Ensure that the AdventureWorks database is installed.

  4. If you did not install the SQL Server engine samples in the default location, modify the path in the CREATE ASSEMBLY portion of the script in Scripts\InstallCS.sql and Scripts\InstallVB.sql to refer to location where the samples were installed.

  5. If you are not an administrator for the SQL Server instance you are using, you must have an administrator grant you CreateAssembly permissions to complete the installation.

  6. Open the scripts\installCS.sql or scripts\installVB.sql file, depending on whether you compiled the Visual C# project or the Visual Basic project, in SQL Server Management Studio. Execute the script contained in the file or execute a command similar to the following at the command prompt:

    sqlcmd -E -I -i Scripts\InstallCS.sql

    This file contains the script to install and register the user-defined data type in SQL Server.

Running the Sample

To run the sample, do the following:

Run the sample

  1. Open the scripts\test.sql file in SQL Server Management Studio and execute the script contained in the file, or execute the following command at the command prompt:

    sqlcmd -E -I -i Scripts\test.sql

    This script shows usage examples of the sample.

Removing the Sample

To remove the sample, do the following:

Remove the sample

  1. Open the scripts\cleanup.sql file in SQL Server Management Studio and execute the script contained in the file, or execute the following command at the command prompt:

    sqlcmd -E -I -i Scripts\cleanup.sql

    This script removes the sample.

Comments

The CLR for SQL Server 2005 or SQL Server Express must be enabled for this sample to work correctly.

Samples are provided for educational purposes only. They are not intended to be used in a production environment and have not been tested in a production environment. Microsoft does not provide technical support for these samples. Sample applications and assemblies should not be connected to or used with your production SQL Server database or your report server without the permission of the system administrator.