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. | |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.) | |
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. | |
IsTouched | Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.) | |
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. | |
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.) | |
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.) | |
ScalarResult | Gets the scalar result for the referenced object. (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 | |
---|---|---|
AddDatabaseContext(StringCollection) | Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.) | |
AddDatabaseContext(StringCollection, ScriptingOptions) | Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options. (Inherited from SqlSmoObject.) | |
Alter | Updates any property changes to the object to the instance of Microsoft SQL Server. (Inherited from DatabaseFile.) | |
AlterImpl | Activates the object altered event. (Inherited from SqlSmoObject.) | |
AlterImplFinish | Method called when object altered event finishes. (Inherited from SqlSmoObject.) | |
AlterImplInit | Method called when object-altered event is intialized. (Inherited from SqlSmoObject.) | |
AlterImplWorker | Calls the Alter methods. (Inherited from SqlSmoObject.) | |
BindDefaultImpl | Binds the default items identified by the parameters. (Inherited from SqlSmoObject.) | |
BindRuleImpl | Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.) | |
CheckCollation | Checks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.) | |
CheckObjectState() | Validates the state of the referenced object. (Inherited from SqlSmoObject.) | |
CheckObjectState(Boolean) | Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.) | |
CheckObjectStateImpl | Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.) | |
CheckVersion100 | Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.) | |
CheckVersion80 | Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.) | |
CheckVersion80SP3 | Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.) | |
CheckVersion90 | Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.) | |
CheckVersionBelow90 | Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.) | |
CleanObject | Sets the object to unmodified state. (Inherited from SqlSmoObject.) | |
Create | Creates a data file on the instance of SQL Server as defined by the DataFile object. | |
CreateImpl | Creates an object with scripting options. (Inherited from SqlSmoObject.) | |
CreateImplFinish | Method called when the create event finishes. (Inherited from SqlSmoObject.) | |
CreateImplInit | Method called when the create event initializes. (Inherited from SqlSmoObject.) | |
Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) | |
Drop | Drops a database file. (Inherited from DatabaseFile.) | |
DropImpl | Drops a SqlSmoObject. (Inherited from SqlSmoObject.) | |
DropImplWorker | Calls the drop methods. (Inherited from SqlSmoObject.) | |
EnumScriptImpl | Enumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.) | |
EnumScriptImplWorker | Calls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.) | |
EnumScriptImplWorkerSOChanged | Returns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.) | |
Equals | (Inherited from Object.) | |
ExecuteNonQuery | Executes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.) | |
Finalize | (Inherited from Object.) | |
FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) | |
GenerateDataSpaceFileStreamScript | Generates a script to create data file. (Inherited from SqlSmoObject.) | |
GenerateDataSpaceScript | Generates a script to allocate space in the data file. (Inherited from SqlSmoObject.) | |
GetBindDefaultScript | Gets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.) | |
GetBindRuleScript | Gets the script that specifies the binding rules. (Inherited from SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetDateTimeParameter | Assigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetDateTimeParameterAsInt | Assigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.) | |
GetDBName | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) | |
GetEnumParameter | Assigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetFragOptionString | Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.) | |
GetGuidParameter | Assigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetHashCode | (Inherited from Object.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
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.) | |
GetRealValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetScriptingOptionsForCreate | Gets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetServerName | Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) | |
GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetSqlServerVersionName | Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetTimeSpanParameterAsInt | Assigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetType | (Inherited from Object.) | |
GetUrnRecursive(StringBuilder) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
ImplInitialize | Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
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.) | |
IsObjectDirty | Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (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.) | |
IsVersion80SP3 | Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.) | |
IsVersion90AndAbove | Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.) | |
MarkDropped | Sets the SqlSmoState to dropped. (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.) | |
MarkForDropImpl | Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.) | |
MemberwiseClone | (Inherited from Object.) | |
PostAlter | Method activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.) | |
PostCreate | Method activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.) | |
PostDrop | Method activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.) | |
Refresh | Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.) | |
Rename | Renames a database file. (Inherited from DatabaseFile.) | |
RenameImpl | Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.) | |
RenameImplWorker | Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.) | |
ScriptAlter | Alters the script that is used to create the file in the database. (Inherited from DatabaseFile.) | |
ScriptChangeOwner | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) | |
ScriptCreate | Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.) | |
ScriptDdl | Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.) | |
ScriptDrop | Drops the script that is used to create the file in the database. (Inherited from DatabaseFile.) | |
ScriptImpl() | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
ScriptImpl(ScriptingOptions) | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
ScriptImplWorker | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
ScriptOwner | Alters the script owner authorization. (Inherited from NamedSmoObject.) | |
ScriptRename | Renames the script in the 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.) | |
SetSchemaOwned | Sets the schema owned value. (Inherited from NamedSmoObject.) | |
Shrink | Shrinks a database file. (Inherited from DatabaseFile.) | |
ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) | |
TouchImpl | Not implemented. (Inherited from SqlSmoObject.) | |
UnbindDefaultImpl | Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
UnbindRuleImpl | Unbinds rules of the SqlSmoObject. (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
Fields
Name | Description | |
---|---|---|
m_ExtendedProperties | Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.) | |
singletonParent | Represents the singleton parent. (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 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 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. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (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.
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