Wiki / Hooks

Definitions for PostgreSQL 18

• ClientAuthentication_hookAuthentication and connections10 – 20

  Hook for plugins to get control in ClientAuthentication()

  1011121314151617181920
• ExecutorCheckPerms_hookPermissions and object access10 – 20

  Hook for plugins to get control in ExecCheckPermissions()

  1011121314151617181920
• ExecutorEnd_hookQuery execution10 – 20

  Hook for plugins to get control in ExecutorEnd()

  1011121314151617181920
• ExecutorFinish_hookQuery execution10 – 20

  Hook for plugins to get control in ExecutorFinish()

  1011121314151617181920
• ExecutorRun_hookQuery execution10 – 20

  Hook for plugins to get control in ExecutorRun()

  1011121314151617181920
• ExecutorStart_hookQuery execution10 – 20

  Hook for plugins to get control in ExecutorStart()

  1011121314151617181920
• ExplainOneQuery_hookEXPLAIN10 – 20

  Hook for plugins to get control in ExplainOneQuery()

  1011121314151617181920
• ProcessUtility_hookParsing and utility commands10 – 20

  Hook for plugins to get control in ProcessUtility()

  1011121314151617181920
• check_password_hookAuthentication and connections10 – 20

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

  1011121314151617181920
• create_upper_paths_hookQuery planning10 – 20

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

  1011121314151617181920
• emit_log_hookLogging and function calls10 – 20

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

  1011121314151617181920
• explain_get_index_name_hookEXPLAIN10 – 20

  Hook for plugins to get control in explain_get_index_name()

  1011121314151617181920
• explain_per_node_hookEXPLAIN18 – 20

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

  1011121314151617181920
• explain_per_plan_hookEXPLAIN18 – 20

  Hook for EXPLAIN plugins to print extra information for each plan

  1011121314151617181920
• explain_validate_options_hookEXPLAIN18 – 20

  Hook to perform additional EXPLAIN options validation

  1011121314151617181920
• fmgr_hookLogging and function calls10 – 20

  function manager hook

  1011121314151617181920
• get_attavgwidth_hookStatistics and estimation10 – 20

  Hook for plugins to get control in get_attavgwidth()

  1011121314151617181920
• get_index_stats_hookStatistics and estimation10 – 20

  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_info_hookQuery planning10 – 18

  Hook for plugins to get control in get_relation_info()

  1011121314151617181920
• get_relation_stats_hookStatistics and estimation10 – 20

  Hooks for plugins to get control when we ask for stats

  1011121314151617181920
• join_search_hookQuery planning10 – 20

  Hook for plugins to replace standard_join_search()

  1011121314151617181920
• ldap_password_hookAuthentication and connections16 – 20

  hook type for password manglers

  1011121314151617181920
• needs_fmgr_hookLogging and function calls10 – 20

  Hooks for function calls

  1011121314151617181920
• object_access_hookPermissions and object access10 – 20

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

  1011121314151617181920
• object_access_hook_strPermissions and object access15 – 20

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

  1011121314151617181920
• openssl_tls_init_hookAuthentication and connections13 – 20

  Call init hook (usually to set password callback)

  1011121314151617181920
• planner_hookQuery planning10 – 20

  Hook for plugins to get control in planner()

  1011121314151617181920
• post_parse_analyze_hookParsing and utility commands10 – 20

  Hook for plugins to get control at end of parse analysis

  1011121314151617181920
• row_security_policy_hook_permissivePermissions and object access10 – 20

  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 policies which are enforced, regardless of other policies (they are combined using AND).

  1011121314151617181920
• row_security_policy_hook_restrictivePermissions and object access10 – 20

  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
• set_join_pathlist_hookQuery planning10 – 20

  Hook for plugins to get control in add_paths_to_joinrel()

  1011121314151617181920
• set_rel_pathlist_hookQuery planning10 – 20

  Hook for plugins to get control in set_rel_pathlist()

  1011121314151617181920
• shmem_request_hookStartup and shared memory15 – 20

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

  1011121314151617181920
• shmem_startup_hookStartup and shared memory10 – 20

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

  1011121314151617181920