Skip to Navigation
Get Identities Operation
-
Upon document creation, providing a collection name with a pipe symbol (
|)
will cause the server to generate an ID for the new document called an identity. -
The identity document ID is unique across the entire cluster within the database scope.
It is composed of the collection name provided and an integer value that is continuously incremented. -
Identity values can also be managed from the Studio identities view.
-
Use
GetIdentitiesOperationto get the dictionary that maps collection names to their corresponding latest identity values. -
Learn more about identities in:
-
In this page:
Get identities operation
// Create a document with an identity ID:
// ======================================
using (var session = store.OpenSession())
{
// Request the server to generate an identity ID for the new document. Pass:
// * The entity to store
// * The collection name with a pipe (|) postfix
session.Store(new Company { Name = "RavenDB" }, "companies|");
// If this is the first identity created for this collection,
// and if the identity value was not customized
// then a document with an identity ID "companies/1" will be created
session.SaveChanges();
}
// Get identities information:
// ===========================
// Define the get identities operation
var getIdentitiesOp = new GetIdentitiesOperation();
// Execute the operation by passing it to Maintenance.Send
Dictionary<string, long> identities = store.Maintenance.Send(getIdentitiesOp);
// Results
var latestIdentityValue = identities["companies|"]; // => value will be 1// Create a document with an identity ID:
// ======================================
using (var asyncSession = store.OpenAsyncSession())
{
// Request the server to generate an identity ID for the new document. Pass:
// * The entity to store
// * The collection name with a pipe (|) postfix
asyncSession.StoreAsync(new Company { Name = "RavenDB" }, "companies|");
// If this is the first identity created for this collection,
// and if the identity value was not customized
// then a document with an identity ID "companies/1" will be created
asyncSession.SaveChangesAsync();
}
// Get identities information:
// ===========================
// Define the get identities operation
var getIdentitiesOp = new GetIdentitiesOperation();
// Execute the operation by passing it to Maintenance.SendAsync
Dictionary<string, long> identities = await store.Maintenance.SendAsync(getIdentitiesOp);
// Results
var latestIdentityValue = identities["companies|"]; // => value will be 1
Syntax
public GetIdentitiesOperation();
Related Articles