Skip to main content
Version Next

Connection Pool Global Parameters Configuration

Command Syntax
Terminal input
    pgsmart pool config [Flags]

Flags​

  • -a, --agent= <agent> => Alias, hostname or IP of the server where the desired 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

Consult Global Parameters​

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

  2. Select Configurações Globais from the menu.

    • The default and user-configured pool global parameters will be displayed.

    • To locate a parameter, type its full or partial name or any related string. The search is case-insensitive.

    • To view parameter details, press <ENTER> on the desired parameter.

    note

    • Global parameters are grouped by section.

    • Each parameter is identified by its origin, meaning the source from which its value is defined:

      global: parameters manually configured by the user. default: parameters that retain their default values, with no user intervention. user: parameters defined by authorized users in the Connection Pool. pool: parameters specific to each connection pool.

      • Examples:

        • Global parameter (applies to all pools and user groups):
            ─── [ pgbouncer ] ───
                client_idle_timeout = (disabled)
            ─── [ pgbouncer ] ───
                (default) autodb_idle_timeout = 3600s
    warning
    • Parameters shown in blue are mandatory and essential for service operation.
    • Parameters shown in red are inconsistent and must be corrected.
    note

    • Each connection pool parameter is fully documented with the following (when applicable):

      • Name
      • Type (integer, boolean, string, size, list, list_kv)
      • Current Value
      • Value Source (default, global)
      • Default Value
      • Group (e.g., Authentication Settings, Timeouts, TLS Settings)
      • Sections (contexts, e.g., pgbouncer)
      • Possible Values
      • Mandatory?
      • Requires Restart?
      • Read-Only?
      • Description
      • Additional Description (examples, important notes)
    Figure 1 - Pool Global Parameters - Consultation
    Figure 1 - Pool Global Parameters - Consultation
    Figure 2 - Pool Global Parameters - Filtered Consultation
    Figure 2 - Pool Global Parameters - Filtered Consultation

Edit Global Parameters​

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

  2. Select Configurações Globais from the menu.

    • The default and user-configured pool parameters will be displayed.

  3. Select the desired parameter and press <ENTER>.

    • The parameter details will be displayed.

  4. Select Editar.

  5. Adjust the parameter setting as required (operation varies by parameter type).

  6. Confirm the operation.

  7. Confirm the restart if requested.

    note
    • Parameter setting varies by type:
    • boolean enable/disable
    • string entered value
    • integer number within range
    • list comma-separated values
    • size in B, KB, MB, GB, TB, PB
    • time in ms, s, min, h, d, w
    • enum choice from list
    • path identifies a file path
    warning
    • To modify an existing configuration, use the Edit Parameter function.
    Figure 3 - Global Pool Parameters - Editing
    Figure 3 - Global Pool Parameters - Editing

Remove Global Parameters​

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

  2. Select Configurações Globais from the menu.

    • The default and user-configured pool parameters will be displayed.

  3. Press <ENTER> on the desired parameter to view its details.

  4. Select Remover.

  5. Confirm the operation.

  6. Confirm the restart if requested.

    Figure 4 - Pool Parameters - Removal
    Figure 4 - Pool Parameters - Removal
    note

    Removing a parameter configuration will revert it to its default value.

Final Notes
note

  • Depending on the parameter modified, RELOAD or RESTART may be required. PgSmart will inform which action is needed.

  • If Reload or Restart is not confirmed, the configuration will remain pending in the file until action is taken.