TableViewBase Class
The TableViewBase class is a base class that is used in the construction of the Table class and View class. It contains functionality that is common to both classes.
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
Microsoft.SqlServer.Management.Smo.View
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public Class TableViewBase _
Inherits TableViewTableTypeBase _
Implements IExtendedProperties, IScriptable
'Usage
Dim instance As TableViewBase
public class TableViewBase : TableViewTableTypeBase,
IExtendedProperties, IScriptable
public ref class TableViewBase : public TableViewTableTypeBase,
IExtendedProperties, IScriptable
type TableViewBase =
class
inherit TableViewTableTypeBase
interface IExtendedProperties
interface IScriptable
end
public class TableViewBase extends TableViewTableTypeBase implements IExtendedProperties, IScriptable
The TableViewBase type exposes the following members.
Constructors
Name | Description | |
---|---|---|
TableViewBase | Initializes a new instance of the TableViewBase class. |
Top
Properties
Name | Description | |
---|---|---|
Columns | Gets a column collection. (Inherited from TableViewTableTypeBase.) | |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.) | |
ExtendedProperties | Gets an extended property collection. (Inherited from TableViewTableTypeBase.) | |
FullTextIndex | Gets the full text index on the table or view. | |
Indexes | Gets an index collection. (Inherited from TableViewTableTypeBase.) | |
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.) | |
Name | Gets or sets a String value that specifies the name of the view table type. (Inherited from TableViewTableTypeBase.) | |
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.) | |
Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) | |
ScalarResult | Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.) | |
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. | |
Triggers | Represents a collection of Trigger objects. Each Trigger object represents a trigger that is defined on the table or view. | |
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 | |
---|---|---|
AddDatabaseContext | Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.) | |
AlterImpl | Activates the object altered event. (Inherited from SqlSmoObject.) | |
AlterImplWorker | Calls the Alter methods. (Inherited from SqlSmoObject.) | |
AppendCommaText | Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.) | |
AppendWithCommaText | Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.) | |
AppendWithOption | Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.) | |
AutoGenerateName | Generates a name based on the object Guid. (Inherited from ScriptNameObjectBase.) | |
BindDefaultImpl | Binds the default items identified by the parameters. (Inherited from SqlSmoObject.) | |
BindRuleImpl | Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.) | |
CheckObjectDirty | Checks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.) | |
CheckObjectState() | Validates the state of the referenced object. (Inherited from SqlSmoObject.) | |
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.) | |
CheckObjectStateImpl | Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.) | |
CheckTextCorectness | Checks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.) | |
CheckTextModeSupport | Checks mode of support. (Inherited from ScriptNameObjectBase.) | |
CheckVersion100 | Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.) | |
CheckVersion110() | Checks whether version of SQL Server is SQL Server 2012. (Inherited from SqlSmoObject.) | |
CheckVersion110(String) | Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (Inherited from SqlSmoObject.) | |
CheckVersion80 | Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.) | |
CheckVersion80SP3 | Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.) | |
CheckVersion90 | Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.) | |
CheckVersionBelow110 | Checks whether version of SQL Server is before SQL Server 2012. (Inherited from SqlSmoObject.) | |
CheckVersionBelow90 | Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.) | |
CleanObject | Cleans the referenced object. (Inherited from ScriptNameObjectBase.) | |
CreateImpl | Creates an object with scripting options. (Inherited from SqlSmoObject.) | |
Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) | |
DropImpl | Drops a SqlSmoObject. (Inherited from SqlSmoObject.) | |
DropImplWorker | Calls the drop methods. (Inherited from SqlSmoObject.) | |
EnumFragmentation() | Enumerates information about fragments of data that are stored in a table or view. | |
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. | |
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. | |
Equals | (Inherited from Object.) | |
ExecuteNonQuery | Executes a batch of statements that does not return a result set. (Inherited from SqlSmoObject.) | |
ExecuteRenameQuery | Executes the rename query for the object. (Inherited from NamedSmoObject.) | |
Finalize | (Inherited from Object.) | |
ForceTextModeOnTextBody | Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.) | |
FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) | |
GenerateAlterEvent() | Generates the alter event with the specified value. (Inherited from SqlSmoObject.) | |
GenerateAlterEvent(Urn, Object) | Generates alter event with the specified URN and inner object value. (Inherited from SqlSmoObject.) | |
GetBraketNameForText | Gets the bracket name for the text. (Inherited from ScriptNameObjectBase.) | |
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.) | |
GetFragOptionString | Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.) | |
GetHashCode | (Inherited from Object.) | |
GetIsSystemNamed | Gets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.) | |
GetIsTextDirty | Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.) | |
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.) | |
GetRealValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetServerName | Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) | |
GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetSqlServerVersionName | Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) | |
GetTextBody() | Returns the text body. (Inherited from ScriptNameObjectBase.) | |
GetTextBody(Boolean) | Returns the text body. (Inherited from ScriptNameObjectBase.) | |
GetTextHeader | Returns the text header. (Inherited from ScriptNameObjectBase.) | |
GetTextMode | Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.) | |
GetTextProperty | Gets the text of the object, if not available, throw appropriate exception based on the state of the object. (Inherited from ScriptNameObjectBase.) | |
GetType | (Inherited from Object.) | |
GetUrnRecursive(StringBuilder) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
ImplInitialize | Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
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.) | |
IsObjectDirty | Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.) | |
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.) | |
IsVersion80SP3 | Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.) | |
IsVersion90AndAbove | Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.) | |
MarkDropped | Marks the state of the current object and all of its child collections to be Dropped. (Inherited from TableViewTableTypeBase.) | |
MarkForDropImpl | Sets the SqlSmoState for drop operation. (Inherited from SqlSmoObject.) | |
MemberwiseClone | (Inherited from Object.) | |
PostAlter | The method that is activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.) | |
PostCreate | The method that is activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.) | |
PostDrop | The method that is activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.) | |
ReCompileReferences | Recompiles any view or trigger that depends on the base SMO object. | |
Refresh | Refreshes the View object or Table object properties. (Overrides TableViewTableTypeBase.Refresh().) | |
RenameImpl | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) | |
RenameImplWorker | Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.) | |
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.) | |
ScriptImpl() | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
ScriptImpl(ScriptingOptions) | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
SetCollectionTextMode | Sets the collection text mode. (Inherited from ScriptNameObjectBase.) | |
SetIsSystemNamed | Sets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.) | |
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) | |
SetSchemaOwned | Sets the schema owned value. (Inherited from NamedSmoObject.) | |
SetTextBody | Specifies the text body. (Inherited from ScriptNameObjectBase.) | |
SetTextHeader | Specifies the text header. (Inherited from ScriptNameObjectBase.) | |
SetTextMode | Specifies the text mode. (Inherited from ScriptNameObjectBase.) | |
SwitchTextMode | Switches the text mode. (Inherited from ScriptNameObjectBase.) | |
ThrowIfTextIsDirtyForAlter | Throws an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.) | |
ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) | |
TouchImpl | Not implemented. (Inherited from SqlSmoObject.) | |
UnbindDefaultImpl | Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
UnbindRuleImpl | Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
UpdateStatistics() | Updates statistics for the table or view. | |
UpdateStatistics(StatisticsTarget, StatisticsScanType) | Updates the statistics for the table or view with the option to specify the target and the type of scan performed. | |
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. | |
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. | |
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
Fields
Name | Description | |
---|---|---|
m_ExtendedProperties | Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.) | |
singletonParent | Represents the singleton parent. (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.) |
Top
Remarks
The Table and View classes are derived from the TableViewBase class. The Table object represents a SQL Server table and the View object represents a SQL Server view.
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
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