Export (0) Print
Expand All

SqlFunctionAttribute Class

Used to mark a method definition of a user-defined aggregate as a function in SQL Server. The properties on the attribute reflect the physical characteristics 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)

'Declaration
<SerializableAttribute> _
<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple := False, Inherited := False)> _
Public Class SqlFunctionAttribute _
	Inherits Attribute

The SqlFunctionAttribute type exposes the following members.

  NameDescription
Public methodSqlFunctionAttributeAn optional attribute on a user-defined aggregate, used to indicate that the method should be registered in SQL Server as a function. Also used to set the DataAccess, FillRowMethodName, IsDeterministic, IsPrecise, Name, SystemDataAccess, and TableDefinition properties of the function attribute.
Top

  NameDescription
Public propertyDataAccessIndicates whether the function involves access to user data stored in the local instance of SQL Server.
Public propertyFillRowMethodNameThe name of a method in the same class as the table-valued function (TVF) that is used by the TVF contract.
Public propertyIsDeterministicIndicates whether the user-defined function is deterministic.
Public propertyIsPreciseIndicates whether the function involves imprecise computations, such as floating point operations.
Public propertyNameThe name under which the function should be registered in SQL Server.
Public propertySystemDataAccessIndicates whether the function requires access to data stored in the system catalogs or virtual system tables of SQL Server.
Public propertyTableDefinitionA string that represents the table definition of the results, if the method is used as a table-valued function (TVF).
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.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
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.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
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

The following example shows an aggregate function that returns a list of files in the specified directory path.

<SqlFunction(FillRowMethodName:="FillFileRow")> _
Public Shared Function GetFileDetails(ByVal directoryPath As String) As IEnumerable

   Try 

      Dim di As DirectoryInfo = new DirectoryInfo(directoryPath)
      return di.GetFiles()

   Catch dnf As DirectoryNotFoundException

      Dim message As String() = {dnf.ToString() }
      return message

   End Try 
End Function

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.
Show:
© 2014 Microsoft