Share via


WarehouseAdapter Class

A Warehouse adapter When running as a TFS Job this adapter will by synchronized with other Warehouse jobs.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Warehouse.WarehouseAdapter

Namespace:  Microsoft.TeamFoundation.Warehouse
Assembly:  Microsoft.TeamFoundation.Warehouse (in Microsoft.TeamFoundation.Warehouse.dll)

Syntax

'Declaration
Public MustInherit Class WarehouseAdapter _
    Implements IDisposable
public abstract class WarehouseAdapter : IDisposable
public ref class WarehouseAdapter abstract : IDisposable
[<AbstractClass>]
type WarehouseAdapter =  
    class 
        interface IDisposable 
    end
public abstract class WarehouseAdapter implements IDisposable

The WarehouseAdapter type exposes the following members.

Constructors

  Name Description
Protected method WarehouseAdapter

Top

Properties

  Name Description
Public property IsWarehouseHostCancelled Has the Warehouse host been canceled. This is here as a convenience. Immediately before Stop is called by using a StopReason of HostCancelled this value is set to True otherwise it will be False.
Public property IsWarehouseSchemaLockRequested Has the warehouse schema lock been requested by another Warehouse job. This is here as a convenience. Immediately before Stop is called by using a StopReason of WarehouseSchemaLockRequested this value is set to True otherwise it will be False.
Public property RequestContext The Request Context. This can be used, for example, to access the rest of the TFS Services.
Public property WarehouseContext The Warehouse context.

Top

Methods

  Name Description
Public method Cancel Request this adapter to cancel execution.
Public method Dispose() Implement IDisposable. Do not make this method virtual.
Protected method Dispose(Boolean) Implementation of the actual clean up code.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method Initialize Initialize this extension.
Public method MakeDataChanges Add data to the Warehouse. This method runs in parallel with other warehouse jobs.
Public method MakeSchemaChanges Apply schema changes to the Warehouse or SSAS DB. When this method is executing this adapter is given exclusive access to the Warehouse and SSAS DB (except for user queries).
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

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.TeamFoundation.Warehouse Namespace