UserDefinedFunction 类
UserDefinedFunction 对象表示 SQL Server 用户定义函数。
继承层次结构
System. . :: . .Object
Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
Microsoft.SqlServer.Management.Smo. . :: . .NamedSmoObject
Microsoft.SqlServer.Management.Smo. . :: . .ScriptNameObjectBase
Microsoft.SqlServer.Management.Smo. . :: . .ScriptSchemaObjectBase
Microsoft.SqlServer.Management.Smo..::..UserDefinedFunction
命名空间: Microsoft.SqlServer.Management.Smo
程序集: Microsoft.SqlServer.Smo(在 Microsoft.SqlServer.Smo.dll 中)
语法
声明
<StateChangeEventAttribute("CREATE_FUNCTION", "FUNCTION")> _
<StateChangeEventAttribute("RENAME", "FUNCTION")> _
<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "FUNCTION")> _
<StateChangeEventAttribute("ALTER_FUNCTION", "FUNCTION")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)> _
<StateChangeEventAttribute("ALTER_SCHEMA", "FUNCTION")> _
Public NotInheritable Class UserDefinedFunction _
Inherits ScriptSchemaObjectBase _
Implements ICreatable, IAlterable, IRenamable, IDroppable, _
IExtendedProperties, IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission, _
IObjectPermission
用法
Dim instance As UserDefinedFunction
[StateChangeEventAttribute("CREATE_FUNCTION", "FUNCTION")]
[StateChangeEventAttribute("RENAME", "FUNCTION")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "FUNCTION")]
[StateChangeEventAttribute("ALTER_FUNCTION", "FUNCTION")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)]
[StateChangeEventAttribute("ALTER_SCHEMA", "FUNCTION")]
public sealed class UserDefinedFunction : ScriptSchemaObjectBase,
ICreatable, IAlterable, IRenamable, IDroppable, IExtendedProperties,
IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission, IObjectPermission
[StateChangeEventAttribute(L"CREATE_FUNCTION", L"FUNCTION")]
[StateChangeEventAttribute(L"RENAME", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_AUTHORIZATION_DATABASE", L"FUNCTION")]
[StateChangeEventAttribute(L"ALTER_FUNCTION", L"FUNCTION")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
[StateChangeEventAttribute(L"ALTER_SCHEMA", L"FUNCTION")]
public ref class UserDefinedFunction sealed : public ScriptSchemaObjectBase,
ICreatable, IAlterable, IRenamable, IDroppable, IExtendedProperties,
IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission, IObjectPermission
[<SealedAttribute>]
[<StateChangeEventAttribute("CREATE_FUNCTION", "FUNCTION")>]
[<StateChangeEventAttribute("RENAME", "FUNCTION")>]
[<StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "FUNCTION")>]
[<StateChangeEventAttribute("ALTER_FUNCTION", "FUNCTION")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)>]
[<StateChangeEventAttribute("ALTER_SCHEMA", "FUNCTION")>]
type UserDefinedFunction =
class
inherit ScriptSchemaObjectBase
interface ICreatable
interface IAlterable
interface IRenamable
interface IDroppable
interface IExtendedProperties
interface IScriptable
interface ITextObject
interface ISfcSupportsDesignMode
interface IColumnPermission
interface IObjectPermission
end
public final class UserDefinedFunction extends ScriptSchemaObjectBase implements ICreatable, IAlterable, IRenamable, IDroppable, IExtendedProperties, IScriptable, ITextObject, ISfcSupportsDesignMode, IColumnPermission, IObjectPermission
UserDefinedFunction 类型公开以下成员。
构造函数
名称 | 说明 | |
---|---|---|
UserDefinedFunction() () () () | 初始化 UserDefinedFunction 类的新实例。 | |
UserDefinedFunction(Database, String) | 在指定的数据库上使用指定名称初始化 UserDefinedFunction 类的新实例。 | |
UserDefinedFunction(Database, String, String) | 在指定的数据库上使用指定名称和架构初始化 UserDefinedFunction 类的新实例。 |
页首
属性
名称 | 说明 | |
---|---|---|
AnsiNullsStatus | 获取 Boolean 属性值,该值指定是否在用户定义函数中启用 ISO NULL 处理。 | |
AssemblyName | 获取或设置用户定义函数的程序集的名称。 | |
Checks | 表示 Check 对象的集合。每个 Check 对象都表示对用户定义函数定义的一个检查约束。 | |
ClassName | 获取或设置用户定义函数的类的名称。 | |
Columns | 表示 Column 对象的集合。每个 Column 对象都表示对用户定义函数定义的一个列。 | |
CreateDate | 获取创建用户定义函数的日期和时间。 | |
DataType | 获取或设置标量函数的返回类型。 | |
DateLastModified | 获取上次修改用户定义函数的日期和时间。 | |
Events | 获取与用户定义函数关联的事件。 | |
ExecuteForScalar | 获取或设置 Boolean 属性值,该值指定对象是否设置为针对标量选项执行。 (从 SqlSmoObject 继承。) | |
ExecutionContext | 获取或设置用户定义函数的执行上下文。 | |
ExecutionContextPrincipal | 获取或设置用户定义函数的执行上下文主体。 | |
ExtendedProperties | 获取 UserDefinedFunction 对象的扩展属性。 | |
FunctionType | 获取或设置用户定义函数类型。 | |
ID | 获取唯一标识用户定义函数的 ID 值。 | |
ImplementationType | 获取或设置用户定义函数的实现类型。 | |
Indexes | 表示 Index 对象的集合。每个 Index 对象都表示对用户定义函数定义的一个索引。 | |
IsDeterministic | 获取或设置 Boolean 属性值,该值指定用户定义函数是否是确定的。 | |
IsEncrypted | 获取或设置 Boolean 属性值,该值指定用户定义函数是否是加密的。 | |
IsSchemaBound | 获取或设置 Boolean 属性值,该值指定用户定义函数是否绑定到某一架构。 | |
IsSchemaOwned | 获取一个 Boolean 值,该值指示 UserDefinedFunction 对象是否由架构拥有。 | |
IsSystemObject | 获取 Boolean 属性值,该值指定用户定义函数是否是系统对象。 | |
IsTouched | 获取 Boolean 属性值,该值指定在服务器上对象属性是否已更新但尚未持久化。 (从 SqlSmoObject 继承。) | |
MethodName | 获取用户定义函数的方法。 | |
Name | 获取或设置一个 String 值,该值指定用户定义函数的名称。 (覆盖 ScriptSchemaObjectBase. . :: . .Name。) | |
ObjectInSpace | 获取 Boolean 属性值,该值指定对象是否单独存在,或者对象是否直接或间接连接到 SQL Server 的实例。 (从 SqlSmoObject 继承。) | |
OrderColumns | 获取与此用户定义函数关联的 OrderColumnsCollection。 | |
Owner | 获取 UserDefinedFunction 对象的所有者的名称。 | |
Parameters | 表示 Parameter 对象的集合。每个 Parameter 对象都表示为用户定义函数定义的参数。 | |
Parent | 获取或设置是 UserDefinedFunction 对象的父对象的 Database 对象。 | |
Properties | 获取表示对象属性的 Property 对象的集合。 (从 SqlSmoObject 继承。) | |
QuotedIdentifierStatus | 获取或设置一个 Boolean 属性值,该值指定由双引号分隔的标识符是否为 Transact-SQL 保留关键字,或者是否包含用户定义函数中的 Transact-SQL 语法规则通常不允许的字符。 | |
ReturnsNullOnNullInput | 获取或设置 Boolean 属性,该属性指定在至少一个函数参数为 Null 的情况下是否调用该函数。 | |
ScalarResult | 获取所引用对象的标量结果。 (从 SqlSmoObject 继承。) | |
Schema | 获取或设置一个 String 值,该值指定包含用户定义函数的架构的名称。 (覆盖 ScriptSchemaObjectBase. . :: . .Schema。) | |
State | Gets the state of the referenced object. (从 SmoObjectBase 继承。) | |
TableVariableName | 获取或设置表变量名称。 | |
TextBody | 获取或设置用于定义用户定义函数的 Transact-SQL 字符串。 | |
TextHeader | 获取或设置用于定义用户定义函数的 Transact-SQL 字符串的标头部分。 | |
TextMode | 获取或设置 Boolean 属性,该属性指定文本标头是否可作为文本编辑。 | |
Urn | 获取唯一标识对象的统一资源名称 (URN) 地址值。 (从 SqlSmoObject 继承。) | |
UserData | Gets or sets user-defined data associated with the referenced object. (从 SmoObjectBase 继承。) |
页首
方法
页首
事件
名称 | 说明 | |
---|---|---|
PropertyChanged | 表示更改属性时发生的事件。 (从 SqlSmoObject 继承。) | |
PropertyMetadataChanged | 表示属性元数据更改时发生的事件。 (从 SqlSmoObject 继承。) |
页首
字段
名称 | 说明 | |
---|---|---|
m_ExtendedProperties | 表示一个属性,可以对该属性进行定义以便扩展 SqlSmoObject 提供的属性。 (从 SqlSmoObject 继承。) | |
singletonParent | 表示单一父级。 (从 SqlSmoObject 继承。) |
页首
显式接口实现
名称 | 说明 | |
---|---|---|
IAlienObject. . :: . .Discover | 发现任何依赖关系。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。) | |
IAlienObject. . :: . .GetDomainRoot | 返回域的根。 (从 SqlSmoObject 继承。) | |
IAlienObject. . :: . .GetParent | 获取此对象的父对象。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。) | |
IAlienObject. . :: . .GetPropertyType | 获取指定属性的类型。 (从 SqlSmoObject 继承。) | |
IAlienObject. . :: . .GetPropertyValue | 获取指定属性的值。 (从 SqlSmoObject 继承。) | |
IAlienObject. . :: . .GetUrn | 获取对象的统一资源名称。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。) | |
IAlienObject. . :: . .Resolve | 获取一个实例,该实例包含与来自该对象的统一资源名称的对象有关的信息。 (从 SqlSmoObject 继承。) | |
IAlienObject. . :: . .SetObjectState | 将对象状态设置为指定的 SfcObjectState 值。 (从 SqlSmoObject 继承。) | |
IAlienObject. . :: . .SetPropertyValue | 设置属性值。 (从 SqlSmoObject 继承。) | |
ISfcPropertyProvider. . :: . .GetPropertySet | 获取对此对象的属性集的接口引用。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。) | |
ISfcSupportsDesignMode. . :: . .IsDesignMode | 获取一个 Boolean 值,该值指定用户定义函数是否支持设计模式。 |
页首
注释
The UserDefinedFunction object provides functionality that allows users to programmatically manage functions.
To get UserDefinedFunction object properties, users can be a member of the public fixed server role.
To set UserDefinedFunction object properties, users must have ALTER permission on the user-defined function.
To create a user-defined function, users must have CREATE FUNCTION permission on the database and ALTER permission on the specified schema.
To drop a user-defined function, users must have CONTROL permission on the user-defined function and ALTER permission on the specified schema.
To grant, deny, or revoke permissions on the user-defined function to other users, users must have CONTROL permission on the user-defined function.
Thread Safety
此类型的任何公共静态(Microsoft Visual Basic 中的 Shared)成员在多线程操作中是安全的。不保证所有实例成员都是线程安全的。
线程安全
此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。