Share via

View Class

  • Article

The View object represents a SQL Server view. 

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.View

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 View _
    Inherits TableViewBase _
    Implements ISfcSupportsDesignMode, IColumnPermission, IObjectPermission, ICreatable,  _
    IAlterable, IDroppable, IRenamable, IExtendedProperties, ITextObject,  _
    IViewOptions, IDmfFacet
'Usage
Dim instance As View

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)]
public sealed class View : TableViewBase, ISfcSupportsDesignMode, 
    IColumnPermission, IObjectPermission, ICreatable, IAlterable, IDroppable, 
    IRenamable, IExtendedProperties, ITextObject, IViewOptions, IDmfFacet

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
public ref class View sealed : public TableViewBase, 
    ISfcSupportsDesignMode, IColumnPermission, IObjectPermission, ICreatable, IAlterable, 
    IDroppable, IRenamable, IExtendedProperties, ITextObject, IViewOptions, 
    IDmfFacet

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)>]
type View =  
    class 
        inherit TableViewBase 
        interface ISfcSupportsDesignMode 
        interface IColumnPermission 
        interface IObjectPermission 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IRenamable 
        interface IExtendedProperties 
        interface ITextObject 
        interface IViewOptions 
        interface IDmfFacet 
    end

public final class View extends TableViewBase implements ISfcSupportsDesignMode, IColumnPermission, IObjectPermission, ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, ITextObject, IViewOptions, IDmfFacet

