PG_AUTOCTL ACTIVATE(1)

📦
version 2.2 · 5 versions
, in debian trixie, ubuntu questing

💖 PG_AUTOCTL ACTIVATE 💖

okay bestie, welcome to the pg_autoctl activate page — it lives in the pg_auto_failover manual, section 1, and it's literally the glow-up button for Citus worker nodes. ✨

🌸 NAME 🌸

pg_autoctl activate — pg_autoctl activate

pg_autoctl activate — Activate a Citus worker from the Citus coordinator

🦋 SYNOPSIS 🦋

This command calls the Citus "activation" API so that a node can be used to host shards for your reference and distributed tables. no cap, that's the whole job. 💅

usage: pg_autoctl activate  [ --pgdata ]

  --pgdata      path to data directory

✨ DESCRIPTION ✨

so here's the tea 🍓 — when you're creating a Citus worker, pg_autoctl create worker automatically activates the worker node to the coordinator. you don't have to do anything, it just does it. iconic behaviour honestly.

You only need this command when something unexpected have happened and you want to manually make sure the worker node has been activated at the Citus coordinator level. like, when the vibes are off and you need to double-check yourself. 🫶

Starting with Citus 10 it is also possible to activate the coordinator itself as a node with shard placement. so if you wanna give your coordinator main character energy, just use pg_autoctl activate on your Citus coordinator node manually to use that feature. 👑

lowkey important though: when the Citus coordinator is activated, an extra step is then needed for it to host shards of distributed tables. If you want your coordinator to have shards, then have a look at the Citus API ‐ citus_set_node_property to set the shouldhaveshards property to true. don't skip this step bestie, it's giving required. 😭

🎀 OPTIONS 🎀

  • --pgdata — Location of the Postgres node being managed locally. Defaults to the environment variable PGDATA. Use --monitor to connect to a monitor from anywhere, rather than the monitor URI used by a local Postgres node managed with pg_autoctl.

💜 AUTHOR 💜

Microsoft

Copyright (c) Microsoft Corporation. All rights reserved.

okay that's the whole page, you ate it 💅🦋 this was pg_autoctl activate from the pg_auto_failover manual, version 2.2, dated Apr 07, 2025. go activate something, bestie. 🎀✨

📦 where this page comes from