Table Class

The Table object represents a SQL Server table.

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.TableViewBase
                Microsoft.SqlServer.Management.Smo.Table

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

Syntax

'Declaration
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class Table _
    Inherits TableViewBase _
    Implements ISfcSupportsDesignMode, IColumnPermission, IObjectPermission, ICreatable,  _
    IAlterable, IDroppable, IRenamable, ITableOptions, IDmfFacet
'Usage
Dim instance As Table

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class Table : TableViewBase, 
    ISfcSupportsDesignMode, IColumnPermission, IObjectPermission, ICreatable, IAlterable, 
    IDroppable, IRenamable, ITableOptions, IDmfFacet

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class Table sealed : public TableViewBase, 
    ISfcSupportsDesignMode, IColumnPermission, IObjectPermission, ICreatable, IAlterable, 
    IDroppable, IRenamable, ITableOptions, IDmfFacet

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type Table =  
    class 
        inherit TableViewBase 
        interface ISfcSupportsDesignMode 
        interface IColumnPermission 
        interface IObjectPermission 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IRenamable 
        interface ITableOptions 
        interface IDmfFacet 
    end

public final class Table extends TableViewBase implements ISfcSupportsDesignMode, IColumnPermission, IObjectPermission, ICreatable, IAlterable, IDroppable, IRenamable, ITableOptions, IDmfFacet

The Table type exposes the following members.

Constructors

	Name	Description
	Table()	Initializes a new instance of the Table class.
	Table(Database, String)	Initializes a new instance of the Table class on the specified database and that has the specified name.
	Table(Database, String, String)	Initializes a new instance of the Table class on the specified database and that has the specified name and schema.

Top

