Export (0) Print
Expand All

LogFile Class

The LogFile object represents a SQL Server log file.

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

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

The LogFile type exposes the following members.

  NameDescription
Public methodLogFile()Initializes a new instance of the LogFile class.
Public methodLogFile(Database, String)Initializes a new instance of the LogFile class for the specified database and that has the specified name.
Public methodLogFile(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

  NameDescription
Public propertyBytesReadFromDiskGets the number of bytes read from disk.
Public propertyBytesWrittenToDiskGets the number of bytes written to disk.
Public propertyFileNameGets or sets the file name of the log file.
Public propertyFileSegmentsGets the collection of file segments. (Inherited from DatabaseFile.)
Public propertyGrowthGets or sets the growth increment for the log file in KB or percent.
Public propertyGrowthTypeGets or sets the growth type for the data file in KB or percent.
Public propertyIDGets the ID value that uniquely identifies the log file.
Public propertyIsOfflineGets the Boolean value that specifies whether the log file is offline or not.
Public propertyIsReadOnlyGets the Boolean value that specifies whether the log file is read-only or can be updated.
Public propertyIsReadOnlyMediaGets the Boolean value that specifies whether the log file is stored on read-only media.
Public propertyIsSparseGets the Boolean value that specifies whether the file is a sparse file. Sparse files are used in database snapshots.
Public propertyMaxSizeGets or set the maximum size to which the file can grow, in MB.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyNumberOfDiskReadsGets an Int64 value that specifies the number of disk reads.
Public propertyNumberOfDiskWritesGets an Int64 value that specifies the number of disk writes.
Public propertyParentGets or sets the Database object that is the parent of the LogFile object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertySizeGets or sets the current size of the log file, in KB.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUsedSpaceGets the amount of used space in the log file in KB.
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public propertyVolumeFreeSpaceGets an Int64 value that specifies the volume free space in bytes.
Top

  NameDescription
Public methodAlterUpdates any property changes to the object to the instance of Microsoft SQL Server. (Inherited from DatabaseFile.)
Public methodCreateCreates a log file on the instance of SQL Server as defined by the LogFile object.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropDrops a database file. (Inherited from DatabaseFile.)
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodMarkForDropMarks the database file to be dropped next time its parent object is altered by the Alter method. (Inherited from DatabaseFile.)
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRenameRenames a database file. (Inherited from DatabaseFile.)
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodShrinkShrinks a database file. (Inherited from DatabaseFile.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject::DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetParentGets 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 methodIAlienObject::GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetUrnGets 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 methodIAlienObject::ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider::GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode::IsDesignModeGets a Boolean value that specifies whether the object supports design mode.
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft