C# Class Raven.Database.DocumentDatabase

Inheritance: IUuidGenerator, IDisposable
Afficher le fichier Open project: nhsevidence/ravendb Class Usage Examples

Private Properties

Свойство Type Description
AddIndexingTask void
AssertAttachmentDeleteOperationNotVetoed void
AssertAttachmentPutOperationNotVetoed void
AssertDeleteOperationNotVetoed void
AssertPutOperationNotVetoed void
ExecuteAlterConfiguration void
ExecuteAttachmentReadTriggers void
ExecuteStartupTasks void
GetNextIdentityValueWithoutOverritingOnExistingDocuments long
InitializeTriggers void
ProcessAttachmentReadVetoes Attachment
RemoveReservedProperties void
TryCompletePromotedTransaction void
TryUndoPromotedTransaction void

Méthodes publiques

Méthode Description
ApplyPatch ( string docId, System.Guid etag, PatchRequest patchDoc, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : PatchResult
Batch ( IEnumerable commands ) : BatchResult[]
Commit ( System.Guid txId ) : void
CreateSequentialUuid ( ) : System.Guid
Delete ( string key, System.Guid etag, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : void
DeleteIndex ( string name ) : void
DeleteStatic ( string name, System.Guid etag ) : void
DisableAllTriggersForCurrentThread ( ) : IDisposable

This API is provided solely for the use of bundles that might need to run without any other bundle interfering. Specifically, the replication bundle need to be able to run without interference from any other bundle.

Dispose ( ) : void
DocumentDatabase ( InMemoryRavenConfiguration configuration ) : System
Get ( string key, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : JsonDocument
GetAttachments ( int start, int pageSize, System.Guid etag ) : Raven.Database.Data.AttachmentInformation[]
GetDocumentMetadata ( string key, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : JsonDocumentMetadata
GetDocuments ( int start, int pageSize, System.Guid etag ) : RavenJArray
GetDocumentsWithIdStartingWith ( string idPrefix, int start, int pageSize ) : RavenJArray
GetIndexDefinition ( string index ) : Raven.Database.Indexing.IndexDefinition
GetIndexEtag ( string indexName ) : System.Guid
GetIndexFields ( string index ) : string[]
GetIndexNames ( int start, int pageSize ) : RavenJArray
GetIndexes ( int start, int pageSize ) : RavenJArray
GetStatic ( string name ) : Attachment
GetTotalSizeOnDisk ( ) : long

Get the total size taken by the database on the disk. This explicitly does NOT include in memory indexes or in memory database. It does include any reserved space on the file system, which may significantly increase the database size.

This is a potentially a very expensive call, avoid making it if possible.

HasTransaction ( System.Guid txId ) : bool
PromoteTransaction ( System.Guid fromTxId ) : byte[]
Put ( string key, System.Guid etag, RavenJObject document, RavenJObject metadata, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : PutResult
PutIndex ( string name, Raven.Database.Indexing.IndexDefinition definition ) : string
PutStatic ( string name, System.Guid etag, byte data, RavenJObject metadata ) : void
Query ( string index, IndexQuery query ) : QueryResult
QueryDocumentIds ( string index, IndexQuery query, bool &stale ) : IEnumerable
ResetIndex ( string index ) : void
Restore ( RavenConfiguration configuration, string backupLocation, string databaseLocation ) : void
Rollback ( System.Guid txId ) : void
SpinBackgroundWorkers ( ) : void
StartBackup ( string backupDestinationDirectory ) : void
StopBackgroundWokers ( ) : void

Private Methods

Méthode Description
AddIndexingTask ( IStorageActionsAccessor actions, RavenJToken metadata, Func taskGenerator ) : void
AssertAttachmentDeleteOperationNotVetoed ( string key ) : void
AssertAttachmentPutOperationNotVetoed ( string key, RavenJObject metadata, byte data ) : void
AssertDeleteOperationNotVetoed ( string key, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : void
AssertPutOperationNotVetoed ( string key, RavenJObject metadata, RavenJObject document, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : void
ExecuteAlterConfiguration ( ) : void
ExecuteAttachmentReadTriggers ( string name, Attachment attachment ) : void
ExecuteStartupTasks ( ) : void
GetNextIdentityValueWithoutOverritingOnExistingDocuments ( string key, IStorageActionsAccessor actions, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : long
InitializeTriggers ( ) : void
ProcessAttachmentReadVetoes ( string name, Attachment attachment ) : Attachment
RemoveReservedProperties ( RavenJObject document ) : void
TryCompletePromotedTransaction ( System.Guid txId ) : void
TryUndoPromotedTransaction ( System.Guid txId ) : void

Method Details

ApplyPatch() public méthode

public ApplyPatch ( string docId, System.Guid etag, PatchRequest patchDoc, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : PatchResult
docId string
etag System.Guid
patchDoc PatchRequest
transactionInformation Raven.Abstractions.Data.TransactionInformation
Résultat PatchResult

Batch() public méthode

public Batch ( IEnumerable commands ) : BatchResult[]
commands IEnumerable
Résultat BatchResult[]

Commit() public méthode

public Commit ( System.Guid txId ) : void
txId System.Guid
Résultat void

CreateSequentialUuid() public méthode

public CreateSequentialUuid ( ) : System.Guid
Résultat System.Guid

Delete() public méthode

public Delete ( string key, System.Guid etag, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : void
key string
etag System.Guid
transactionInformation Raven.Abstractions.Data.TransactionInformation
Résultat void

DeleteIndex() public méthode

public DeleteIndex ( string name ) : void
name string
Résultat void

DeleteStatic() public méthode

public DeleteStatic ( string name, System.Guid etag ) : void
name string
etag System.Guid
Résultat void

DisableAllTriggersForCurrentThread() public méthode

This API is provided solely for the use of bundles that might need to run without any other bundle interfering. Specifically, the replication bundle need to be able to run without interference from any other bundle.
public DisableAllTriggersForCurrentThread ( ) : IDisposable
Résultat IDisposable

Dispose() public méthode

public Dispose ( ) : void
Résultat void

DocumentDatabase() public méthode

public DocumentDatabase ( InMemoryRavenConfiguration configuration ) : System
configuration InMemoryRavenConfiguration
Résultat System

Get() public méthode

public Get ( string key, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : JsonDocument
key string
transactionInformation Raven.Abstractions.Data.TransactionInformation
Résultat JsonDocument

GetAttachments() public méthode

public GetAttachments ( int start, int pageSize, System.Guid etag ) : Raven.Database.Data.AttachmentInformation[]
start int
pageSize int
etag System.Guid
Résultat Raven.Database.Data.AttachmentInformation[]

GetDocumentMetadata() public méthode

public GetDocumentMetadata ( string key, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : JsonDocumentMetadata
key string
transactionInformation Raven.Abstractions.Data.TransactionInformation
Résultat JsonDocumentMetadata

GetDocuments() public méthode

public GetDocuments ( int start, int pageSize, System.Guid etag ) : RavenJArray
start int
pageSize int
etag System.Guid
Résultat RavenJArray

GetDocumentsWithIdStartingWith() public méthode

public GetDocumentsWithIdStartingWith ( string idPrefix, int start, int pageSize ) : RavenJArray
idPrefix string
start int
pageSize int
Résultat RavenJArray

GetIndexDefinition() public méthode

public GetIndexDefinition ( string index ) : Raven.Database.Indexing.IndexDefinition
index string
Résultat Raven.Database.Indexing.IndexDefinition

GetIndexEtag() public méthode

public GetIndexEtag ( string indexName ) : System.Guid
indexName string
Résultat System.Guid

GetIndexFields() public méthode

public GetIndexFields ( string index ) : string[]
index string
Résultat string[]

GetIndexNames() public méthode

public GetIndexNames ( int start, int pageSize ) : RavenJArray
start int
pageSize int
Résultat RavenJArray

GetIndexes() public méthode

public GetIndexes ( int start, int pageSize ) : RavenJArray
start int
pageSize int
Résultat RavenJArray

GetStatic() public méthode

public GetStatic ( string name ) : Attachment
name string
Résultat Attachment

GetTotalSizeOnDisk() public méthode

Get the total size taken by the database on the disk. This explicitly does NOT include in memory indexes or in memory database. It does include any reserved space on the file system, which may significantly increase the database size.
This is a potentially a very expensive call, avoid making it if possible.
public GetTotalSizeOnDisk ( ) : long
Résultat long

HasTransaction() public méthode

public HasTransaction ( System.Guid txId ) : bool
txId System.Guid
Résultat bool

PromoteTransaction() public méthode

public PromoteTransaction ( System.Guid fromTxId ) : byte[]
fromTxId System.Guid
Résultat byte[]

Put() public méthode

public Put ( string key, System.Guid etag, RavenJObject document, RavenJObject metadata, Raven.Abstractions.Data.TransactionInformation transactionInformation ) : PutResult
key string
etag System.Guid
document RavenJObject
metadata RavenJObject
transactionInformation Raven.Abstractions.Data.TransactionInformation
Résultat PutResult

PutIndex() public méthode

public PutIndex ( string name, Raven.Database.Indexing.IndexDefinition definition ) : string
name string
definition Raven.Database.Indexing.IndexDefinition
Résultat string

PutStatic() public méthode

public PutStatic ( string name, System.Guid etag, byte data, RavenJObject metadata ) : void
name string
etag System.Guid
data byte
metadata RavenJObject
Résultat void

Query() public méthode

public Query ( string index, IndexQuery query ) : QueryResult
index string
query IndexQuery
Résultat QueryResult

QueryDocumentIds() public méthode

public QueryDocumentIds ( string index, IndexQuery query, bool &stale ) : IEnumerable
index string
query IndexQuery
stale bool
Résultat IEnumerable

ResetIndex() public méthode

public ResetIndex ( string index ) : void
index string
Résultat void

Restore() public static méthode

public static Restore ( RavenConfiguration configuration, string backupLocation, string databaseLocation ) : void
configuration RavenConfiguration
backupLocation string
databaseLocation string
Résultat void

Rollback() public méthode

public Rollback ( System.Guid txId ) : void
txId System.Guid
Résultat void

SpinBackgroundWorkers() public méthode

public SpinBackgroundWorkers ( ) : void
Résultat void

StartBackup() public méthode

public StartBackup ( string backupDestinationDirectory ) : void
backupDestinationDirectory string
Résultat void

StopBackgroundWokers() public méthode

public StopBackgroundWokers ( ) : void
Résultat void