Help Center> GaussDB> Distributed_2.x> API Reference> libpq Interface Reference> Database Connection Control Functions> PQconnectdb
Updated on 2023-10-23 GMT+08:00
View PDF

PQconnectdb

Function

PQconnectdb is used to establish a new connection with the database server.

Prototype

PGconn *PQconnectdb(const char *conninfo);

Parameter

Table 1 PQconnectdb parameter

Keyword

Parameter Description

conninfo

Connection string. For details about the fields in the string, see Connection Strings.

Return Value

PGconn * points to the object pointer that contains a connection. The memory is applied for by the function internally.

Precautions

  • This function establishes a new database connection using the parameters taken from the string conninfo.
  • The input parameter can be empty, indicating that all default parameters can be used. It can also contain one or more parameters separated by spaces or it can contain a URL.

Example

For details, see Example.