Share via


UserDefinedTableType Class

The UserDefinedTableType object represents a SQL Server user-defined table type 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.TableViewTableTypeBase
              Microsoft.SqlServer.Management.Smo.UserDefinedTableType

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)> _
Public NotInheritable Class UserDefinedTableType _
    Inherits TableViewTableTypeBase _
    Implements ICreatable, IAlterable, IRenamable, IDroppable,  _
    IScriptable, IExtendedProperties, ISfcSupportsDesignMode, IObjectPermission
'Usage
Dim instance As UserDefinedTableType
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)]
public sealed class UserDefinedTableType : TableViewTableTypeBase, 
    ICreatable, IAlterable, IRenamable, IDroppable, IScriptable, 
    IExtendedProperties, ISfcSupportsDesignMode, IObjectPermission
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
public ref class UserDefinedTableType sealed : public TableViewTableTypeBase, 
    ICreatable, IAlterable, IRenamable, IDroppable, IScriptable, 
    IExtendedProperties, ISfcSupportsDesignMode, IObjectPermission
[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)>]
type UserDefinedTableType =  
    class 
        inherit TableViewTableTypeBase 
        interface ICreatable 
        interface IAlterable 
        interface IRenamable 
        interface IDroppable 
        interface IScriptable 
        interface IExtendedProperties 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
    end
public final class UserDefinedTableType extends TableViewTableTypeBase implements ICreatable, IAlterable, IRenamable, IDroppable, IScriptable, IExtendedProperties, ISfcSupportsDesignMode, IObjectPermission

The UserDefinedTableType type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property Checks Gets the checks collection.
Public property Collation Get the table collation.
Public property Columns Gets a column collection. (Inherited from TableViewTableTypeBase.)
Public property CreateDate Gets the table create date.
Public property DateLastModified Gets the last modified date for the table.
Public property ExtendedProperties Gets an extended property collection. (Inherited from TableViewTableTypeBase.)
Public property ID Gets an ID value that uniquely identifies the user-defined table type.
Public property Indexes Gets an index collection. (Inherited from TableViewTableTypeBase.)
Public property IsSchemaOwned Gets a Boolean value that indicates whether the UserDefinedTableType object is owned by a schema.
Public property IsUserDefined Gets or sets a value that indicates whether the table is user defined.
Public property MaxLength Gets the maximum length in bytes for a column in the table.
Public property Name Gets or sets a String which contains the name of the instance. (Overrides TableViewTableTypeBase.Name.)
Public property Nullable Specifies whether the table is nullable.
Public property Owner Gets the name of the owner of the UserDefinedTableType object.
Public property Parent Gets or sets the Database object that is the parent of the UserDefinedTableType object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property Schema Gets or sets a String which contains the name of the Schema which owns the UserDefinedTableType. (Overrides TableViewTableTypeBase.Schema.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
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.)

Top

Methods

  Name Description
Public method Alter Alters the table.
Public method Create Creates a user-defined table 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 table type.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the user-defined table type.
Public method Deny(ObjectPermissionSet, String, Boolean) Denies the specified set of permissions for the specified grantee and other users who the grantee granted the specified set of permissions on the user-defined table type.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified set of permissions for the specified grantees and other users who the grantee granted the specified set of permissions on the user-defined table type.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the user-defined table type from the instance of SQL Server.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the user-defined table type.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the user-defined table type.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the user-defined table type.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the user-defined table 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 table type.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the user-defined table 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 table 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 table 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 table type under an assumed role.
Public method Grant(ObjectPermissionSet, array<String[], Boolean, String) Grants the specified set of permissions to the grantees. Also grants the ability to grant the set of permissions to other users on the user-defined table 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 view. (Inherited from TableViewTableTypeBase.)
Public method Rename Renames the table.
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the user-defined table type.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the user-defined table type.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes previously granted permissions from a grantee on the user-defined table 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 table 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 table 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 table 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 table type.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the user-defined table 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 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 value that indicates whether UserDefinedTableType the object supports design mode.

Top

Remarks

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

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

To create a user-defined table type data type, users must have CREATE TYPE permissions in the parent database and ALTER permissions on specified schema

To drop a user-defined table type data type, users must have CONTROL permissions on the type and ALTER permissions 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)

CREATE TYPE (Transact-SQL)