savepoint.rollbackDesc()

DOCS • API • Savepoint API

---

Get the Savepoint's rollback description. This returns the description originally passed along with last rollback operation (savepoint.rollback()).

See related ➞ savepoint.commitDesc()

Syntax

savepoint.rollbackDesc(): string;

Usage

// Rollback savepoint
const savepoint = await client.database('database_1').savepoint();
await savepoint.rollback({
    desc: 'Changes no more necessary'
});

// Why was savepoint rolled back?
const savepoint = await client.database('database_1').savepoint({ lookAhead: true });
console.log(savepoint.rollbackDesc()); // 'Changes no more necessary'