Changes API: How to Subscribe to Document Changes

Single document changes can be observed using ForDocument method.

Syntax

IChangesObservable<DocumentChange> ForDocument(string docId);

Example

IDisposable subscription = store
    .Changes()
    .ForDocument("employees/1")
    .Subscribe(
        change =>
        {
            switch (change.Type)
            {
                case DocumentChangeTypes.Put:
                    // do something
                    break;
                case DocumentChangeTypes.Delete:
                    // do something
                    break;
            }
        });

To observe all document changes in particular collection use ForDocumentInCollection method. This method filters documents by @collection metadata property value.

Syntax

IChangesObservable<DocumentChange> ForDocumentsInCollection(string collectionName);

IChangesObservable<DocumentChange> ForDocumentsInCollection<TEntity>();

Example

IDisposable subscription = store
    .Changes()
    .ForDocumentsInCollection<Employee>()
    .Subscribe(change => Console.WriteLine("{0} on document {1}", change.Type, change.Id));

or

string collectionName = store.Conventions.FindCollectionName(typeof(Employee));
IDisposable subscription = store
    .Changes()
    .ForDocumentsInCollection(collectionName)
    .Subscribe(change => Console.WriteLine("{0} on document {1}", change.Type, change.Id));

To observe all document changes for documents with ID that contains given prefix use ForDocumentsStartingWith method.

Syntax

IChangesObservable<DocumentChange> ForDocumentsStartingWith(string docIdPrefix);

Example

IDisposable subscription = store
    .Changes()
    .ForDocumentsStartingWith("employees/1") // employees/1, employees/10, employees/11, etc.
    .Subscribe(change => Console.WriteLine("{0} on document {1}", change.Type, change.Id));

To observe all document changes use ForAllDocuments method.

Syntax

IChangesObservable<DocumentChange> ForAllDocuments();

Example

IDisposable subscription = store
    .Changes()
    .ForAllDocuments() // employees/1, orders/1, customers/1, etc.
    .Subscribe(change => Console.WriteLine("{0} on document {1}", change.Type, change.Id));