C# Class Raven.Client.DocumentStoreBase

Contains implementation of some IDocumentStore operations shared by DocumentStore implementations

Inheritance: IDocumentStore

Show file Open project: robashton/ravendb

Protected Properties

Property	Type	Description
initialized	bool
listeners	Raven.Client.Document.DocumentSessionListeners
profilingContext	Raven.Client.Connection.Profiling.ProfilingContext

Public Methods

Method	Description
AggressivelyCache ( ) : IDisposable	Setup the context for aggressive caching.
AggressivelyCacheFor ( System.TimeSpan cacheDuration ) : IDisposable	Subscribe to change notifications from the server
BulkInsert ( string database = null, Raven.Abstractions.Data.BulkInsertOptions options = null ) : Raven.Client.Document.BulkInsertOperation
Changes ( string database = null ) : IDatabaseChanges
DisableAggressiveCaching ( ) : IDisposable
Dispose ( ) : void
ExecuteIndex ( Raven.Client.Indexes.AbstractIndexCreationTask indexCreationTask ) : void	Executes the index creation.
ExecuteTransformer ( AbstractTransformerCreationTask transformerCreationTask ) : void	Executes the transformer creation
GetLastWrittenEtag ( ) : Etag	Gets the etag of the last document written by any session belonging to this document store
GetProfilingInformationFor ( System.Guid id ) : ProfilingInformation	Get the profiling information for the given id
Initialize ( ) : IDocumentStore
OpenAsyncSession ( ) : IAsyncDocumentSession
OpenAsyncSession ( string database ) : IAsyncDocumentSession
OpenSession ( ) : IDocumentSession
OpenSession ( Raven.Client.Document.OpenSessionOptions sessionOptions ) : IDocumentSession
OpenSession ( string database ) : IDocumentSession
RegisterListener ( IDocumentConflictListener conflictListener ) : DocumentStoreBase	Registers the conflict listener.
RegisterListener ( IDocumentConversionListener conversionListener ) : DocumentStoreBase	Registers the conversion listener.
RegisterListener ( IDocumentDeleteListener deleteListener ) : DocumentStoreBase	Registers the delete listener.
RegisterListener ( IDocumentQueryListener queryListener ) : DocumentStoreBase	Registers the query listener.
RegisterListener ( IExtendedDocumentConversionListener conversionListener ) : DocumentStoreBase	Registers the extended conversion listener.
RegisterListener ( IDocumentStoreListener documentStoreListener ) : IDocumentStore	Registers the store listener.

Protected Methods

Method	Description
AfterSessionCreated ( InMemoryDocumentSessionOperations session ) : void
AssertInitialized ( ) : void
DocumentStoreBase ( ) : System
EnsureNotClosed ( ) : void

Method Details

AfterSessionCreated() protected method

protected AfterSessionCreated ( InMemoryDocumentSessionOperations session ) : void
session	InMemoryDocumentSessionOperations
return	void

AggressivelyCache() public method

Setup the context for aggressive caching.

public AggressivelyCache ( ) : IDisposable
return	IDisposable

AggressivelyCacheFor() public abstract method

Subscribe to change notifications from the server

public abstract AggressivelyCacheFor ( System.TimeSpan cacheDuration ) : IDisposable
cacheDuration	System.TimeSpan
return	IDisposable

AssertInitialized() protected method

protected AssertInitialized ( ) : void
return	void

BulkInsert() public abstract method

public abstract BulkInsert ( string database = null, Raven.Abstractions.Data.BulkInsertOptions options = null ) : Raven.Client.Document.BulkInsertOperation
database	string
options	Raven.Abstractions.Data.BulkInsertOptions
return	Raven.Client.Document.BulkInsertOperation

Changes() public abstract method

public abstract Changes ( string database = null ) : IDatabaseChanges
database	string
return	IDatabaseChanges

DisableAggressiveCaching() public abstract method