The View type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property AnsiNullsStatus Gets the Boolean property value that specifies whether ISO NULL handling is enabled on the view.
Public property Columns Gets a column collection. (Inherited from TableViewTableTypeBase.)
Public property CreateDate Gets the time and date when the view was created.
Public property DateLastModified Gets the time and date when the view was last modified.
Public property Events Gets the events associated with the view.
Public property ExtendedProperties Gets an extended property collection. (Inherited from TableViewTableTypeBase.)
Public property FullTextIndex Gets the full text index on the table or view. (Inherited from TableViewBase.)
Public property HasAfterTrigger Gets the Boolean property value that specifies whether the view has any after triggers.
Public property HasColumnSpecification Gets the Boolean property that specifies whether the view has a column specification.
Public property HasDeleteTrigger Gets the Boolean property value that specifies whether the view has a delete trigger.
Public property HasIndex Gets the Boolean property value that specifies whether the view has at least one index.
Public property HasInsertTrigger Gets the Boolean property value that specifies whether the view has an insert trigger.
Public property HasInsteadOfTrigger Gets the Boolean property value that specifies whether the view has any instead of triggers.
Public property HasUpdateTrigger Gets the Boolean property value that specifies whether the view has at least one update trigger.
Public property ID Gets the ID value that uniquely identifies the view.
Public property Indexes Gets the IndexCollection object. (Overrides TableViewTableTypeBase.Indexes.)
Public property IsEncrypted Gets or sets the Boolean property that specifies whether the view is encrypted.
Public property IsIndexable Gets the Boolean property that specifies whether it is possible to place an index on the view.
Public property IsSchemaBound Gets or sets the Boolean property that specifies whether a schema is bound to the view.
Public property IsSchemaOwned Gets a Boolean value that indicates whether the View object is owned by a schema.
Public property IsSystemObject Gets the Boolean property value that specifies whether the view is a system object.
Public property Name Gets or sets a String value that specifies the name of the view table type. (Inherited from TableViewTableTypeBase.)
Public property Owner Gets the name of the owner of the UserDefinedType object.
Public property Parent Gets the Database object that is the parent of the View object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property 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.
Public property ReturnsViewMetadata Gets or sets a Boolean property value that specifies whether the view returns metadata.
Public property Schema Gets or sets a String value that specifies the name of the schema that contains the view table type. (Inherited from TableViewTableTypeBase.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property 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.)
Public property TextBody Gets or sets the Transact-SQL string that defines the view.
Public property TextHeader Gets or sets the header part of the Transact-SQL string that defines the view.
Public property TextMode Gets or sets the Boolean property that specifies whether the text header is editable as text.
Public property Triggers Represents a collection of Trigger objects. Each Trigger object represents a trigger that is defined on the table or view. (Inherited from TableViewBase.)
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 Updates any View object property changes on the instance of Microsoft SQL Server. 
Public method ChangeSchema Changes the schema for the view.
Public method Create Creates a view on the instance of SQL Server as defined by the View object.
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the view.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the view.
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 view.
Public method Deny(ObjectPermissionSet, String, array<String[]) Denies the specified set of permissions to the grantee on the specified columns on the view.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified permission for the specified grantees on the view.
Public method Deny(ObjectPermissionSet, array<String[], array<String[]) Denies the specified set of permissions for the grantees on the specified columns on the view.
Public method Deny(ObjectPermissionSet, String, array<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 specified columns on the view.
Public method Deny(ObjectPermissionSet, array<String[], 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 specified columns on the view.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the view from the database.
Public method EnumColumnPermissions() Enumerates a list of column permissions for the view.
Public method EnumColumnPermissions(String) Enumerates a list of column permissions for a specified grantee on the view.
Public method EnumColumnPermissions(ObjectPermissionSet) Enumerates a list of column permissions for a specified permission on the view.
Public method EnumColumnPermissions(String, ObjectPermissionSet) Enumerates a list of column permissions for a specified grantee and a specified permission on the view.
Public method EnumColumns Enumerates a list of columns defined in the view.
Public method EnumFragmentation() Enumerates information about fragments of data that are stored in a table or view. (Inherited from TableViewBase.)
Public method 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.)
Public method 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.)
Public method EnumObjectPermissions() Enumerates a list of object permissions for the view.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the view.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the view.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the view.
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 view.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the view.
Public method 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 view.
Public method 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 view.
Public method 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 view.
Public method Grant(ObjectPermissionSet, array<String[], array<String[]) Grants the specified set of permissions to the grantees to the specified columns on the view.
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 view under an assumed role.
Public method 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 view.
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 view under an assumed role.
Public method 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 view.
Public method 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 view under an assumed role.
Public method 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 view 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 ReCompileReferences Recompiles any view or trigger that depends on the base SMO object. (Inherited from TableViewBase.)
Public method Refresh() Refreshes the View object or Table object properties. (Inherited from TableViewBase.)
Public method Refresh(Boolean) Refreshes the View object properties with the option to refresh metadata.
Public method Rename Renames the view.
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the view.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the view.
Public method Revoke(ObjectPermissionSet, String, array<String[]) Revokes a previously granted set of permissions from a grantee on the specified columns on the view.
Public method Revoke(ObjectPermissionSet, array<String[], array<String[]) Revokes a previously granted set of permissions from a list of grantees on the specified columns on the view.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes a previously granted set of permissions from a grantee on the view 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.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) Revokes a previously granted set of permissions from grantees on the view 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.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revokes a previously granted set of permissions from a grantee from the view 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, String, array<String[], Boolean, Boolean) Revokes a previously granted set of permissions from grantees on the specified columns on the view 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, array<String[], Boolean, Boolean, String) Revokes a previously granted set of permissions from grantees on the view 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.
Public method Revoke(ObjectPermissionSet, array<String[], array<String[], Boolean, Boolean) Revokes a previously granted set of permissions from grantees on the specified columns on the view 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, array<String[], Boolean, Boolean, String) Revokes a previously granted set of permissions from a grantee on the specified columns on the view 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[], array<String[], Boolean, Boolean, String) Revokes a previously granted set of permissions from the grantees for the specified columns on the view 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.
Public method Script() Generates a Transact-SQL script that can be used to re-create the database object. (Inherited from TableViewTableTypeBase.)
Public method 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.)
Public method ScriptHeader Returns the text header with the option to modify the text.
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 UpdateStatistics() Updates statistics for the table or view. (Inherited from TableViewBase.)
Public method 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.)
Public method 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.)
Public method 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.)
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 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 View object properties, users can be a member of the public fixed server role.

To set View object properties, ALTER permission on the view or ALTER VIEW permission on the database.

To create a view, users must CREATE VIEW permission on the database and ALTER permission on the specified schema.

To drop a view, users must have CONTROL permission on the view and ALTER permission on the specified schema.

To grant, deny, or revoke permissions on the view to other users, users must have CONTROL permission on the 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

Creating, Altering, and Removing Views

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

Designing and Implementing Views