PG_AUTOCTL_ACTIVATE(1)

📦
version 2.1 · 2 versions
, in fedora 43, fedora 44

💖 NAME 💖

pg_autoctl activate — bestie, this is literally just pg_autoctl activate

pg_autoctl activate — wakes up a Citus worker from the Citus coordinator side of things 👑

This one lives in the pg_auto_failover family, and you're reading the PG_AUTOCTL ACTIVATE(1) page. Hiiii, welcome, let's get you activated ✨

🌸 SYNOPSIS 🌸

So basically this command hits the Citus "activation" API so that a node is allowed to host shards for your reference tables and your distributed tables. That's the whole vibe. 🦋

usage: pg_autoctl activate  [ --pgdata ]

  --pgdata      path to data directory

✨ DESCRIPTION ✨

Okay so real talk: when you're creating a Citus worker, pg_autoctl create worker already activates that worker node with the coordinator for you. Automatic. No effort. Iconic behaviour fr fr. 💅

You only need to run this command when something unexpected has happened 😭 and you want to manually make sure the worker node has been activated at the Citus coordinator level. Like a little "hey bestie, are you sure?" check-in.

Starting with Citus 10 it's also possible to activate the coordinator itself as a node with shard placement. Wild, I know. To use that feature you just run pg_autoctl activate on your Citus coordinator node manually. Main character energy from the coordinator, honestly. 👑

Heads up though: when the Citus coordinator is activated, there's an extra step needed before it can actually host shards of distributed tables. If you want your coordinator to have shards, go peek at the Citus API ‐ citus_set_node_property and set the shouldhaveshards property to true. Don't skip this one, bestie, or you'll be sitting there like 🧍‍♀️ wondering why nothing's landing.

🎀 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.

That's it, that's the list. Short and slay. 🫶

🌈 AUTHOR 🌈

Microsoft

Copyright (c) Microsoft Corporation. All rights reserved.

and that's the whole page, babe! This was pg_auto_failover version 2.1, dated Jan 18, 2025 — go forth and activate, you've got this 💖✨🦋🌸🎀

📦 where this page comes from