Help Center/ GaussDB/ Developer Guide(Centralized_V2.0-8.x)/ Application Development Guide/ Development Based on libpq/ libpq Interface Reference/ Database Statement Execution Functions/ PQexecPreparedBatch
Updated on 2025-08-19 GMT+08:00
View PDF

PQexecPreparedBatch

Description

Sends a request to execute a prepared statement with batches of given parameters and waits for the result.

Prototype

PGresult* PQexecPreparedBatch(PGconn* conn, 
                              const char* stmtName, 
                              int nParams,
                              int nBatchCount,
                              const char* const* paramValues,
                              const int* paramLengths,
                              const int* paramFormats,
                              int resultFormat);

Parameters

Table 1 PQexecPreparedBatch parameters

Keyword

Description

conn

Connection handle.

stmtName

stmt name, which can be set to "" or NULL to reference an unnamed statement. Otherwise, it must be the name of an existing prepared statement.

nParams

Parameter quantity.

nBatchCount

Number of batches.

paramValues

Actual values of parameters.

paramLengths

Actual data lengths of parameters.

NOTICE:

In the following cases, the parameter length is forcibly set to the corresponding value of paramLengths:

  • The parameter is in binary format.
  • The parameter is in text format and the value of force_no_truncation is 1.

In these cases, paramLengths cannot be empty, and the caller must ensure the correctness of the parameter length.

paramFormats

Parameter formats (text or binary).

resultFormat

Return result format (text or binary).

Return Values

PGresult pointers.