Skip to main content
Version Next

Authorized Users Parameters Configuration for Connection Pool

Command Syntax
Terminal input
    pgsmart pool config [Flags]

Flags​

  • -a, --agent= <agent> => Alias, hostname, or IP of the server where the PgSmart Agent is installed.
  • -h, --help => Help
Non-Interactive Configuration

Non-interactive execution is disabled for this operation.

Interactive Configuration
Terminal input
    pgsmart pool config

Authorized User Group parameters can be viewed or configured in the following ways:

  • When listing existing Authorized User profiles.
  • During creation of a new Authorized User profile, with option to define parameters.
  • When editing a profile, with option to update parameters as needed.

  1. Select the desired PgSmart Agent or Register a new Agent.

  2. Select Usuários Autorizados from the menu.

  3. Select Listar.

    • Parameters for Authorized Users, both default and custom, will be displayed.

    • To find a parameter, type its full or partial name or any related term. Search is case-insensitive.

    • To view parameter details, press <ENTER>.

    note

    • Authorized User parameters are grouped by section.

    • Each parameter is marked by its source:

      • default: untouched by the user.
      • user: configured specifically for the user group.

    Examples:

    ─── [ postgres ] ─── (user) max_user_connections = 3 (default) pool_size = 20

    ─── [ usu2 ] ─── (user) max_user_connections = 10 (default) pool_size = 20

    warning
    • Parameters shown in blue are mandatory for the service.
    • Parameters in red are inconsistent and must be corrected.
    note

    • Parameters are documented in full to help users understand how to configure them correctly:

      • Name: Parameter name.
      • Type: Accepted value type (e.g., integer, boolean, string, size, list, list_kv).
      • Current Value: Value currently set.
      • Source: Origin of the value (e.g., default, user).
      • Default Value: Value used if none is configured.
      • Group: Functional category (e.g., Authentication, Timeouts, TLS).
      • Sections: Contexts where the parameter is used (e.g., pgbouncer).
      • Possible Values: List of acceptable values.
      • Mandatory?: Whether the parameter is required.
      • Requires Restart?: Indicates if restart is needed to apply changes.
      • Read-Only?: Indicates if it can be changed after initial setup.
      • Description: Summary of the parameter’s function.
      • Additional Description: Notes, examples, or warnings.
    Figure 1 - Authorized Users - Parameter Consultation
    Figure 1 - Authorized Users - Parameter Consultation

  1. Select the desired PgSmart Agent or Register a new Agent.

  2. Select Usuários Autorizados from the menu.

  3. Select Editar option.

  4. Select the user for whom you want to configure parameters.

  5. Update the authorized user parameters:

    • Connection user: name used by clients for authentication.
    • Password: password for the connection user.
    • Reuse mode (pool_mode): optional; defines how connections are reused (e.g., session, transaction).
    • Maximum connections (max_user_connections): optional; sets the connection limit for this user.

  6. Confirm the operation.

  7. Confirm the service restart if prompted.

    Figure 2 - Pool Parameters - User Parameter Editing
    Figure 2 - Pool Parameters - User Parameter Editing
Final Notes
note

  • Depending on the parameter changed, PgSmart may require a RELOAD or RESTART of the instance.

  • If Reload or Restart is not confirmed, the change will remain pending until the necessary action is performed.