public abstract DisableAggressiveCaching ( ) : IDisposable
return	IDisposable

Dispose() public abstract method

public abstract Dispose ( ) : void
return	void

DocumentStoreBase() protected method

protected DocumentStoreBase ( ) : System
return	System

EnsureNotClosed() protected method

protected EnsureNotClosed ( ) : void
return	void

ExecuteIndex() public method

Executes the index creation.

public ExecuteIndex ( Raven.Client.Indexes.AbstractIndexCreationTask indexCreationTask ) : void
indexCreationTask	Raven.Client.Indexes.AbstractIndexCreationTask
return	void

ExecuteTransformer() public method

Executes the transformer creation

public ExecuteTransformer ( AbstractTransformerCreationTask transformerCreationTask ) : void
transformerCreationTask	Raven.Client.Indexes.AbstractTransformerCreationTask
return	void

GetLastWrittenEtag() public method

Gets the etag of the last document written by any session belonging to this document store

public GetLastWrittenEtag ( ) : Etag
return	Etag

GetProfilingInformationFor() public method

Get the profiling information for the given id

public GetProfilingInformationFor ( System.Guid id ) : ProfilingInformation
id	System.Guid
return	Raven.Client.Connection.Profiling.ProfilingInformation

Initialize() public abstract method

public abstract Initialize ( ) : IDocumentStore
return	IDocumentStore

OpenAsyncSession() public abstract method

public abstract OpenAsyncSession ( ) : IAsyncDocumentSession
return	IAsyncDocumentSession

OpenAsyncSession() public abstract method

public abstract OpenAsyncSession ( string database ) : IAsyncDocumentSession
database	string
return	IAsyncDocumentSession

OpenSession() public abstract method

public abstract OpenSession ( ) : IDocumentSession
return	IDocumentSession

OpenSession() public abstract method

public abstract OpenSession ( Raven.Client.Document.OpenSessionOptions sessionOptions ) : IDocumentSession
sessionOptions	Raven.Client.Document.OpenSessionOptions
return	IDocumentSession

OpenSession() public abstract method

public abstract OpenSession ( string database ) : IDocumentSession
database	string
return	IDocumentSession

RegisterListener() public method

Registers the conflict listener.

public RegisterListener ( IDocumentConflictListener conflictListener ) : DocumentStoreBase
conflictListener	IDocumentConflictListener	The conflict listener.
return	DocumentStoreBase

RegisterListener() public method

Registers the conversion listener.

public RegisterListener ( IDocumentConversionListener conversionListener ) : DocumentStoreBase
conversionListener	IDocumentConversionListener
return	DocumentStoreBase

RegisterListener() public method

Registers the delete listener.

public RegisterListener ( IDocumentDeleteListener deleteListener ) : DocumentStoreBase
deleteListener	IDocumentDeleteListener	The delete listener.
return	DocumentStoreBase

RegisterListener() public method

Registers the query listener.

public RegisterListener ( IDocumentQueryListener queryListener ) : DocumentStoreBase
queryListener	IDocumentQueryListener	The query listener.
return	DocumentStoreBase

RegisterListener() public method

Registers the extended conversion listener.

public RegisterListener ( IExtendedDocumentConversionListener conversionListener ) : DocumentStoreBase
conversionListener	IExtendedDocumentConversionListener
return	DocumentStoreBase

RegisterListener() public method

Registers the store listener.

public RegisterListener ( IDocumentStoreListener documentStoreListener ) : IDocumentStore
documentStoreListener	IDocumentStoreListener	The document store listener.
return	IDocumentStore

Property Details

initialized protected property

protected bool initialized
return	bool

listeners protected property

protected DocumentSessionListeners,Raven.Client.Document listeners
return	Raven.Client.Document.DocumentSessionListeners

profilingContext protected property

protected ProfilingContext,Raven.Client.Connection.Profiling profilingContext
return	Raven.Client.Connection.Profiling.ProfilingContext