Readme_Spatial Sample

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

This sample works only with SQL Server 2005 and SQL Server 2008. It will not work with any version of SQL Server earlier than SQL Server 2005.

SQL Server provides powerful indexing and query capabilities for basic types of data, such as integers, strings, and dates. However, existing indexing and query capabilities might be insufficient for large data sets containing complex data. The Spatial sample demonstrates how you can use common language runtime (CLR) integration technology in SQL Server to enhance the basic indexing and query capabilities to support more sophisticated types of data and queries over that data. Although the spatial sample is designed for supporting geospatial and celestial queries, the concepts behind the sample could be used for many other kinds of data.

This sample contains the following:

  1. An entire class library for representing and manipulating spatial information
  2. A sample database with spatial information
  3. Detailed documentation about the concepts behind the sample and the algorithms used.
  4. Installation and testing scripts

Install directory: C:\Program Files\Microsoft SQL Server\100\Samples\Engine\Programmability\CLR\Spatial\

SQL Server samples and sample databases must be downloaded and installed before you can view or work with them. For more information, see Considerations for Installing SQL Server Samples and Sample Databases.


Jane is a developer for Adventure Works Cycles. She needs to represent, manipulate, and query spatial information.


Transact-SQL, Visual C#, and Visual Basic.


The Spatial sample uses the following features of SQL Server.

Application Area Features


CLR, table-valued functions, Transact-SQL


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

  • SQL Server or SQL Server Express. You can obtain SQL Server Express free of charge from the SQL Server Express Documentation and Samples Web site.
  • The SQL Server Database Engine samples. These samples are included with SQL Server. You can download the latest version of the samples at the SQL Server Developer Web site.
  • .NET Framework SDK 2.0 or Microsoft Visual Studio 2005. You can obtain .NET Framework SDK free of charge. For more information, see Installing the .NET Framework Documentation.

Building the Sample

If you have not already created a strong name key file, generate the key file using the following instructions.

To generate a strong name key file

  1. Open a Microsoft Visual Studio 2005 command prompt. Click Start, point to All Programs, point to Microsoft .NET Framework SDK 2.0, and then click SDK Command Prompt.

    -- or --

    Open a Microsoft .NET Framework command prompt. Click Start, point to All Programs, point to Microsoft .NET Framework SDK 2.0, and then click SDK Command Prompt.

  2. Use the change directory command (CD) to change the current directory of the command prompt window to the folder where the samples are installed.


    To determine the folder where samples are located, click the Start button, point to All Programs, point to Microsoft SQL Server, point to Documentation and Tutorials, and then click Samples Directory. If the default installation location was used, the samples are located in <system_drive>:\Program Files\Microsoft SQL Server\100\Samples.

  3. At the command prompt, run the following command to generate the key file:

    sn -k SampleKey.snk


    For more information about the strong-name key pair, see "Security Briefs: Strong Names and Security in the .NET Framework" in the .NET Development Center on MSDN.

To build the Spatial sample

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

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

  2. If you did not install the SQL Server Database Engine samples in the default location, modify the path in the CREATE ASSEMBLY part of the script in Scripts\spHtmCsharp.sql and the path to the database in the Scripts\AttachSpatialDatabase.bat file to refer to the location where the samples were installed.

  3. Attach the Spatial database by running the Scripts\AttachSpatialDatabase.bat file in a command prompt window.

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

  5. Open the scripts\spHtmCsharp.sql in SQL Server Management Studio. Run the script contained in the file, or run a command similar to the following in a command prompt window:

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

Running the Sample

To run the Spatial sample

  1. Open the Scripts\TestScript.sql file in Management Studio. Run the script that is contained in the file, or run a command similar to the following in a command prompt window:

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


The CLR for SQL Server 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.

See Also


Readme_AdventureWorks Cycles CLR Layer Sample

Help and Information

Getting SQL Server 2008 R2 Assistance