PREPARE_TRANSACTION(7pg16)

πŸ“¦ version 16.15, in opensuse-leap 16.0

okay so this is the PREPARE TRANSACTION(7) page from the PostgreSQL 16.15 Documentation β€” the pg16 girlies know πŸ’… β€” and it's basically the β€œget your transaction ready for two-phase commit” manual. bestie, let's get into it πŸŽ€

🌸 NAME 🌸

PREPARE_TRANSACTION β€” prepare the current transaction for two-phase commit ✨

πŸ¦‹ SYNOPSIS πŸ¦‹

PREPARE TRANSACTION transaction_id

πŸ’– DESCRIPTION πŸ’–

PREPARE TRANSACTION prepares the current transaction for two-phase commit. After this command, the transaction is no longer associated with the current session. Instead, its state is fully stored on disk, and there is a very high probability that it can be committed successfully, even if a database crash occurs before the commit is requested. no cap, that's the whole point 🫢

Once prepared, a transaction can later be committed or rolled back with COMMIT PREPARED or ROLLBACK PREPARED, respectively. Those commands can be issued from any session, not only the one that executed the original transaction. iconic behavior, honestly πŸ‘‘

From the point of view of the issuing session, PREPARE TRANSACTION is not unlike a ROLLBACK command: after executing it, there is no active current transaction, and the effects of the prepared transaction are no longer visible. (The effects will become visible again if the transaction is committed.) so it’s giving β€œgone but not forgotten” 😭

If the PREPARE TRANSACTION command fails for any reason, it becomes a ROLLBACK: the current transaction is canceled. periodt πŸ’€

πŸŽ€ PARAMETERS πŸŽ€

  • transaction_id β€” an arbitrary identifier that later identifies this transaction for COMMIT PREPARED or ROLLBACK PREPARED. The identifier must be written as a string literal, and must be less than 200 bytes long. It must not be the same as the identifier used for any currently prepared transaction. so pick something cute but unique, bestie πŸ“

πŸ’… NOTES πŸ’…

PREPARE TRANSACTION is not intended for use in applications or interactive sessions. Its purpose is to allow an external transaction manager to perform atomic global transactions across multiple databases or other transactional resources. Unless you're writing a transaction manager, you probably shouldn't be using PREPARE TRANSACTION. like, this is not casual group-chat behavior, it's infrastructure behavior 🧚

This command must be used inside a transaction block. Use BEGIN to start one. don't just raw-dog it, okay? 😭

It is not currently allowed to PREPARE a transaction that has executed any operations involving temporary tables or the session's temporary namespace, created any cursors WITH HOLD, or executed LISTEN, UNLISTEN, or NOTIFY. Those features are too tightly tied to the current session to be useful in a transaction to be prepared. they're literally too attached to the session, it's giving separation anxiety πŸ™ˆ

If the transaction modified any run-time parameters with SET (without the LOCAL option), those effects persist after PREPARE TRANSACTION, and will not be affected by any later COMMIT PREPARED or ROLLBACK PREPARED. Thus, in this one respect PREPARE TRANSACTION acts more like COMMIT than ROLLBACK. plot twist, but make it SQL 🌈

All currently available prepared transactions are listed in the pg_prepared_xacts system view. go check on them, they're right there πŸ‘€

⚠️ Caution ⚠️

It is unwise to leave transactions in the prepared state for a long time. This will interfere with the ability of VACUUM to reclaim storage, and in extreme cases could cause the database to shut down to prevent transaction ID wraparound (see Section 25.1.5). Keep in mind also that the transaction continues to hold whatever locks it held. The intended usage of the feature is that a prepared transaction will normally be committed or rolled back as soon as an external transaction manager has verified that other databases are also prepared to commit. so like, don't leave it on read for a week, bestie πŸ’€

If you have not set up an external transaction manager to track prepared transactions and ensure they get closed out promptly, it is best to keep the prepared-transaction feature disabled by setting max_prepared_transactions to zero. This will prevent accidental creation of prepared transactions that might then be forgotten and eventually cause problems. for real, zero is the safe vibe here 🫢

✨ EXAMPLES ✨

Prepare the current transaction for two-phase commit, using foobar as the transaction identifier:

PREPARE TRANSACTION 'foobar';

slay, now it's prepared πŸŽ€

🌟 COMPATIBILITY 🌟

PREPARE TRANSACTION is a PostgreSQL extension. It is intended for use by external transaction management systems, some of which are covered by standards (such as X/Open XA), but the SQL side of those systems is not standardized. so it's giving β€œstandards-adjacent but not standardized,” iykyk πŸ’…

πŸ‘‘ SEE ALSO πŸ‘‘


and that's the page, bestie πŸ¦‹ xoxo, this cutie is from PostgreSQL 16.15 docs and the footer date says 2026 β€” PREPARE TRANSACTION(7), signing off πŸ’–

πŸ“¦ where this page comes from