Help Center > > Developer Guide

Configuring a Data Source in the Windows OS

Updated at: Jul 14, 2021 GMT+08:00

Configure the ODBC data source using the ODBC data source manager preinstalled in the Windows OS.


  1. Replace the GaussDB(DWS) client driver.

    Decompress GaussDB-8.1.0-Windows-Odbc.tar.gz and install psqlodbc.msi (for 32-bit OS) or psqlodbc_x64.msi (for 64-bit OS).

  2. Open Driver Manager.

    Use the Driver Manager suitable for your OS to configure the data source. (Assume the Windows system drive is drive C.)

    • If you develop 32-bit programs in the 64-bit Windows OS, open the 32-bit Driver Manager at C:\Windows\SysWOW64\odbcad32.exe after you install the 32-bit driver.

      Do not open Driver Manager by choosing Control Panel, clicking Administrative Tools, and clicking Data Sources (ODBC).

      WoW64 is the acronym for "Windows 32-bit on Windows 64-bit". C:\Windows\SysWOW64\ stores the 32-bit environment on a 64-bit system. C:\Windows\System32\ stores the environment consistent with the current OS. For technical details, see Windows technical documents.

    • If you develop 64-bit programs in the 64-bit Windows OS, open the 64-bit Driver Manager at C:\Windows\System32\odbcad32.exe after you install the 64-bit driver.

      Do not open Driver Manager by choosing Control Panel, clicking Administrative Tools, and clicking Data Sources (ODBC).

    • In a 32-bit Windows OS, open C:\Windows\System32\odbcad32.exe.

      In the Windows OS, click Computer, and choose Control Panel. Click Administrative Tools and click Data Sources (ODBC).

  3. Configure the data source.

    On the User DSN tab, click Add, and choose PostgreSQL Unicode for setup. (An identifier will be displayed for the 64-bit OS.)

    The entered user name and password will be recorded in the Windows registry and you do not need to enter them again when connecting to the database next time. For security purposes, you are advised to delete sensitive information before clicking Save and enter the required user name and password again when using ODBC APIs to connect to the database.

  4. Enable the SSL mode.

    To use SSL certificates for connection, decompress the certificate package contained in the GaussDB(DWS) installation package, and double-click the sslcert_env.bat file to deploy certificates in the default location.

    The sslcert_env.bat file ensures the purity of the certificate environment. When the %APPDATA%\postgresql directory exists, a message will be prompted asking you whether you want to remove related directories. If you want to remove related directories, back up files in the directory.

    Alternatively, you can copy the client.crt, client.key, client.key.cipher, and client.key.rand files in the certificate file folder to the manually created %APPDATA%\postgresql directory. Change client in the file names to postgres, for example, change client.key to postgres.key. Copy the cacert.pem file to the %APPDATA%\postgresql directory and change its name to root.crt.

    Change the value of SSL Mode in step 2 to verify-ca.

    Table 1 sslmode options


    Whether SSL Encryption Is Enabled




    The SSL secure connection is not used.



    The SSL secure encrypted connection is used if required by the database server, but does not check the authenticity of the server.



    The SSL secure encrypted connection is used as a preferred mode if supported by the database, but does not check the authenticity of the server.



    The SSL secure connection must be used, but it only encrypts data and does not check the authenticity of the server.



    The SSL secure connection must be used, and it checks whether the database has certificates issued by a trusted CA.



    The SSL secure connection must be used. In addition to the check scope specified by verify-ca, it checks whether the name of the host where the database resides is the same as that on the certificate.

  5. Configuring the GaussDB(DWS) server.

    To accept remote services, in the postgresql.conf file in the data directory of a CN, modify listen_addresses to add the comma-separated IP addresses or host names of NICs providing external services. You can also set listen_addresses to * or to listen to all NICs, but this incurs security risks and is not recommended.
    gs_guc set -Z coordinator -D ${BIGDATA_DATA_HOME}/
     -c " 'listen_addresses = localhost,,'"

    In this example, is the added IP address of a network adapter providing external services.

    In the pg_hba.conf file directory, add authentication information.

    gs_guc reload -Z coordinator -N all -I all -h "host all all sha256"
    • -Z coordinator indicates that the instance type is coordinator.
    • -N all indicates all hosts in the cluster.
    • -I all indicates all instances of the host.
    • -h indicates statements that need to be added in the pg_hba.conf file.
    • The first all indicates a client can be connected to any database.
    • The second all indicates the user name for connecting to the database.
    • indicates hosts whose IP address is can be connected. Modify its value based on actual network configuration.
    • sha256 indicates that the password of user omm is encrypted using the SHA-256 algorithm.

  6. Run the following commands to restart the cluster:

    gs_om -t stop
    gs_om -t start

Testing Data Source Configuration

Click Test.

  • If the following information is displayed, the configuration is correct and the connection succeeds.

  • If error information is displayed, the configuration is incorrect. Check the configuration.


  • Server common name "xxxx" does not match host name "xxxxx"

    This problem occurs because when verify-full is used for SSL encryption, the driver checks whether the host name in certificates is the same as the actual one. To solve this problem, use verify-ca to stop checking host names, or generate a set of CA certificates containing the actual host names.

  • connect to server failed: no such file or directory

    Possible causes:

    • An incorrect or unreachable database IP address or port was configured.

      Check the Servername and Port configuration items in data sources.

    • Server monitoring is improper.

      If Servername and Port are correctly configured, ensure the proper network adapter and port are monitored based on database server configurations in the procedure in this section.

    • Firewall and network gatekeeper settings are improper.

      Check firewall settings, ensuring that the database communication port is trusted.

      Check to ensure network gatekeeper settings are proper (if any).

  • In the specified DSN, the system structures of the drive do not match those of the application.

    Possible cause: The bit versions of the drive and program are different.

    C:\Windows\SysWOW64\odbcad32.exe is a 32-bit ODBC Drive Manager.

    C:\Windows\System32\odbcad32.exe is a 64-bit ODBC Drive Manager.

  • The password-stored method is not supported.

    Possible causes:

    sslmode is not configured for the data source. Set this configuration item to allow or a higher level to enable SSL connections. For details about sslmode, see Table 1.

  • authentication method 10 not supported.

    If this error occurs on an open source client, the cause may be:

    The database stores only the SHA-256 hash of the password, but the open source client supports only MD5 hashes.

    • The database stores the hashes of user passwords instead of actual passwords.
    • In versions earlier than V100R002C80SPC300, the database stores only SHA-256 hashes and no MD5 hashes. Therefore, MD5 cannot be used for user password authentication.
    • In V100R002C80SPC300 and later, if a password is updated or a user is created, both types of hashes will be stored, compatible with open-source authentication protocols.
    • An MD5 hash can only be generated using the original password, but the password cannot be obtained by reversing its SHA-256 hash. If your database is upgraded from a version earlier than V100R002C80SPC300, passwords in the old version will only have SHA-256 hashes and not support MD5 authentication.

    To solve this problem, you can update the password, or create a user assigned the same permission as the invalid user.

  • unsupported frontend protocol 3.51: server supports 1.0 to 3.0

    The database version is too early or the database is an open-source database. Use the driver of the required version to connect to the database.

  • FATAL: GSS authentication method is not allowed because XXXX user password is not disabled.

    In some cases, the error is: GSSAPI authentication not supported.

    In pg_hba.conf of the target CN, the authentication mode is set to gss for authenticating the IP address of the current client. However, this authentication algorithm cannot authenticate clients. Change the authentication algorithm to sha256 and try again. For details, see 6.

    Note that cross-node connection to the database in the cluster is not supported. If the error is caused by cross-node connection to the CN in the cluster, connect the service program to the database from a node outside the cluster and try again.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?

Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel