Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SqlMethodAttribute Class

Indicates the determinism and data access properties of a method or property on a user-defined type (UDT). The properties on the attribute reflect the physical characteristics that are used when the type is registered with SQL Server.

System.Object
  System.Attribute
    Microsoft.SqlServer.Server.SqlFunctionAttribute
      Microsoft.SqlServer.Server.SqlMethodAttribute

Namespace:  Microsoft.SqlServer.Server
Assembly:  System.Data (in System.Data.dll)
[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public sealed class SqlMethodAttribute : SqlFunctionAttribute

The SqlMethodAttribute type exposes the following members.

  NameDescription
Public methodSqlMethodAttributeAn attribute on a user-defined type (UDT), used to indicate the determinism and data access properties of a method or a property on a UDT.
Top
  NameDescription
Public propertyDataAccessIndicates whether the function involves access to user data stored in the local instance of SQL Server. (Inherited from SqlFunctionAttribute.)
Public propertyFillRowMethodNameThe name of a method in the same class as the table-valued function (TVF) that is used by the TVF contract. (Inherited from SqlFunctionAttribute.)
Public propertyInvokeIfReceiverIsNullIndicates whether SQL Server should invoke the method on null instances.
Public propertyIsDeterministicIndicates whether the user-defined function is deterministic. (Inherited from SqlFunctionAttribute.)
Public propertyIsMutatorIndicates whether a method on a user-defined type (UDT) is a mutator.
Public propertyIsPreciseIndicates whether the function involves imprecise computations, such as floating point operations. (Inherited from SqlFunctionAttribute.)
Public propertyNameThe name under which the function should be registered in SQL Server. (Inherited from SqlFunctionAttribute.)
Public propertyOnNullCallIndicates whether the method on a user-defined type (UDT) is called when null input arguments are specified in the method invocation.
Public propertySystemDataAccessIndicates whether the function requires access to data stored in the system catalogs or virtual system tables of SQL Server. (Inherited from SqlFunctionAttribute.)
Public propertyTableDefinitionA string that represents the table definition of the results, if the method is used as a table-valued function (TVF). (Inherited from SqlFunctionAttribute.)
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

For a property, the SqlMethodAttribute should be used on the setter or the getter directly.

SqlMethodAttribute inherits from a SqlFunctionAttribute, so SqlMethodAttribute inherits the FillRowMethodName and TableDefinition fields from SqlFunctionAttribute. Note that it is not possible to write a table-valued method, although the names of these fields might suggest that it is possible.

The following example shows a UDT method that is attributed to indicate that the method will not be invoked on null instances of the type, that the method will not change the state of the type, and that the method will not be called when null parameters are supplied to the method invocation.

// Distance from Point to the specified x and y values method.
[SqlMethod(OnNullCall = false, IsMutator=false, InvokeIfReceiverIsNull=false)]
public Double DistanceFromXY(Int32 iX, Int32 iY)
{
   return Math.Sqrt(Math.Pow(iX - _x, 2.0) + Math.Pow(iY - _y, 2.0));
}

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.