Get Revisions

• Using the Advanced Session methods you can retrieve revisions and their metadata
  from the database for the specified document.

• These methods can also be executed lazily, see get revisions lazily.

• In this page:

  • Get all revisions
  • Get revisions metadata
  • Get revisions by creation time
  • Get revisions by change vector

Get all revisions

• Use GetFor to retrieve all of the revisions currently kept for the specified document. Example:

• Sync
• Async

// Get revisions for document 'orders/1-A'
// Revisions will be ordered by most recent revision first
List<Order> orderRevisions = session
  .Advanced
  .Revisions
  .GetFor<Order>(id: "orders/1-A", start: 0, pageSize: 10);

// Get revisions for document 'orders/1-A'
// Revisions will be ordered by most recent revision first
List<Order> orderRevisions = await asyncSession
  .Advanced
  .Revisions
  .GetForAsync<Order>(id: "orders/1-A", start: 0, pageSize: 10);

Syntax:

List<T> GetFor<T>(string id, int start = 0, int pageSize = 25);

Parameters	Type	Description
id	string	Document ID for which to retrieve revisions
start	int	First revision to retrieve, used for paging
pageSize	int	Number of revisions to retrieve per results page

Get revisions metadata

• Use GetMetadataFor to retrieve the metadata for all the revisions currently kept for the specified document. Example:

• Sync
• Async

// Get revisions' metadata for document 'orders/1-A'
List<MetadataAsDictionary> orderRevisionsMetadata = session
  .Advanced
  .Revisions
  .GetMetadataFor(id: "orders/1-A", start: 0, pageSize: 10);

// Each item returned is a revision's metadata, as can be verified in the @flags key
var metadata = orderRevisionsMetadata[0];
var flagsValue = metadata.GetString(Constants.Documents.Metadata.Flags);

Assert.Contains("Revision", flagsValue);

// Get revisions' metadata for document 'orders/1-A'
List<MetadataAsDictionary> orderRevisionsMetadata = await asyncSession
  .Advanced
  .Revisions
  .GetMetadataForAsync(id: "orders/1-A", start: 0, pageSize: 10);

// Each item returned is a revision's metadata, as can be verified in the @flags key
var metadata = orderRevisionsMetadata[0];
var flagsValue = metadata.GetString(Constants.Documents.Metadata.Flags);

Assert.Contains("Revision", flagsValue);

Syntax:

List<MetadataAsDictionary> GetMetadataFor(string id, int start = 0, int pageSize = 25);

Parameters	Type	Description
id	string	Document ID for which to retrieve revisions' metadata
start	int	First revision to retrieve metadata for, used for paging
pageSize	int	Number of revisions to retrieve per results page

Get revisions by creation time

• Use Get to retrieve a revision by its creation time. Example:

• Sync
• Async

// Get a revision by its creation time
Order revisionFromLastYear = session
  .Advanced
  .Revisions
   // If no revision was created at the specified time,
   // then the first revision that precedes it will be returned
  .Get<Order>("orders/1-A", DateTime.Now.AddYears(-1));

// Get a revision by its creation time
Order revisionFromLastYear = await asyncSession
  .Advanced
  .Revisions
  // If no revision was created at the specified time,
  // then the first revision that precedes it will be returned
  .GetAsync<Order>("orders/1-A", DateTime.Now.AddYears(-1));

Syntax:

T Get<T>(string id, DateTime date);

Parameter	Type	Description
id	string	Document ID for which to retrieve the revision by creation time
date	DateTime	The revision's creation time

Get revisions by change vector

• Use Get to retrieve a revision or multiple revisions by their change vectors.
  Example:

• Sync
• Async

// Get revisions metadata 
List<MetadataAsDictionary> revisionsMetadata = session
  .Advanced
  .Revisions
  .GetMetadataFor("orders/1-A", start: 0, pageSize: 25);

// Get the change-vector from the metadata
var changeVector = revisionsMetadata[0].GetString(Constants.Documents.Metadata.ChangeVector);

// Get the revision by its change-vector
Order revision = session
  .Advanced
  .Revisions
  .Get<Order>(changeVector);

// Get revisions metadata 
List<MetadataAsDictionary> revisionsMetadata = await asyncSession
  .Advanced
  .Revisions
  .GetMetadataForAsync("orders/1-A", start: 0, pageSize: 25);

// Get the change-vector from the metadata
var changeVector = revisionsMetadata[0].GetString(Constants.Documents.Metadata.ChangeVector);

// Get the revision by its change-vector
Order revision = await asyncSession
  .Advanced
  .Revisions
  .GetAsync<Order>(changeVector);

Syntax:

// Get a revision by its change vector
T Get<T>(string changeVector);

// Get multiple revisions by their change vectors
Dictionary<string, T> Get<T>(IEnumerable<string> changeVectors);

Parameter	Type	Description
changeVector	string	The revision's change vector
changeVectors	IEnumerable<string>	Change vectors of multiple revisions