Help Center/ GaussDB/ Developer Guide(Centralized_V2.0-8.x)/ SQL Reference/ SQL Syntax/ R/ ROLLBACK PREPARED
Updated on 2025-08-19 GMT+08:00
View PDF

ROLLBACK PREPARED

Description

Cancels a transaction ready for two-phase commit.

Precautions

  • The function is only available in maintenance mode (when the GUC parameter xc_maintenance_mode is set to on). Exercise caution when enabling the mode. It is used by maintenance engineers for troubleshooting. Common users should not use the mode.
  • Only the user who initiates a transaction or a system administrator can roll back the transaction.
  • The transaction function is maintained automatically by the database, and should be not visible to users.

Syntax

ROLLBACK PREPARED transaction_id ;

Parameters

transaction_id

Specifies the identifier of the transaction to be committed. The identifier must be different from those for current prepared transactions.

Examples

-- Start.
gaussdb=# BEGIN;
BEGIN

-- Prepare a transaction whose identifier is trans_test.
gaussdb=# PREPARE TRANSACTION 'trans_test';
PREPARE TRANSACTION

-- Cancel the transaction whose identifier is trans_test.
gaussdb=# ROLLBACK PREPARED 'trans_test';
ROLLBACK PREPARED

Helpful Links

COMMIT PREPARED and PREPARE TRANSACTION.

Parent topic: R