PGD Reference ============= The reference section is a definitive listing of all functions, views and commands available in EDB Postgres Distributed. :ref:`User visible catalogs and views ` ------------- - :ref:`bdr.camo_decision_journal ` - :ref:`bdr.commit_scopes ` - :ref:`bdr.conflict_history ` - :ref:`bdr.conflict_history_summary ` - :ref:`bdr.consensus_kv_data ` - :ref:`bdr.crdt_handlers ` - :ref:`bdr.ddl_replication ` - :ref:`bdr.depend ` - :ref:`bdr.global_consensus_journal ` - :ref:`bdr.global_consensus_journal_details ` - :ref:`bdr.global_consensus_response_journal ` - :ref:`bdr.global_lock ` - :ref:`bdr.global_locks ` - :ref:`bdr.group_camo_details ` - :ref:`bdr.group_raft_details ` - :ref:`bdr.group_replslots_details ` - :ref:`bdr.group_subscription_summary ` - :ref:`bdr.group_versions_details ` - :ref:`bdr.local_consensus_snapshot ` - :ref:`bdr.local_consensus_state ` - :ref:`bdr.local_node ` - :ref:`bdr.local_node_summary ` - :ref:`bdr.local_sync_status ` - :ref:`bdr.node_config ` - :ref:`bdr.node_catchup_info ` - :ref:`bdr.node_catchup_info_details ` - :ref:`bdr.node_conflict_resolvers ` - :ref:`bdr.node_group_config ` - :ref:`bdr.node_group_replication_sets ` - :ref:`bdr.node_group_summary ` - :ref:`bdr.node_local_info ` - :ref:`bdr.node_log_config ` - :ref:`bdr.node_peer_progress ` - :ref:`bdr.node_replication_rates ` - :ref:`bdr.node_slots ` - :ref:`bdr.node_summary ` - :ref:`bdr.queue ` - :ref:`bdr.replication_set ` - :ref:`bdr.replication_set_table ` - :ref:`bdr.replication_set_ddl ` - :ref:`bdr.replication_sets ` - :ref:`bdr.schema_changes ` - :ref:`bdr.sequence_alloc ` - :ref:`bdr.sequences ` - :ref:`bdr.stat_activity ` - :ref:`bdr.stat_relation ` - :ref:`bdr.stat_subscription ` - :ref:`bdr.subscription ` - :ref:`bdr.subscription_summary ` - :ref:`bdr.tables ` - :ref:`bdr.taskmgr_work_queue ` - :ref:`bdr.taskmgr_workitem_status ` - :ref:`bdr.taskmgr_local_work_queue ` - :ref:`bdr.taskmgr_local_workitem_status ` - :ref:`bdr.trigger ` - :ref:`bdr.triggers ` - :ref:`bdr.workers ` - :ref:`bdr.writers ` - :ref:`bdr.worker_tasks ` :ref:`System functions ` -------------- :ref:`Version information functions ` ^^^^^^^^^^^^^^ - :ref:`bdr.bdr_version ` - :ref:`bdr.bdr_version_num ` :ref:`System information functions ` ^^^^^^^^^^^^^^ - :ref:`bdr.get_relation_stats ` - :ref:`bdr.get_subscription_stats ` :ref:`System and progress information parameters ` ^^^^^^^^^^^^^^ - :ref:`bdr.local_node_id ` - :ref:`bdr.last_committed_lsn ` - :ref:`transaction_id ` - :ref:`bdr.is_node_connected ` - :ref:`bdr.is_node_ready ` :ref:`Consensus function ` ^^^^^^^^^^^^^^ - :ref:`bdr.consensus_disable ` - :ref:`bdr.consensus_enable ` - :ref:`bdr.consensus_proto_version ` - :ref:`bdr.consensus_snapshot_export ` - :ref:`bdr.consensus_snapshot_import ` - :ref:`bdr.consensus_snapshot_verify ` - :ref:`bdr.get_consensus_status ` - :ref:`bdr.get_raft_status ` - :ref:`bdr.raft_leadership_transfer ` :ref:`Utility functions ` ^^^^^^^^^^^^^^ - :ref:`bdr.wait_slot_confirm_lsn ` - :ref:`bdr.wait_for_apply_queue ` - :ref:`bdr.get_node_sub_receive_lsn ` - :ref:`bdr.get_node_sub_apply_lsn ` - :ref:`bdr.replicate_ddl_command ` - :ref:`bdr.run_on_all_nodes ` - :ref:`bdr.run_on_nodes ` - :ref:`bdr.run_on_group ` - :ref:`bdr.global_lock_table ` - :ref:`bdr.wait_for_xid_progress ` - :ref:`bdr.local_group_slot_name ` - :ref:`bdr.node_group_type ` - :ref:`bdr.alter_node_kind ` - :ref:`bdr.alter_subscription_skip_changes_upto ` :ref:`Global advisory locks ` ^^^^^^^^^^^^^^ - :ref:`bdr.global_advisory_lock ` - :ref:`bdr.global_advisory_unlock ` :ref:`Monitoring functions ` ^^^^^^^^^^^^^^^ - :ref:`bdr.monitor_group_versions ` - :ref:`bdr.monitor_group_raft ` - :ref:`bdr.monitor_local_replslots ` - :ref:`bdr.wal_sender_stats ` - :ref:`bdr.get_decoding_worker_stat ` - :ref:`bdr.lag_control ` :ref:`CAMO functions ` ^^^^^^^^^^^^^^^ - :ref:`bdr.is_camo_partner_connected ` - :ref:`bdr.is_camo_partner_ready ` - :ref:`bdr.get_configured_camo_partner ` - :ref:`bdr.wait_for_camo_partner_queue ` - :ref:`bdr.camo_transactions_resolved ` - :ref:`bdr.logical_transaction_status ` :ref:`Commit Scope functions ` ^^^^^^^^^^^^^^^ - :ref:`bdr.add_commit_scope ` - :ref:`bdr.alter_commit_scope ` - :ref:`bdr.remove_commit_scope ` :ref:`PGD settings ` --------------- :ref:`Exploring conflict handling with PGD ` ^^^^^^^^^^^^^^^ - :ref:`bdr.default_conflict_detection ` :ref:`Global sequence parameters ` ^^^^^^^^^^^^^^^ - :ref:`bdr.default_sequence_kind ` :ref:`DDL handling ` ^^^^^^^^^^^^^^^ - :ref:`bdr.default_replica_identity ` - :ref:`bdr.ddl_replication ` - :ref:`bdr.role_replication ` - :ref:`bdr.ddl_locking ` - :ref:``bdr.truncate_locking` <`bdr.truncate_locking`>` :ref:`Global locking ` ^^^^^^^^^^^^^^^ - :ref:`bdr.global_lock_max_locks ` - :ref:`bdr.global_lock_timeout ` - :ref:`bdr.global_lock_statement_timeout ` - :ref:``bdr.global_lock_idle_timeout` <`bdr.global_lock_idle_timeout`>` - :ref:``bdr.predictive_checks` <`bdr.predictive_checks`>` :ref:`Node management ` ^^^^^^^^^^^^^^^ - :ref:`bdr.replay_progress_frequency ` - :ref:`bdr.standby_slot_names ` - :ref:`Generic replication ` - :ref:`bdr.writers_per_subscription ` - :ref:`bdr.max_writers_per_subscription ` - :ref:``bdr.xact_replication` <`bdr.xact_replication`>` - :ref:`bdr.permit_unsafe_commands ` - :ref:`bdr.batch_inserts ` - :ref:`bdr.maximum_clock_skew ` - :ref:`bdr.maximum_clock_skew_action ` - :ref:``bdr.accept_connections` <`bdr.accept_connections`>` - :ref:`bdr.standby_slot_names ` - :ref:`bdr.standby_slots_min_confirmed ` - :ref:`bdr.writer_input_queue_size ` - :ref:`bdr.writer_output_queue_size ` - :ref:`bdr.min_worker_backoff_delay ` :ref:`CRDTs ` ^^^^^^^^^^^^^^^ - :ref:``bdr.crdt_raw_value` <`bdr.crdt_raw_value`>` :ref:`Commit scopes ` ^^^^^^^^^^^^^^^ - :ref:`bdr.commit_scopes ` :ref:`Commit At Most Once ` ^^^^^^^^^^^^^^^ - :ref:`bdr.camo_local_mode_delay ` - :ref:``bdr.camo_enable_client_warnings` <`bdr.camo_enable_client_warnings`>` :ref:`Transaction streaming ` ^^^^^^^^^^^^^^^ - :ref:`bdr.default_streaming_mode ` :ref:`Lag Control ` ^^^^^^^^^^^^^^^ - :ref:`bdr.lag_control_max_commit_delay ` - :ref:``bdr.lag_control_max_lag_size` <`bdr.lag_control_max_lag_size`>` - :ref:`bdr.lag_control_max_lag_time ` - :ref:`bdr.lag_control_min_conforming_nodes ` - :ref:`bdr.lag_control_commit_delay_adjust ` - :ref:`bdr.lag_control_sample_interval ` - :ref:`bdr.lag_control_commit_delay_start ` :ref:`Timestamp-based snapshots ` ^^^^^^^^^^^^^^^ - :ref:`bdr.timestamp_snapshot_keep ` :ref:`Monitoring and logging ` ^^^^^^^^^^^^^^^ - :ref:`bdr.debug_level ` - :ref:``bdr.trace_level` <`bdr.trace_level`>` - :ref:`bdr.track_subscription_apply ` - :ref:`bdr.track_relation_apply ` - :ref:`bdr.track_apply_lock_timing ` :ref:`Decoding Worker ` ^^^^^^^^^^^^^^^ - :ref:`bdr.enable_wal_decoder ` - :ref:`bdr.receive_lcr ` - :ref:`bdr.lcr_cleanup_interval ` :ref:`Connectivity settings ` ^^^^^^^^^^^^^^^ - :ref:`bdr.global_connection_timeout ` - :ref:`bdr.global_keepalives ` - :ref:`bdr.global_keepalives_idle ` - :ref:`bdr.global_keepalives_interval ` - :ref:`bdr.global_keepalives_count ` - :ref:`bdr.global_tcp_user_timeout ` :ref:`Internal settings - Raft timeouts bdr.raft_global_election_timeout ` ^^^^^^^^^^^^^^^ - :ref:`Internal settings - Raft timeouts bdr.raft_global_election_timeout ` - :ref:`bdr.raft_local_election_timeout ` - :ref:`bdr.raft_response_timeout ` :ref:`Internal settings - Other Raft values ` ^^^^^^^^^^^^^^^ - :ref:`bdr.raft_keep_min_entries ` - :ref:`bdr.raft_log_min_apply_duration ` - :ref:`bdr.raft_log_min_message_duration ` - :ref:`bdr.raft_group_max_connections ` :ref:`Internal settings - Other values ` ^^^^^^^^^^^^^^^ - :ref:`bdr.backwards_compatibility ` - :ref:`bdr.track_replication_estimates ` - :ref:`bdr.lag_tracker_apply_rate_weight ` :ref:`Node management ` --------------- - :ref:`List of node states ` - :ref:`Node-management commands ` - :ref:`bdr_init_physical ` :ref:`Node management interfaces ` --------------- - :ref:`bdr.alter_node_group_config ` - :ref:`bdr.alter_node_group_option ` - :ref:`bdr.alter_node_interface ` - :ref:`bdr.alter_node_option ` - :ref:`bdr.alter_subscription_enable ` - :ref:`bdr.alter_subscription_disable ` - :ref:`bdr.create_node ` - :ref:`bdr.create_node_group ` - :ref:`bdr.join_node_group ` - :ref:`bdr.part_node ` - :ref:`bdr.promote_node ` - :ref:`bdr.switch_node_group ` - :ref:`bdr.wait_for_join_completion ` :ref:`Routing functions ` --------------- - :ref:`bdr.create_proxy ` - :ref:`bdr.alter_proxy_option ` - :ref:`bdr.drop_proxy ` - :ref:`bdr.routing_leadership_transfer ` :ref:`Commit scopes ` --------------- - :ref:`Commit scope syntax ` - :ref:`Commit scope groups ` - :ref:`ANY ` - :ref:`ANY NOT ` - :ref:`MAJORITY ` - :ref:`MAJORITY NOT ` - :ref:`Installing xpanes ` - :ref:`ALL NOT ` - :ref:`Confirmation level ` - :ref:`ON received ` - :ref:`ON replicated ` - :ref:`ON durable ` - :ref:`ON visible ` - :ref:`Commit Scope kinds ` - :ref:`Group commit ` - :ref:`GROUP COMMIT parameters ` - :ref:`ABORT ON parameters ` - :ref:`transaction_tracking settings ` - :ref:`conflict_resolution settings ` - :ref:`commit_decision settings ` - :ref:`CAMO or commit-at-most-once ` - :ref:`Degrade On parameters ` - :ref:`Lag Control ` - :ref:`LAG CONTROL parameters ` - :ref:`SYNCHRONOUS_COMMIT ` :ref:`Replication set management ` --------------- - :ref:`bdr.create_replication_set ` - :ref:`bdr.alter_replication_set ` - :ref:`bdr.drop_replication_set ` - :ref:`bdr.alter_node_replication_sets ` :ref:`Replication set membership ` --------------- - :ref:`bdr.replication_set_add_table ` - :ref:`bdr.replication_set_remove_table ` :ref:`DDL replication filtering ` --------------- - :ref:`bdr.replication_set_add_ddl_filter ` - :ref:`bdr.replication_set_remove_ddl_filter ` :ref:`Testing and tuning commands ` --------------- - :ref:`pgd_bench ` :ref:`Global sequence management interfaces ` --------------- :ref:`Sequence functions ` ^^^^^^^^^^^^^^^ - :ref:`bdr.alter_sequence_set_kind ` - :ref:`bdr.extract_timestamp_from_snowflakeid ` - :ref:`bdr.extract_nodeid_from_snowflakeid ` - :ref:`bdr.extract_localseqid_from_snowflakeid ` - :ref:`bdr.timestamp_to_snowflakeid ` - :ref:`bdr.extract_timestamp_from_timeshard ` - :ref:`bdr.extract_nodeid_from_timeshard ` - :ref:`bdr.extract_localseqid_from_timeshard ` - :ref:`bdr.timestamp_to_timeshard ` :ref:`KSUUID v2 Functions ` ^^^^^^^^^^^^^^^ - :ref:`bdr.gen_ksuuid_v2 ` - :ref:`bdr.ksuuid_v2_cmp ` - :ref:`bdr.extract_timestamp_from_ksuuid_v2 ` :ref:`KSUUID v1 functions ` ^^^^^^^^^^^^^^^ - :ref:`bdr.gen_ksuuid_v2 ` - :ref:`bdr.uuid_v1_cmp ` - :ref:`bdr.extract_timestamp_from_ksuuid_v2 ` :ref:`Autopartition ` --------------- - :ref:`bdr.autopartition ` - :ref:`bdr.drop_autopartition ` - :ref:`bdr.autopartition_wait_for_partitions ` - :ref:`bdr.autopartition_wait_for_partitions_on_all_nodes ` - :ref:`bdr.autopartition_find_partition ` - :ref:`bdr.autopartition_enable ` - :ref:``bdr.autopartition_disable` <`bdr.autopartition_disable`>` - :ref:`Internal functions ` - :ref:`bdr.autopartition_create_partition ` - :ref:`bdr.autopartition_drop_partition ` Stream Triggers Reference ------------------------- :ref:`Stream triggers manipulation interfaces ` --------------- - :ref:`bdr.create_conflict_trigger ` - :ref:`bdr.create_transform_trigger ` - :ref:`bdr.drop_trigger ` :ref:`Stream triggers row functions ` --------------- - :ref:`bdr.trigger_get_row ` - :ref:`bdr.trigger_get_committs ` - :ref:`bdr.trigger_get_xid ` - :ref:`bdr.trigger_get_type ` - :ref:`bdr.trigger_get_conflict_type ` - :ref:`bdr.trigger_get_origin_node_id ` - :ref:`bdr.ri_fkey_on_del_trigger ` :ref:`Stream triggers row variables ` --------------- - :ref:`TG_NAME ` - :ref:`TG_WHEN ` - :ref:`TG_LEVEL ` - :ref:`TG_OP ` - :ref:`TG_RELID ` - :ref:`TG_TABLE_NAME ` - :ref:`TG_TABLE_SCHEMA ` - :ref:`TG_NARGS ` - :ref:`TG_ARGV[] ` :ref:`Internal catalogs and views ` --------------- - :ref:`bdr.ddl_epoch ` - :ref:`bdr.event_history ` - :ref:`bdr.event_summary ` - :ref:`bdr.node_config ` - :ref:`bdr.node_group_config ` - :ref:`bdr.node_group_routing_config_summary ` - :ref:`bdr.node_group_routing_info ` - :ref:`bdr.node_group_routing_summary ` - :ref:`bdr.node_routing_config_summary ` - :ref:`bdr.proxy_config ` - :ref:`bdr.proxy_config_summary ` - :ref:`bdr.sequence_kind ` :ref:`Internal system functions ` --------------- :ref:`General internal functions ` ^^^^^^^^^^^^^^^ - :ref:`bdr.bdr_get_commit_decisions ` - :ref:`bdr.bdr_track_commit_decision ` - :ref:`bdr.consensus_kv_fetch ` - :ref:`bdr.consensus_kv_store ` - :ref:`bdr.decode_message_payload ` - :ref:`bdr.decode_message_response_payload ` - :ref:`bdr.difference_fix_origin_create ` - :ref:`bdr.difference_fix_session_reset ` - :ref:`bdr.difference_fix_session_setup ` - :ref:`bdr.difference_fix_xact_set_avoid_conflict ` - :ref:`bdr.drop_node ` - :ref:`bdr.get_global_locks ` - :ref:`bdr.get_node_conflict_resolvers ` - :ref:`bdr.get_slot_flush_timestamp ` - :ref:`bdr.internal_alter_sequence_set_kind ` - :ref:`bdr.internal_replication_set_add_table ` - :ref:`bdr.internal_replication_set_remove_table ` - :ref:`bdr.internal_submit_join_request ` - :ref:`bdr.isolation_test_session_is_blocked ` - :ref:`bdr.local_node_info ` - :ref:`bdr.msgb_connect ` - :ref:`bdr.msgb_deliver_message ` - :ref:`bdr.node_catchup_state_name ` - :ref:`bdr.node_kind_name ` - :ref:`bdr.peer_state_name ` - :ref:`bdr.pg_xact_origin ` - :ref:`bdr.request_replay_progress_update ` - :ref:`bdr.reset_relation_stats ` - :ref:`bdr.reset_subscription_stats ` - :ref:`bdr.resynchronize_table_from_node ` - :ref:`bdr.seq_nextval ` - :ref:`bdr.show_subscription_status ` - :ref:`bdr.show_workers ` - :ref:`bdr.show_writers ` :ref:`Task Manager Functions ` ^^^^^^^^^^^^^^^ - :ref:`bdr.taskmgr_set_leader ` - :ref:`bdr.taskmgr_get_last_completed_workitem ` - :ref:`bdr.taskmgr_work_queue_check_status ` .. toctree:: :maxdepth: 3 Reference--reference--catalogs-visible Reference--reference--functions Reference--reference--pgd-settings Reference--reference--nodes Reference--reference--nodes-management-interfaces Reference--reference--routing Reference--reference--commit-scopes Reference--reference--repsets-management Reference--reference--repsets-membership Reference--reference--repsets-ddl-filtering Reference--reference--testingandtuning Reference--reference--sequences Reference--reference--autopartition Reference--reference--streamtriggers--index Reference--reference--catalogs-internal Reference--reference--functions-internal