Export (0) Print
Expand All

UserDefinedType Class

The UserDefinedType represents an alias data type that is based on .NET data types.

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

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

The UserDefinedType type exposes the following members.

  NameDescription
Public methodUserDefinedType()Initializes a new instance of the UserDefinedType class.
Public methodUserDefinedType(Database, String)Initializes a new instance of the UserDefinedType class on the specified database and with the specified name.
Public methodUserDefinedType(Database, String, String)Initializes a new instance of the UserDefinedType class on the specified database and with the specified name and schema.
Top

  NameDescription
Public propertyAssemblyNameGets or sets the name of the .NET assembly that is required by the referenced alias data type.
Public propertyBinaryTypeIdentifierGets the ID value that uniquely identifies the binary type.
Public propertyClassNameGets or sets the name of the class that is called by the referenced alias data type.
Public propertyCollationGets the collation that is associated with the alias data type.
Public propertyEventsGets the events that are associated with the alias data type.
Public propertyExtendedPropertiesGets the extended properties of the UserDefinedType object.
Public propertyIDGets the ID value that uniquely identifies the alias data type.
Public propertyIsBinaryOrderedGets the Boolean property that specifies whether the alias data type is binary ordered.
Public propertyIsComVisibleGets the Boolean property that specifies whether the alias data type is accessible from COM components.
Public propertyIsFixedLengthGets the Boolean property that specifies whether the alias data type is fixed length.
Public propertyIsNullableGets the Boolean property that specifies whether the alias data type accepts null values.
Public propertyIsSchemaOwnedGets a Boolean value that indicates whether the UserDefinedType object is owned by a schema.
Public propertyMaxLengthGets the maximum length of the alias data type.
Public propertyNameGets or sets the name of the schema. (Inherited from ScriptSchemaObjectBase.)
Public propertyNumericPrecisionGets the numeric precision of the alias data type.
Public propertyNumericScaleGets the numeric scale of the alias data type.
Public propertyOwnerGets the name of the owner of the UserDefinedType object.
Public propertyParentGets the Database object that is the parent of the UserDefinedType object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertySchemaGets or sets the schema. (Inherited from ScriptSchemaObjectBase.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public propertyUserDefinedTypeFormatGets the serialization format for the alias data type.
Top

  NameDescription
Public methodAlterUpdates any UserDefinedType object property changes on instance of Microsoft SQL Server.
Public methodChangeSchemaChanges the schema of the alias data type.
Public methodCreateCreates a alias data type on the instance of Microsoft SQL Server as defined by the UserDefinedType object.
Public methodDeny(ObjectPermissionSet, String)Denies the specified set of permissions for the specified grantee on the alias data type.
Public methodDeny(ObjectPermissionSet, String[])Denies the specified set of permissions for the specified grantees on the alias data type.
Public methodDeny(ObjectPermissionSet, String, Boolean)Denies the specified set of permissions for the specified grantee and other users whom the grantee granted the specified set of permissions on the alias data type.
Public methodDeny(ObjectPermissionSet, String[], Boolean)Denies the specified set of permissions for the specified grantees and other users whom the grantee granted the specified set of permissions on the alias data type.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the alias data type from the instance of SQL Server.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the alias data type.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the alias data type.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the alias data type.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the alias data type.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the alias data type.
Public methodGrant(ObjectPermissionSet, String[])Grants the specified set of permissions to the specified grantees on the alias data type.
Public methodGrant(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 alias data type.
Public methodGrant(ObjectPermissionSet, 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 asymmetric key.
Public methodGrant(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 alias data type under an assumed role.
Public methodGrant(ObjectPermissionSet, 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 alias data type under an assumed role.
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the alias data type.
Public methodRevoke(ObjectPermissionSet, String[])Revokes a previously granted set of permissions from a list of grantees on the alias data type.
Public methodRevoke(ObjectPermissionSet, String, Boolean, Boolean)Revokes previously granted permissions from a grantee on the alias 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 methodRevoke(ObjectPermissionSet, String[], Boolean, Boolean)Revokes previously granted permissions from grantees on the alias 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 methodRevoke(ObjectPermissionSet, String, Boolean, Boolean, String)Revokes previously granted permissions from a grantee on the alias 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 methodRevoke(ObjectPermissionSet, String[], Boolean, Boolean, String)Revokes previously granted permissions from grantees on the alias 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 methodScript()Generates a Transact-SQL script that can be used to re-create the alias data type.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the alias data type as specified by the script options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode.IsDesignModeGets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Top

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

To set UserDefinedType 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 a alias 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 alias 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.

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

Community Additions

ADD
Show:
© 2014 Microsoft