increment-next-identity.js.markdown

Increment Next Identity Operation

---

{NOTE: }

• Use NextIdentityForOperation to increment the latest identity value set on the server for the specified collection in the database.

• The next document that will be created using an identity for the collection will receive the consecutive integer value.

• In this page:

  • Increment the next identity value
  • Syntax

{NOTE/}

---

{PANEL: Increment the next identity value }

{CODE:nodejs increment_identity@ClientApi\Operations\Maintenance\Identities\incrementIdentity.js /}

{PANEL/}

{PANEL: Syntax }

{CODE:nodejs syntax@ClientApi\Operations\Maintenance\Identities\incrementIdentity.js /}

Parameter	Type	Description
name	string	The collection name for which to increment the identity value. Can be with or without a pipe in the end (e.g. "companies" or "companies|".

{PANEL/}

Related Articles

Document Identifiers

• Global ID Generation Conventions
• Type-specific ID Generation Conventions

Knowledge Base

• Document Identifier Generation

Operations

• What are operations
• Get identities
• Seed identity