GOMODULES
/
pgx
mirror of https://github.com/jackc/pgx.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document that batched queries should not contain multiple statements

pull/2102/head
Jack Christensen 2024-07-03 22:49:02 -05:00
parent dced53f796
commit c64fa0f0f2
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
batch.go
View File

@ -60,9 +60,13 @@ type Batch struct {
QueuedQueries []*QueuedQuery QueuedQueries []*QueuedQuery
} }
// Queue queues a query to batch b. query can be an SQL query or the name of a prepared statement. // Queue queues a query to batch b. query can be an SQL query or the name of a prepared statement. The only pgx option
// The only pgx option argument that is supported is QueryRewriter. Queries are executed using the // argument that is supported is QueryRewriter. Queries are executed using the connection's DefaultQueryExecMode.
// connection's DefaultQueryExecMode. //
// While query can contain multiple statements if the connection's DefaultQueryExecMode is QueryModeSimple, this should
// be avoided. QueuedQuery.Fn must not be set as it will only be called for the first query. That is, QueuedQuery.Query,
// QueuedQuery.QueryRow, and QueuedQuery.Exec must not be called. In addition, any error messages or tracing that
// include the current query may reference the wrong query.
func (b *Batch) Queue(query string, arguments ...any) *QueuedQuery { func (b *Batch) Queue(query string, arguments ...any) *QueuedQuery {
qq := &QueuedQuery{ qq := &QueuedQuery{
SQL: query, SQL: query,