Properties

	Name	Description
	AnsiNullsStatus	Gets the Boolean property value that specifies whether ISO NULL handling is enabled on the table.
	ChangeTrackingEnabled	Gets or sets a value that indicates whether change tracking is enabled for the table.
	Checks	Represents a collection of Check objects. Each Check object represents a check constraint defined on the table.
	Columns	Gets a column collection. (Inherited from TableViewTableTypeBase.)
	CreateDate	Gets the date and time when the table was created.
	DataSpaceUsed	Gets the storage space used by the rows of the referenced table in kilobytes.
	DateLastModified	Gets the date and time when the table was last modified.
	DistributionName	Gets or sets the name of the distribution scheme defined by the federation.
	Events	Gets the events that are associated with the table.
	ExtendedProperties	Gets an extended property collection. (Inherited from TableViewTableTypeBase.)
	FakeSystemTable	Gets the Boolean value that specifies whether the table references a system table.
	FederationColumnID	Gets the ID of the column for the federation key.
	FederationColumnName	Gets or sets the name of the column for the federation key.
	FileGroup	Gets or sets the filegroup in which the table is stored.
	FileStreamFileGroup	Gets or sets the filegroup for FILESTREAM data.
	FileStreamPartitionScheme	Gets or sets the partition scheme for FILESTREAM data.
	FileTableDirectoryName	Gets or sets the directory name of the FileTable.
	FileTableNameColumnCollation	Gets the column collation of the FileTable name.
	FileTableNamespaceEnabled	Gets or sets a value that indicates whether the FileTable namespace is enabled.
	ForeignKeys	Represents a collection of ForeignKey objects. Each ForeignKey object represents a foreign key defined on the table.
	FullTextIndex	Gets the full text index on the table or view. (Inherited from TableViewBase.)
	HasAfterTrigger	Gets the Boolean property value that specifies whether the table has any after triggers.
	HasClusteredIndex	Gets the Boolean property value that specifies whether the table has a clustered index.
	HasCompressedPartitions	Gets a value indicating whether the table uses compressed partitions
	HasDeleteTrigger	Gets the Boolean property value that specifies whether the table has a delete trigger.
	HasIndex	Gets the Boolean property value that specifies whether the table has at least one index.
	HasInsertTrigger	Gets the Boolean property value that specifies whether the table has an insert trigger.
	HasInsteadOfTrigger	Gets the Boolean property value that specifies whether the table has any instead of triggers.
	HasUpdateTrigger	Gets the Boolean property value that specifies whether the table has an update trigger.
	ID	Gets the ID value that uniquely identifies the table.
	Indexes	Gets the specified index of collection in the table. (Overrides TableViewTableTypeBase.Indexes.)
	IndexSpaceUsed	Gets the space used by the index, in KB.
	IsFileTable	Gets a value that indicates whether a table is FileTable.
	IsIndexable	Gets the Boolean property value that specifies whether an index can be placed on the table.
	IsPartitioned	Gets the Boolean property value that specifies whether the table is partitioned.
	IsSchemaOwned	Gets the Boolean property value that specifies whether the table schema is owned.
	IsSystemObject	Gets the Boolean property value that specifies whether the table is a system object.
	IsVarDecimalStorageFormatEnabled	Gets or sets a value that indicates whether var decimal storage is enabled.
	LockEscalation	Gets or sets the type of lock escalation that is used on the table.
	MaximumDegreeOfParallelism	Gets or sets the maximum number of processors to use in a parallel plan execution that includes the table.
	Name	Gets or sets a String value that specifies the name of the view table type. (Inherited from TableViewTableTypeBase.)
	OnlineHeapOperation	Gets or sets the Boolean value that determines whether the table supports online heap or index operations.
	Owner	Gets or sets the owner of the table.
	Parent	Gets the Database object that is the parent of the Table object.
	PartitionScheme	Gets or sets the name of the partition scheme that is configured for the table.
	PartitionSchemeParameters	Represents a collection of PartitionSchemeParameter objects. Each PartitionSchemeParameter object represents a partition scheme parameter defined on the table.
	PhysicalPartitions	Gets the physical partitions in which the table data is stored.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	QuotedIdentifierStatus	Gets or sets a Boolean property value that specifies whether identifiers delimited by double quotation marks are Transact-SQL reserved keywords or contain characters not usually allowed by the Transact-SQL syntax rules.
	Replicated	Gets the Boolean property that specifies whether the table is replicated.
	RowCount	Gets the number of rows in the table.
	RowCountAsDouble	Gets the number of rows in the table as a floating point value.
	Schema	Gets or sets a String value that specifies the name of the schema that contains the view table type. (Inherited from TableViewTableTypeBase.)
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Statistics	Represents a collection of Statistic objects. Each Statistic object represents a statistic counter that is defined on the table or view. (Inherited from TableViewBase.)
	TextFileGroup	Gets or sets the filegroup that is used to maintain long, variable-length data stored in the table.
	TrackColumnsUpdatedEnabled	Gets or sets a value that indicates whether the Database Engine track columns update is enabled.
	Triggers	Represents a collection of Trigger objects. Each Trigger object represents a trigger that is defined on the table or view. (Inherited from TableViewBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter	Updates any Table object property changes on the instance of SQL Server.
	AlterWithNoCheck	Updates any Table object property changes on the instance of SQL Server without checking the property values first.
	ChangeSchema	Changes the schema on the referenced table.
	CheckIdentityValue	Verifies the integrity of all identity columns in the referenced table.
	CheckTable	Tests the integrity of database pages for the table and indexes defined on the table.
	CheckTableDataOnly	Tests the integrity of database pages for the table data defined on the table.
	Create	Creates a table on the instance of SQL Server as defined by the Table object.
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the table.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the table.
	Deny(ObjectPermissionSet, String, Boolean)	Denies the specified set of permissions for the specified grantee and other users to whom the grantee granted the specified set of permissions on the table.
	Deny(ObjectPermissionSet, String, array<String[])	Denies the specified set of permissions to the grantee on the specified columns on the table.
	Deny(ObjectPermissionSet, array<String[], Boolean)	Denies the specified permission for the specified grantees on the table.
	Deny(ObjectPermissionSet, array<String[], array<String[])	Denies the specified set of permissions for the grantees on the specified columns on the table.
	Deny(ObjectPermissionSet, String, array<String[], Boolean)	Denies the specified set of permissions for the specified grantee and other users to whom the grantee granted the specified set of permissions on the specified columns on the table.
	Deny(ObjectPermissionSet, array<String[], array<String[], Boolean)	Denies the specified set of permissions for the specified grantees and other users to whom the grantee granted the specified set of permissions on the specified columns on the table.
	DisableAllIndexes	Disables all the indexes that are on the table.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the table from the database.
	EnableAllIndexes	Enables all indexes.
	EnumColumnPermissions()	Enumerates a list of column permissions for the table.
	EnumColumnPermissions(String)	Enumerates a list of column permissions for a specified grantee on the table.
	EnumColumnPermissions(ObjectPermissionSet)	Enumerates a list of column permissions for a specified permission on the table.
	EnumColumnPermissions(String, ObjectPermissionSet)	Enumerates a list of column permissions for a specified grantee and a specified permission on the table.
	EnumForeignKeys	Enumerates a list of primary keys in which the table is referenced as a foreign key.
	EnumFragmentation()	Enumerates information about fragments of data that are stored in a table or view. (Inherited from TableViewBase.)
	EnumFragmentation(FragmentationOption)	Enumerates information about fragments of data that are stored in a table or view with the option to specify how detailed the results should be. (Inherited from TableViewBase.)
	EnumFragmentation(FragmentationOption, Int32)	Enumerates information about fragments of data that are stored in a table or view on a specified partition, and with the option to specify how detailed the results should be. (Inherited from TableViewBase.)
	EnumLastStatisticsUpdates()	Enumerates a list of information about the most recent statistics updates.
	EnumLastStatisticsUpdates(String)	Enumerates a list of information about the most recent statistics updates for the specified statistic counter.
	EnumObjectPermissions()	Enumerates a list of object permissions for the table.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the table.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the table.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the table.
	EnumScript()	Returns an IEnumerable<string> object that has the script for the passed objects
	EnumScript(ScriptingOptions)	Returns an IEnumerable<string> object that has the script for the passed objects.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the table.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the table.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission and the ability to grant access to other uses for the specified grantee on the table.
	Grant(ObjectPermissionSet, String, array<String[])	Grants access to the specified permission on the specified columns for the specified grantee on the specified columns on the table.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants access to the specified permission and the ability to grant access to other uses for the specified grantees on the table.
	Grant(ObjectPermissionSet, array<String[], array<String[])	Grants the specified set of permissions to the grantees to the specified columns on the table.
	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 table under an assumed role.
	Grant(ObjectPermissionSet, String, array<String[], Boolean)	Grants the specified permission to the grantee and the ability to grant the specified set of permissions to other users on the specified columns on the table.
	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 table under an assumed role.
	Grant(ObjectPermissionSet, array<String[], array<String[], Boolean)	Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the specified columns on the table.
	Grant(ObjectPermissionSet, String, array<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 specified columns on the table under an assumed role.
	Grant(ObjectPermissionSet, array<String[], 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 specified columns on the table under an assumed role.
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Rebuild()	Rebuilds the table.
	Rebuild(Int32)	Rebuilds the specified table partition.
	RebuildIndexes	Rebuilds the indexes on the table.
	RecalculateSpaceUsage	Recalculates the space that is used on the table.
	ReCompileReferences	Recompiles any view or trigger that depends on the base SMO object. (Inherited from TableViewBase.)
	Refresh	Refreshes the View object or Table object properties. (Inherited from TableViewBase.)
	Rename	Renames the table.
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the table.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the table.
	Revoke(ObjectPermissionSet, String, array<String[])	Revokes a previously granted set of permissions from a grantee on the specified columns on the table.
	Revoke(ObjectPermissionSet, array<String[], array<String[])	Revokes a previously granted set of permissions from a list of grantees on the specified columns on the table.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes a previously granted set of permissions from a grantee on the table 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.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean)	Revokes a previously granted set of permissions from grantees on the table 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.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)	Revokes a previously granted set of permissions from a grantee from the table 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.
	Revoke(ObjectPermissionSet, String, array<String[], Boolean, Boolean)	Revokes a previously granted set of permissions from grantees on the specified columns on the table 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.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String)	Revokes a previously granted set of permissions from grantees on the table and any other users to whom the grantees have granted access. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], array<String[], Boolean, Boolean)	Revokes a previously granted set of permissions from grantees on the specified columns on the table 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.
	Revoke(ObjectPermissionSet, String, array<String[], Boolean, Boolean, String)	Revokes a previously granted set of permissions from a grantee on the specified columns on the table 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.
	Revoke(ObjectPermissionSet, array<String[], array<String[], Boolean, Boolean, String)	Revokes a previously granted set of permissions from the grantees for the specified columns on the table and any other users to whom the grantee has granted access. The grantee is also given the ability to revoke other users' access under an assumed role.
	Script()	Generates a Transact-SQL script that can be used to re-create the database object. (Inherited from TableViewTableTypeBase.)
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the database object with the specified scripting options. (Inherited from TableViewTableTypeBase.)
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SwitchPartition(Table)	Switches the partition of the table to the specified target table.
	SwitchPartition(Int32, Table)	Switches the specified partition of the table to the specified target table specified (assuming the target table is not partitioned).
	SwitchPartition(Table, Int32)	Switches the table to the partition with the specified partition number of the specified target table.
	SwitchPartition(Int32, Table, Int32)	Switches the specified source partition of the table to the specified target of the specified target table.
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	TruncateData	Truncates the data in the table.
	UpdateStatistics()	Updates statistics for the table or view. (Inherited from TableViewBase.)
	UpdateStatistics(StatisticsTarget, StatisticsScanType)	Updates the statistics for the table or view with the option to specify the target and the type of scan performed. (Inherited from TableViewBase.)
	UpdateStatistics(StatisticsTarget, StatisticsScanType, Int32)	Updates the statistics for the table or view with the option to specify the target, the type of scan performed, and the sample size. (Inherited from TableViewBase.)
	UpdateStatistics(StatisticsTarget, StatisticsScanType, Int32, Boolean)	Updates the statistics for the table or view with the option to specify the target, the type of scan performed, the sample size, and whether to recompute the statistics. (Inherited from TableViewBase.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. Gets a Boolean value that indicates whether the object supports design mode.

Top

Remarks

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

To set Table object properties, users must have ALTER permission on the table.

To create a table, users must have CREATE TABLE permission on the parent database and ALTER permission in the schema.

To drop a table, users must have CONTROL permission on the table, or be a member of the db_ddladmin or db_owner fixed database roles.

To grant, deny, or revoke permission on the table to other users, users must have CONTROL permission on the table.

Examples

Creating, Altering, and Removing Tables

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

Tables

CREATE TABLE (Transact-SQL)