C# Class GSF.Snap.Services.ClientDatabaseBase

Represents a single historian database.

Inheritance: IDisposable

Show file Open project: GridProtectionAlliance/openHistorian Class Usage Examples

Public Methods

Method	Description
AttachFilesOrPaths ( IEnumerable paths ) : void	Loads the provided files from all of the specified paths.
DeleteFiles ( List files ) : void	Deletes the list of files from the database.
DetatchFiles ( List files ) : void	Detaches the list of files from the database.
Dispose ( ) : void	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetAllAttachedFiles ( ) : List	Enumerates all of the files attached to the database.
HardCommit ( ) : void	Forces a commit to the disk subsystem. Once this returns, the data will not be lost due to an application crash or unexpected shutdown. Hard commits can take 100ms or longer depending on how much data has to be committed. This requires two consecutive hardware cache flushes.
SoftCommit ( ) : void	Forces a soft commit on the database. A soft commit only commits data to memory. This allows other clients to read the data. While soft committed, this data could be lost during an unexpected shutdown. Soft commits usually occur within microseconds.

Method Details

AttachFilesOrPaths() public abstract method

Loads the provided files from all of the specified paths.

public abstract AttachFilesOrPaths ( IEnumerable paths ) : void
paths	IEnumerable	all of the paths of archive files to attach. These can either be a path, or an individual file name.
return	void

DeleteFiles() public abstract method

Deletes the list of files from the database.

public abstract DeleteFiles ( List files ) : void
files	List	the files that need to be deleted
return	void

DetatchFiles() public abstract method

Detaches the list of files from the database.

public abstract DetatchFiles ( List files ) : void
files	List	the file ids that need to be detatched.
return	void

Dispose() public abstract method

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public abstract Dispose ( ) : void
return	void

GetAllAttachedFiles() public abstract method

Enumerates all of the files attached to the database.

public abstract GetAllAttachedFiles ( ) : List
return	List

HardCommit() public abstract method

Forces a commit to the disk subsystem. Once this returns, the data will not be lost due to an application crash or unexpected shutdown. Hard commits can take 100ms or longer depending on how much data has to be committed. This requires two consecutive hardware cache flushes.

public abstract HardCommit ( ) : void
return	void

SoftCommit() public abstract method

Forces a soft commit on the database. A soft commit only commits data to memory. This allows other clients to read the data. While soft committed, this data could be lost during an unexpected shutdown. Soft commits usually occur within microseconds.

public abstract SoftCommit ( ) : void
return	void