Aracılığıyla paylaş

UserDefinedDataType Class

  • Makale

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

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

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

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

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
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.
Protected property ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
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.
Protected property IsTouched Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
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.
Protected property ObjectInSpace Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
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.
Protected property ScalarResult Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
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
Protected method AddDatabaseContext Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Public method Alter Updates any UserDefinedDataType object property changes on the instance of Microsoft SQL Server. 
Protected method AlterImpl Activates the object altered event. (Inherited from SqlSmoObject.)
Protected method AlterImplWorker Calls the Alter methods. (Inherited from SqlSmoObject.)
Protected method AppendCommaText Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AppendWithCommaText Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AppendWithOption Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
Protected method AutoGenerateName Generates a name based on the object Guid. (Inherited from ScriptNameObjectBase.)
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.
Protected method BindDefaultImpl Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
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.
Protected method BindRuleImpl Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Protected method CheckObjectDirty Checks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
Protected method CheckObjectState() Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected method CheckObjectState(Boolean) Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
Protected method CheckObjectStateImpl Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method CheckTextCorectness Checks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.)
Protected method CheckTextModeSupport Checks mode of support. (Inherited from ScriptNameObjectBase.)
Protected method CheckVersion100 Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected method CheckVersion110() Checks whether version of SQL Server is SQL Server 2012. (Inherited from SqlSmoObject.)
Protected method CheckVersion110(String) Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (Inherited from SqlSmoObject.)
Protected method CheckVersion80 Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected method CheckVersion80SP3 Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected method CheckVersion90 Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow110 Checks whether version of SQL Server is before SQL Server 2012. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90 Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CleanObject Cleans the referenced object. (Inherited from ScriptNameObjectBase.)
Public method Create Creates a user-defined data type on the instance of Microsoft SQL Server as defined by the UserDefinedType object.
Protected method CreateImpl Creates an object with scripting options. (Inherited from SqlSmoObject.)
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.
Protected method DropImpl Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method DropImplWorker Calls the drop methods. (Inherited from SqlSmoObject.)
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 ExecuteNonQuery Executes a batch of statements that does not return a result set. (Inherited from SqlSmoObject.)
Protected method ExecuteRenameQuery Executes the rename query for the object. (Inherited from NamedSmoObject.)
Protected method Finalize (Inherited from Object.)
Protected method ForceTextModeOnTextBody Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GenerateAlterEvent() Generates the alter event with the specified value. (Inherited from SqlSmoObject.)
Protected method GenerateAlterEvent(Urn, Object) Generates alter event with the specified URN and inner object value. (Inherited from SqlSmoObject.)
Protected method GetBraketNameForText Gets the bracket name for the text. (Inherited from ScriptNameObjectBase.)
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.)
Protected method GetFragOptionString Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetIsSystemNamed Gets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected method GetIsTextDirty Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
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 GetRealValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerName Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetSqlServerVersionName Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetTextBody() Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextBody(Boolean) Returns the text body. (Inherited from ScriptNameObjectBase.)
Protected method GetTextHeader Returns the text header. (Inherited from ScriptNameObjectBase.)
Protected method GetTextMode Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
Protected method GetTextProperty Gets the text of the object, if not available, throw appropriate exception based on the state of the object. (Inherited from ScriptNameObjectBase.)
Public method GetType (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
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.
Protected method ImplInitialize Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
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 IsObjectDirty Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
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.)
Protected method IsVersion80SP3 Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected method IsVersion90AndAbove Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Protected method MarkDropped Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected method MarkForDropImpl Sets the SqlSmoState for drop operation. (Inherited from SqlSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method PostAlter The method that is activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected method PostCreate The method that is activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected method PostDrop The method that is activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Rename Renames the user defined data type.
Protected method RenameImpl This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method RenameImplWorker Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
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 ScriptImpl() Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method SetCollectionTextMode Sets the collection text mode. (Inherited from ScriptNameObjectBase.)
Protected method SetIsSystemNamed Sets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Protected method SetSchemaOwned Sets the schema owned value. (Inherited from NamedSmoObject.)
Protected method SetTextBody Specifies the text body. (Inherited from ScriptNameObjectBase.)
Protected method SetTextHeader Specifies the text header. (Inherited from ScriptNameObjectBase.)
Protected method SetTextMode Specifies the text mode. (Inherited from ScriptNameObjectBase.)
Protected method SwitchTextMode Switches the text mode. (Inherited from ScriptNameObjectBase.)
Protected method ThrowIfTextIsDirtyForAlter Throws an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected method TouchImpl Not implemented. (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.
Protected method UnbindDefaultImpl Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
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.
Protected method UnbindRuleImpl Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
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

Fields

  Name Description
Protected field m_ExtendedProperties Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected field singletonParent Represents the singleton parent. (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)