Export (0) Print
Expand All

DataFile Class

 

Applies To: SQL Server 2016 Preview

The DataFile object represents a SQL Server data file.

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


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

NameDescription
System_CAPS_pubmethodDataFile()

Initializes a new instance of the DataFile class.

System_CAPS_pubmethodDataFile(FileGroup, String)

Initializes a new instance of the DataFile class on the specified file group with the specified name.

System_CAPS_pubmethodDataFile(FileGroup, String, String)

Initializes a new instance of the DataFile class on the specified file group with the specified name and file name.

NameDescription
System_CAPS_pubpropertyAvailableSpace

Gets the amount of available space in the data file in KB.

System_CAPS_pubpropertyBytesReadFromDisk

Gets the number of bytes read from disk.

System_CAPS_pubpropertyBytesWrittenToDisk

Gets the number of bytes written to disk.

System_CAPS_pubpropertyFileName

Gets or sets the data file name.

System_CAPS_pubpropertyFileSegments

Gets the collection of file segments.(Inherited from DatabaseFile.)

System_CAPS_pubpropertyGrowth

Gets or sets the growth increment for the data file in KB or percent.

System_CAPS_pubpropertyGrowthType

Gets or sets the growth type for the data file in kilobytes or percent.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the data file.

System_CAPS_pubpropertyIsOffline

Gets the Boolean property value that specifies whether the data file is offline or not.

System_CAPS_pubpropertyIsPrimaryFile

Gets the Boolean property value that specifies whether the data file is the primary file of the database.

System_CAPS_pubpropertyIsReadOnly

Gets the Boolean property value that specifies whether the data file is read-only or can be updated.

System_CAPS_pubpropertyIsReadOnlyMedia

Gets the Boolean property value that specifies whether the data file is stored on read-only media.

System_CAPS_pubpropertyIsSparse

Gets the Boolean value that specifies whether the file is a sparse file. Sparse files are used in database snapshots.

System_CAPS_pubpropertyMaxSize

Gets or set the maximum size to which the data file can grow in KB.

System_CAPS_pubpropertyName

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

System_CAPS_pubpropertyNumberOfDiskReads

Gets the number of disk reads.

System_CAPS_pubpropertyNumberOfDiskWrites

Gets the number of disk writes.

System_CAPS_pubpropertyParent

Gets or sets the FileGroup object that is the parent of the DataFile object.

System_CAPS_pubpropertyProperties

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

System_CAPS_pubpropertySize

Gets or sets the current size of the data file 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_pubpropertyUsedSpace

Gets the amount of used space in the data file in KB.

System_CAPS_pubpropertyUserData

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

System_CAPS_pubpropertyVolumeFreeSpace

Gets the volume free space in bytes.

NameDescription
System_CAPS_pubmethodAlter()

Updates any property changes to the object to the instance of Microsoft SQL Server.(Inherited from DatabaseFile.)

System_CAPS_pubmethodCreate()

Creates a data file on the instance of SQL Server as defined by the DataFile object.

System_CAPS_pubmethodDiscover()

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

System_CAPS_pubmethodDrop()

Drops a database file.(Inherited from DatabaseFile.)

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 database file to be dropped next time its parent object is altered by the Alter method.(Inherited from DatabaseFile.)

System_CAPS_pubmethodRefresh()

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

System_CAPS_pubmethodRename(String)

Renames a database file.(Inherited from DatabaseFile.)

System_CAPS_pubmethodSetOffline()

Sets the database file status to offline.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

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

System_CAPS_pubmethodShrink(Int32, ShrinkMethod)

Shrinks a database file.(Inherited from DatabaseFile.)

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

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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft