FileGroup Class
TOC
Collapse the table of content
Expand the table of content

FileGroup Class

 

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

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


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

NameDescription
System_CAPS_pubmethodFileGroup()

Initializes a new instance of the FileGroup class.

System_CAPS_pubmethodFileGroup(Database, String)

Initializes a new instance of the FileGroup class on the specified database that has the specified name.

System_CAPS_pubmethodFileGroup(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.

System_CAPS_pubmethodFileGroup(Database, String, FileGroupType)

Represents a SQL Server filegroup.

NameDescription
System_CAPS_pubpropertyFileGroupType

Returns the setting of FileGroupType.

System_CAPS_pubpropertyFiles

Represents a collection of DataFile objects. Each DataFile object represents a file belonging to the file group.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the file group.

System_CAPS_pubpropertyIsDefault

Gets or sets the Boolean value that specifies whether the file group is the default file group for the database.

System_CAPS_pubpropertyIsFileStream

Gets the Boolean value that specifies whether the file group is of type FILESTREAM.

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubpropertyParent

Gets or sets the parent Database object of the FileGroup object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyReadOnly

Gets the Boolean value that specifies whether the file group is read-only.

System_CAPS_pubpropertySize

Gets or sets the size of the file group in KB.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any property changes to the FileGroup object on the instance of SQL Server. 

System_CAPS_pubmethodCheckFileGroup()

Scans and tests the integrity of database pages maintained in operating system files that implement the file group.

System_CAPS_pubmethodCheckFileGroupDataOnly()

Scans and tests the integrity of database pages that are used to maintain table data in operating system files that implement the file group.

System_CAPS_pubmethodCreate()

Creates a new file group based on the FileGroup object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Drops the file group from the database.

System_CAPS_pubmethodEnumObjects()

Enumerates the system and user-defined tables, indexes, and statistics mechanisms stored within a file group.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodMarkForDrop(Boolean)

Marks the file group to be dropped next time its parent Database object is altered by the Alter method.

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRename(String)

Renames the file group.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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.

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft