Updated on 2025-05-29 GMT+08:00

File Location

After a database has been installed, three configuration files (gaussdb.conf, gs_hba.conf, and gs_ident.conf) are automatically generated and saved in the data directory. You can use the methods described in this section to change the names and save paths of these configuration files.

When changing the storage directory of a configuration file, set data_directory in gaussdb.conf to the actual data directory.

If a configuration file is incorrectly modified, the database will be seriously affected. Do not modify the configuration files mentioned in this section after installation.

data_directory

Parameter description: Specifies the GaussDB data directory. Only the SYSADMIN user can access this parameter.

Parameter type: string.

Unit: none

Value range: valid path of a directory.

Default value: Specify this parameter during installation. If this parameter is not specified during installation, the database is not initialized by default.

Setting method: This parameter can be set as follows:

  • Set it when GaussDB is installed.
  • This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

Setting suggestion: Retain the default value.

Risks and impacts of improper settings: Change the parameter value after fully understanding the parameter meaning and verifying it through testing.

config_file

Parameter description: Specifies the configuration file (gaussdb.conf) of the primary node.

Parameter type: string.

Unit: none

Value range: a string of more than 0 characters.

Default value: gaussdb.conf (The absolute directory of this file may be displayed in the actual situation.)

Setting method: This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

Setting suggestion: Retain the default value.

Risks and impacts of improper settings: Change the parameter value after fully understanding the parameter meaning and verifying it through testing.

hba_file

Parameter description: Specifies the configuration file (gs_hba.conf) for host-based authentication (HBA). This parameter can be specified only in the gaussdb.conf file and can be accessed only by the SYSADMIN user.

Parameter type: string.

Unit: none

Value range: a string of more than 0 characters.

Default value: gs_hba.conf (The absolute directory of this file may be displayed in the actual situation.)

Setting method: This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

Setting suggestion: You are advised not to modify the parameters in the configuration file.

Risks and impacts of improper settings: The cluster upgrade and backup functions may be affected.

ident_file

Parameter description: Specifies the name of the configuration file (gs_ident.conf) for client authentication. Only the SYSADMIN user can access this parameter.

Parameter type: string.

Unit: none

Value range: a string of more than 0 characters.

Default value: gs_ident.conf (The absolute directory of this file may be displayed in the actual situation.)

Setting method: This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

Setting suggestion: You are advised not to modify the parameters in the configuration file.

Risks and impacts of improper settings: The cluster upgrade and backup functions may be affected.

external_pid_file

Parameter description: Specifies the extra PID file that can be used by the server management program. Only the SYSADMIN user can access this parameter.

Parameter type: string.

Unit: none

Value range: valid file name.

Default value: ""

Setting method: This is a POSTMASTER parameter. Set it based on instructions provided in Table 1.

This parameter takes effect only after the database restarts.

Setting suggestion: Retain the default value.

Risks and impacts of improper settings: Change the parameter value after fully understanding the parameter meaning and verifying it through testing.