summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/html/view-pg-hba-file-rules.html
blob: 0671c35ca1dd16a6b9d84b9fd2182d62c38ea7fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>54.9. pg_hba_file_rules</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="view-pg-group.html" title="54.8. pg_group" /><link rel="next" href="view-pg-ident-file-mappings.html" title="54.10. pg_ident_file_mappings" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">54.9. <code class="structname">pg_hba_file_rules</code></th></tr><tr><td width="10%" align="left"><a accesskey="p" href="view-pg-group.html" title="54.8. pg_group">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="views.html" title="Chapter 54. System Views">Up</a></td><th width="60%" align="center">Chapter 54. System Views</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 15.6 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="view-pg-ident-file-mappings.html" title="54.10. pg_ident_file_mappings">Next</a></td></tr></table><hr /></div><div class="sect1" id="VIEW-PG-HBA-FILE-RULES"><div class="titlepage"><div><div><h2 class="title" style="clear: both">54.9. <code class="structname">pg_hba_file_rules</code></h2></div></div></div><a id="id-1.10.5.13.2" class="indexterm"></a><p>
   The view <code class="structname">pg_hba_file_rules</code> provides a summary of
   the contents of the client authentication configuration file,
   <a class="link" href="auth-pg-hba-conf.html" title="21.1. The pg_hba.conf File"><code class="filename">pg_hba.conf</code></a>.
   A row appears in this view for each
   non-empty, non-comment line in the file, with annotations indicating
   whether the rule could be applied successfully.
  </p><p>
   This view can be helpful for checking whether planned changes in the
   authentication configuration file will work, or for diagnosing a previous
   failure.  Note that this view reports on the <span class="emphasis"><em>current</em></span> contents
   of the file, not on what was last loaded by the server.
  </p><p>
   By default, the <code class="structname">pg_hba_file_rules</code> view can be read
   only by superusers.
  </p><div class="table" id="id-1.10.5.13.6"><p class="title"><strong>Table 54.9. <code class="structname">pg_hba_file_rules</code> Columns</strong></p><div class="table-contents"><table class="table" summary="pg_hba_file_rules Columns" border="1"><colgroup><col /></colgroup><thead><tr><th class="catalog_table_entry"><p class="column_definition">
       Column Type
      </p>
      <p>
       Description
      </p></th></tr></thead><tbody><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">line_number</code> <code class="type">int4</code>
      </p>
      <p>
       Line number of this rule in <code class="filename">pg_hba.conf</code>
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">type</code> <code class="type">text</code>
      </p>
      <p>
       Type of connection
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">database</code> <code class="type">text[]</code>
      </p>
      <p>
       List of database name(s) to which this rule applies
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">user_name</code> <code class="type">text[]</code>
      </p>
      <p>
       List of user and group name(s) to which this rule applies
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">address</code> <code class="type">text</code>
      </p>
      <p>
       Host name or IP address, or one
       of <code class="literal">all</code>, <code class="literal">samehost</code>,
       or <code class="literal">samenet</code>, or null for local connections
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">netmask</code> <code class="type">text</code>
      </p>
      <p>
       IP address mask, or null if not applicable
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">auth_method</code> <code class="type">text</code>
      </p>
      <p>
       Authentication method
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">options</code> <code class="type">text[]</code>
      </p>
      <p>
       Options specified for authentication method, if any
      </p></td></tr><tr><td class="catalog_table_entry"><p class="column_definition">
       <code class="structfield">error</code> <code class="type">text</code>
      </p>
      <p>
       If not null, an error message indicating why this
       line could not be processed
      </p></td></tr></tbody></table></div></div><br class="table-break" /><p>
   Usually, a row reflecting an incorrect entry will have values for only
   the <code class="structfield">line_number</code> and <code class="structfield">error</code> fields.
  </p><p>
   See <a class="xref" href="client-authentication.html" title="Chapter 21. Client Authentication">Chapter 21</a> for more information about
   client authentication configuration.
  </p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="view-pg-group.html" title="54.8. pg_group">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="views.html" title="Chapter 54. System Views">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="view-pg-ident-file-mappings.html" title="54.10. pg_ident_file_mappings">Next</a></td></tr><tr><td width="40%" align="left" valign="top">54.8. <code class="structname">pg_group</code> </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 15.6 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 54.10. <code class="structname">pg_ident_file_mappings</code></td></tr></table></div></body></html>