Wiki / Hooks

Global extension hooks exported by the PostgreSQL core, with versioned C signatures, definitions and call sites.

Reading PostgreSQL 18.

Find an entry GroupAll groupsAuthentication and connections (4)EXPLAIN (5)Logging and function calls (3)Parsing and utility commands (2)Permissions and object access (5)Query execution (4)Query planning (11)Startup and shared memory (2)Statistics and estimation (3) Apply

39 entries; 34 recorded in PostgreSQL 18.

• ClientAuthentication_hook Authentication and connections

  ClientAuthentication_hook

  Hook for plugins to get control in ClientAuthentication()

  1011121314151617181920
• check_password_hook Authentication and connections

  check_password_hook

  Hook to check passwords in CreateRole() and AlterRole()

  1011121314151617181920
• ldap_password_hook Authentication and connections

  ldap_password_hook

  hook type for password manglers

  1011121314151617181920
• openssl_tls_init_hook Authentication and connections

  openssl_tls_init_hook

  Call init hook (usually to set password callback)

  1011121314151617181920
• ExplainOneQuery_hook EXPLAIN

  ExplainOneQuery_hook

  Hook for plugins to get control in ExplainOneQuery()

  1011121314151617181920
• explain_get_index_name_hook EXPLAIN

  explain_get_index_name_hook

  Hook for plugins to get control in explain_get_index_name()

  1011121314151617181920
• explain_per_node_hook EXPLAIN

  explain_per_node_hook

  Hook for EXPLAIN plugins to print extra fields on individual plan nodes

  1011121314151617181920
• explain_per_plan_hook EXPLAIN

  explain_per_plan_hook

  Hook for EXPLAIN plugins to print extra information for each plan

  1011121314151617181920
• explain_validate_options_hook EXPLAIN

  explain_validate_options_hook

  Hook to perform additional EXPLAIN options validation

  1011121314151617181920
• emit_log_hook Logging and function calls

  emit_log_hook

  Hook for intercepting messages before they are sent to the server log

  1011121314151617181920
• fmgr_hook Logging and function calls

  fmgr_hook

  function manager hook

  1011121314151617181920
• needs_fmgr_hook Logging and function calls

  needs_fmgr_hook

  Hooks for function calls

  1011121314151617181920
• ProcessUtility_hook Parsing and utility commands

  ProcessUtility_hook

  Hook for plugins to get control in ProcessUtility()

  1011121314151617181920
• post_parse_analyze_hook Parsing and utility commands

  post_parse_analyze_hook

  Hook for plugins to get control at end of parse analysis

  1011121314151617181920
• ExecutorCheckPerms_hook Permissions and object access

  ExecutorCheckPerms_hook

  Hook for plugins to get control in ExecCheckPermissions()

  1011121314151617181920
• object_access_hook Permissions and object access

  object_access_hook

  Plugin provides a hook function matching one or both of these signatures.

  1011121314151617181920
• object_access_hook_str Permissions and object access

  object_access_hook_str

  object_access_hook_str: core extension hook declared in src/include/catalog/objectaccess.h. The exact interface and call sites are recorded below.

  1011121314151617181920
• row_security_policy_hook_permissive Permissions and object access

  row_security_policy_hook_permissive

  hooks to allow extensions to add their own security policies row_security_policy_hook_permissive can be used to add policies which are combined with the other permissive policies, using OR. row_security_policy_hook_restrictive can be used to add pol…

  1011121314151617181920
• row_security_policy_hook_restrictive Permissions and object access

  row_security_policy_hook_restrictive

  row_security_policy_hook_restrictive: core extension hook declared in src/include/rewrite/rowsecurity.h. The exact interface and call sites are recorded below.

  1011121314151617181920
• ExecutorEnd_hook Query execution

  ExecutorEnd_hook

  Hook for plugins to get control in ExecutorEnd()

  1011121314151617181920
• ExecutorFinish_hook Query execution

  ExecutorFinish_hook

  Hook for plugins to get control in ExecutorFinish()

  1011121314151617181920
• ExecutorRun_hook Query execution

  ExecutorRun_hook

  Hook for plugins to get control in ExecutorRun()

  1011121314151617181920
• ExecutorStart_hook Query execution

  ExecutorStart_hook

  Hook for plugins to get control in ExecutorStart()

  1011121314151617181920
• build_simple_rel_hook Query planning not in 18

  build_simple_rel_hook

  Not recorded in the selected version.

  1011121314151617181920
• create_upper_paths_hook Query planning

  create_upper_paths_hook

  Hook for plugins to get control when grouping_planner() plans upper rels

  1011121314151617181920
• get_relation_info_hook Query planning

  get_relation_info_hook

  Hook for plugins to get control in get_relation_info()

  1011121314151617181920
• join_path_setup_hook Query planning not in 18

  join_path_setup_hook

  Not recorded in the selected version.

  1011121314151617181920
• join_search_hook Query planning

  join_search_hook

  Hook for plugins to replace standard_join_search()

  1011121314151617181920
• joinrel_setup_hook Query planning not in 18

  joinrel_setup_hook

  Not recorded in the selected version.

  1011121314151617181920
• planner_hook Query planning

  planner_hook

  Hook for plugins to get control in planner()

  1011121314151617181920
• planner_setup_hook Query planning not in 18

  planner_setup_hook

  Not recorded in the selected version.

  1011121314151617181920
• planner_shutdown_hook Query planning not in 18

  planner_shutdown_hook

  Not recorded in the selected version.

  1011121314151617181920
• set_join_pathlist_hook Query planning

  set_join_pathlist_hook

  Hook for plugins to get control in add_paths_to_joinrel()

  1011121314151617181920
• set_rel_pathlist_hook Query planning

  set_rel_pathlist_hook

  Hook for plugins to get control in set_rel_pathlist()

  1011121314151617181920
• shmem_request_hook Startup and shared memory

  shmem_request_hook

  shmem_request_hook: core extension hook declared in src/include/miscadmin.h. The exact interface and call sites are recorded below.

  1011121314151617181920
• shmem_startup_hook Startup and shared memory

  shmem_startup_hook

  Now give loadable modules a chance to set up their shmem allocations

  1011121314151617181920
• get_attavgwidth_hook Statistics and estimation

  get_attavgwidth_hook

  Hook for plugins to get control in get_attavgwidth()

  1011121314151617181920
• get_index_stats_hook Statistics and estimation

  get_index_stats_hook

  get_index_stats_hook: core extension hook declared in src/include/utils/selfuncs.h. The exact interface and call sites are recorded below.

  1011121314151617181920
• get_relation_stats_hook Statistics and estimation

  get_relation_stats_hook

  Hooks for plugins to get control when we ask for stats

  1011121314151617181920

RecordedFirst recordedInterface or attribute changeNo longer recorded

Squares indicate presence in sampled builds, not first introduction. Select a square for the same-version definition and sources.

Changes in PostgreSQL 18 · Export JSON

Reading this collection

C interfaces can change between major releases. Inspect the declaration and calling code for your target build. Per-object callbacks, GUC callbacks, frontend interfaces and extension-private APIs are outside this inventory.