Sdílet prostřednictvím

LogFile Class

  • Článek

The LogFile object represents a SQL Server log 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.LogFile

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

Syntax

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

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class LogFile : DatabaseFile, 
    ICreatable, ISfcSupportsDesignMode

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class LogFile sealed : public DatabaseFile, 
    ICreatable, ISfcSupportsDesignMode

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

public final class LogFile extends DatabaseFile implements ICreatable, ISfcSupportsDesignMode

The LogFile type exposes the following members.

Constructors

  Name Description
Public method LogFile() Initializes a new instance of the LogFile class.
Public method LogFile(Database, String) Initializes a new instance of the LogFile class for the specified database and that has the specified name.
Public method LogFile(Database, String, String) Initializes a new instance of the LogFile class for the specified database and that has the specified name and physical file name.

Top

Properties

  Name Description
Public property BytesReadFromDisk Gets the number of bytes read from disk.
Public property BytesWrittenToDisk Gets the number of bytes written to disk.
Public property FileName Gets or sets the file name of the log file.
Public property Growth Gets or sets the growth increment for the log file in KB or percent.
Public property GrowthType Gets or sets the growth type for the data file in KB or percent.
Public property ID Gets the ID value that uniquely identifies the log file.
Public property IsOffline Gets the Boolean value that specifies whether the log file is offline or not.
Public property IsReadOnly Gets the Boolean value that specifies whether the log file is read-only or can be updated.
Public property IsReadOnlyMedia Gets the Boolean value that specifies whether the log file is stored on read-only media.
Public property IsSparse Gets the Boolean value that specifies whether the file is a sparse file. Sparse files are used in database snapshots.
Public property MaxSize Gets or set the maximum size to which the file can grow, in MB.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property NumberOfDiskReads Gets an Int64 value that specifies the number of disk reads.
Public property NumberOfDiskWrites Gets an Int64 value that specifies the number of disk writes.
Public property Parent Gets or sets the Database object that is the parent of the LogFile object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property Size Gets or sets the current size of the log file, 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 UsedSpace Gets the amount of used space in the log file in KB.
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public property VolumeFreeSpace Gets an Int64 value that specifies the volume free space in bytes.

Top

Methods

  Name Description
Public method Alter Updates any property changes to the object to the instance of Microsoft SQL Server. (Inherited from DatabaseFile.)
Public method Create Creates a log file on the instance of SQL Server as defined by the LogFile object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops a database file. (Inherited from DatabaseFile.)
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 database file to be dropped next time its parent object is altered by the Alter method. (Inherited from DatabaseFile.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method Rename Renames a database file. (Inherited from DatabaseFile.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method Shrink Shrinks a database file. (Inherited from DatabaseFile.)
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 specifies whether the object supports design mode.

Top

Remarks

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

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

To create or drop a log 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

Using Filegroups and Files to Store Data