DataFile Class

The DataFile object represents a SQL Server data file.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.DatabaseFile
          Microsoft.SqlServer.Management.Smo.DataFile

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

Syntax

'Declaration
<PhysicalFacetAttribute> _
<SfcElementTypeAttribute("File")> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class DataFile _
    Inherits DatabaseFile _
    Implements ICreatable, ISfcSupportsDesignMode
'Usage
Dim instance As DataFile

[PhysicalFacetAttribute]
[SfcElementTypeAttribute("File")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class DataFile : DatabaseFile, 
    ICreatable, ISfcSupportsDesignMode

[PhysicalFacetAttribute]
[SfcElementTypeAttribute(L"File")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class DataFile sealed : public DatabaseFile, 
    ICreatable, ISfcSupportsDesignMode

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<SfcElementTypeAttribute("File")>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type DataFile =  
    class 
        inherit DatabaseFile 
        interface ICreatable 
        interface ISfcSupportsDesignMode 
    end

public final class DataFile extends DatabaseFile implements ICreatable, ISfcSupportsDesignMode

The DataFile type exposes the following members.

Constructors

	Name	Description
	DataFile()	Initializes a new instance of the DataFile class.
	DataFile(FileGroup, String)	Initializes a new instance of the DataFile class on the specified file group with the specified name.
	DataFile(FileGroup, String, String)	Initializes a new instance of the DataFile class on the specified file group with the specified name and file name.

Top

Properties

	Name	Description
	AvailableSpace	Gets the amount of available space in the data file in KB.
	BytesReadFromDisk	Gets the number of bytes read from disk.
	BytesWrittenToDisk	Gets the number of bytes written to disk.
	FileName	Gets or sets the data file name.
	Growth	Gets or sets the growth increment for the data file in KB or percent.
	GrowthType	Gets or sets the growth type for the data file in kilobytes or percent.
	ID	Gets the ID value that uniquely identifies the data file.
	IsOffline	Gets the Boolean property value that specifies whether the data file is offline or not.
	IsPrimaryFile	Gets the Boolean property value that specifies whether the data file is the primary file of the database.
	IsReadOnly	Gets the Boolean property value that specifies whether the data file is read-only or can be updated.
	IsReadOnlyMedia	Gets the Boolean property value that specifies whether the data file is stored on read-only media.
	IsSparse	Gets the Boolean value that specifies whether the file is a sparse file. Sparse files are used in database snapshots.
	MaxSize	Gets or set the maximum size to which the data file can grow in KB.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	NumberOfDiskReads	Gets the number of disk reads.
	NumberOfDiskWrites	Gets the number of disk writes.
	Parent	Gets or sets the FileGroup object that is the parent of the DataFile object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	Size	Gets or sets the current size of the data file in KB.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UsedSpace	Gets the amount of used space in the data file in KB.
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
	VolumeFreeSpace	Gets the volume free space in bytes.

Top

Methods

	Name	Description
	Alter	Updates any property changes to the object to the instance of Microsoft SQL Server. (Inherited from DatabaseFile.)
	Create	Creates a data file on the instance of SQL Server as defined by the DataFile object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops a database file. (Inherited from DatabaseFile.)
	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.)
	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.)
	MarkForDrop	Marks the database file to be dropped next time its parent object is altered by the Alter method. (Inherited from DatabaseFile.)
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	Rename	Renames a database file. (Inherited from DatabaseFile.)
	SetOffline	Sets the database file status to offline.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	Shrink	Shrinks a database file. (Inherited from DatabaseFile.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	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	Gets a Boolean value that indicates whether the object supports design mode.

Top

Remarks

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

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

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

To drop a data file, users must have ALTER permission on the database or be a member of the db_owner fixed database 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

Files and Filegroups Architecture

CREATE DATABASE (Transact-SQL)