UserDefinedDataType Class

  • Article

The UserDefinedDataType object represents a SQL Server user-defined data type.

Inheritance Hierarchy

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.UserDefinedDataType

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class UserDefinedDataType _
    Inherits ScriptSchemaObjectBase _
    Implements ICreatable, IAlterable, IDroppable, IRenamable,  _
    IExtendedProperties, IScriptable, ISfcSupportsDesignMode, IObjectPermission
'Usage
Dim instance As UserDefinedDataType

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class UserDefinedDataType : ScriptSchemaObjectBase, 
    ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, 
    IScriptable, ISfcSupportsDesignMode, IObjectPermission

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class UserDefinedDataType sealed : public ScriptSchemaObjectBase, 
    ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, 
    IScriptable, ISfcSupportsDesignMode, IObjectPermission

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type UserDefinedDataType =  
    class 
        inherit ScriptSchemaObjectBase 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IRenamable 
        interface IExtendedProperties 
        interface IScriptable 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
    end

public final class UserDefinedDataType extends ScriptSchemaObjectBase implements ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode, IObjectPermission

The UserDefinedDataType type exposes the following members.

Constructors

  Name Description
Public method UserDefinedDataType() Initializes a new instance of the UserDefinedDataType class.
Public method UserDefinedDataType(Database, String) Initializes a new instance of the UserDefinedDataType class on the specified database and with the specified name.
Public method UserDefinedDataType(Database, String, String) Initializes a new instance of the UserDefinedDataType class on the specified database and with the specified name and schema.

Top

Properties

  Name Description
Public property AllowIdentity Gets the Boolean property value that specifies whether the user-defined data type is able to participate in a column defined with the identity property.
Public property Collation Gets the collation assigned to the user-defined data type.
Public property Default Gets or sets a SQL Server default that is bound to the user-defined data type.
Public property DefaultSchema Gets or sets the SQL Server default schema for the user-defined data type.
Public property ExtendedProperties Gets the extended properties of the user-defined data type.
Public property ID Gets an ID value that uniquely identifies the user-defined data type.
Public property IsSchemaOwned Gets a Boolean value that indicates whether the UserDefinedDataType object is owned by a schema.
Public property Length Gets or sets the number of characters in the user-defined data type.
Public property MaxLength Gets the maximum number of characters accepted by the user-defined data type.
Public property Name Gets or sets a String value that specifies the name of the user defined data type. (Overrides ScriptSchemaObjectBase.Name.)
Public property Nullable Gets or sets the Boolean property value that specifies whether the user-defined data type accepts null values or not.
Public property NumericPrecision Gets or sets the maximum number of digits in a numeric value used in the definition of the user-defined data type.
Public property NumericScale Gets or sets the maximum number of digits to the right of the decimal point in a numeric value used in the definition of the user-defined data type.
Public property Owner Gets the name of the owner of the UserDefinedDataType object.
Public property Parent Gets or sets the Database object that is the parent of the UserDefinedDataType object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property Rule Gets or sets a SQL Server rule that is bound to the user-defined data type.
Public property RuleSchema Gets or sets the SQL Server rule schema for the user-defined data type.
Public property Schema Gets or sets a String value that specifies the name of the schema that contains the user defined data type. (Overrides ScriptSchemaObjectBase.Schema.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property SystemType Gets or sets the base system data type from which the user-defined data type is derived.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public property VariableLength Gets the Boolean property value that specifies whether the user-defined data type is variable in length.

Top

Methods

  Name Description
Public method Alter Updates any UserDefinedDataType object property changes on the instance of Microsoft SQL Server. 
Public method BindDefault(String, String) Binds a default to the user-defined data type.
Public method BindDefault(String, String, Boolean) Binds a default to the user-defined data type.
Public method BindRule(String, String) Binds a default to the user-defined data type.
Public method BindRule(String, String, Boolean) Binds a default to the user-defined data type.
Public method Create Creates a user-defined data type on the instance of Microsoft SQL Server as defined by the UserDefinedType object.
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the user-defined data type.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the user-defined data type.
Public method Deny(ObjectPermissionSet, String, Boolean) Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the user-defined data type.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the user-defined data type.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the user-defined data type from the instance of Microsoft SQL Server.
Public method EnumBoundColumns Enumerates a list of columns to which the user-defined data type type is bound.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the user-defined data type.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the user-defined data type.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the user-defined data type.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the user-defined data type.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the user-defined data type.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the user-defined data type.
Public method Grant(ObjectPermissionSet, String, Boolean) Grants the specified set of permissions to the grantee and the ability to grant the specified set of permissions to other users on the user-defined data type.
Public method Grant(ObjectPermissionSet, array<String[], Boolean) Grants the specified set pf permissions to the grantees and the ability to grant the specified set of permissions to other users on the user-defined data type.
Public method Grant(ObjectPermissionSet, String, Boolean, String) Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the user-defined data type under an assumed role.
Public method Grant(ObjectPermissionSet, array<String[], Boolean, String) Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the user-defined data type data type under an assumed role.
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Rename Renames the user defined data type.
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the user-defined data type.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the user-defined data type.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes previously granted permissions from a grantee on the user-defined data type and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) Revokes previously granted permissions from grantees on the user-defined data type and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revokes previously granted permissions from a grantee on the user-defined data type and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) Revokes previously granted permissions from grantees on the user-defined data type and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Script() Generates a Transact-SQL script that can be used to re-create the user-defined data type.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the user-defined data type as specified by the script options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method UnbindDefault() Unbinds a default from the user-defined data type.
Public method UnbindDefault(Boolean) Unbinds a default from the user-defined data type.
Public method UnbindRule() Unbinds a rule from the user-defined data type.
Public method UnbindRule(Boolean) Unbinds a rule from the user-defined data type.
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that specifies whether the user defined data type supports design mode.

Top

Remarks

To get UserDefinedDataType object permissions, users can be a member of the public fixed server role.

To set UserDefinedDataType object permissions, users must have CREATE TYPE permission in the parent database and ALTER permission on specified schema. If an assembly is specified, users must either own the assembly or have REFERENCES permission on it.

To create an user-defined data type data type, users must have CREATE TYPE permission in the parent database and ALTER permission on specified schema. If an assembly is specified, users must either own the assembly or have REFERENCES permission on it.

To drop a user-defined data type data type, users must have CONTROL permission on the type and ALTER permission on the specified schema.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Working with Data Types

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Data Types (Database Engine)