Session: How to Get Entity Change-Vector

  • The change-vector reflects the cluster-wide point in time in which a change occured, and includes the unique database ID, node identifier, and document Etag in the specific node.
  • When a document is downloaded from the server, it contains various metadata information.
    E.g. ID or current change-vector.
  • The current change-vector is stored within the session metadata and is available for each entity using the get_change_vector_for method from the advanced session operations.


def get_change_vector_for(self, entity: object) -> str: ...
Parameter Type Description
entity object Instance of an entity for which an Etag will be returned
Return Type Description
str Returns the current change-vector for an entity. Throws an exception if the entity is not tracked by the session.


employee = session.load("employees/1-A")
change_vector = session.advanced.get_change_vector_for(employee)