FileGroup Class

  • Article

The FileGroup object represents a SQL Server file group. For more information about file groups, see Using Filegroups and Files to Store Data.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.FileGroup

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class FileGroup _
    Inherits NamedSmoObject _
    Implements ICreatable, IAlterable, IDroppable, IRenamable,  _
    IMarkForDrop, ISfcSupportsDesignMode
'Usage
Dim instance As FileGroup

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class FileGroup : NamedSmoObject, 
    ICreatable, IAlterable, IDroppable, IRenamable, IMarkForDrop, 
    ISfcSupportsDesignMode

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class FileGroup sealed : public NamedSmoObject, 
    ICreatable, IAlterable, IDroppable, IRenamable, IMarkForDrop, 
    ISfcSupportsDesignMode

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type FileGroup =  
    class 
        inherit NamedSmoObject 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IRenamable 
        interface IMarkForDrop 
        interface ISfcSupportsDesignMode 
    end

public final class FileGroup extends NamedSmoObject implements ICreatable, IAlterable, IDroppable, IRenamable, IMarkForDrop, ISfcSupportsDesignMode

The FileGroup type exposes the following members.

Constructors

  Name Description
Public method FileGroup() Initializes a new instance of the FileGroup class.
Public method FileGroup(Database, String) Initializes a new instance of the FileGroup class on the specified database that has the specified name.
Public method FileGroup(Database, String, Boolean) Initializes a new instance of the FileGroup class on the specified database with the specified name. Optionally, enables a FILESTREAM file group to be created.

Top

Properties

  Name Description
Public property Files Represents a collection of DataFile objects. Each DataFile object represents a file belonging to the file group.
Public property ID Gets the ID value that uniquely identifies the file group.
Public property IsDefault Gets or sets the Boolean value that specifies whether the file group is the default file group for the database.
Public property IsFileStream Gets the Boolean value that specifies whether the file group is of type FILESTREAM.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property Parent Gets or sets the parent Database object of the FileGroup object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property ReadOnly Gets the Boolean value that specifies whether the file group is read-only.
Public property Size Gets or sets the size of the file group in KB.
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 Updates any property changes to the FileGroup object on the instance of SQL Server. 
Public method CheckFileGroup Scans and tests the integrity of database pages maintained in operating system files that implement the file group.
Public method CheckFileGroupDataOnly Scans and tests the integrity of database pages that are used to maintain table data in operating system files that implement the file group.
Public method Create Creates a new file group based on the FileGroup object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops the file group from the database.
Public method EnumObjects Enumerates the system and user-defined tables, indexes, and statistics mechanisms stored within a file group.
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 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 MarkForDrop Marks the file group to be dropped next time its parent Database object is altered by the Alter method.
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method Rename Renames the file group.
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 Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

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

To set FileGroup object properties, users must have ALTER permission on the database or be a member of the db_owner fixed database role.

To create a file group, users must have ALTER permission on the database or be a member of the db_owner fixed database role.

To drop a file group, users must have ALTER permission on the database or be a member of the db_owner fixed database role.

To run CheckFileGroup and CheckFileGroupDataOnly methods, users must be a member of the db_owner fixed database role or the sysadmin fixed server role.

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

Using Filegroups and Files to Store Data

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

ALTER TABLE (Transact-SQL)

Using Files and Filegroups

CREATE TABLE (Transact-SQL)