conn.go

Documentation: github.com/jackc/pgx/v5/pgxpool

     1  package pgxpool
     2  
     3  import (
     4  	"context"
     5  	"sync/atomic"
     6  
     7  	"github.com/jackc/pgx/v5"
     8  	"github.com/jackc/pgx/v5/pgconn"
     9  	"github.com/jackc/puddle/v2"
    10  )
    11  
    12  // Conn is an acquired *pgx.Conn from a Pool.
    13  type Conn struct {
    14  	res *puddle.Resource[*connResource]
    15  	p   *Pool
    16  }
    17  
    18  // Release returns c to the pool it was acquired from. Once Release has been called, other methods must not be called.
    19  // However, it is safe to call Release multiple times. Subsequent calls after the first will be ignored.
    20  func (c *Conn) Release() {
    21  	if c.res == nil {
    22  		return
    23  	}
    24  
    25  	conn := c.Conn()
    26  	res := c.res
    27  	c.res = nil
    28  
    29  	if conn.IsClosed() || conn.PgConn().IsBusy() || conn.PgConn().TxStatus() != 'I' {
    30  		res.Destroy()
    31  		// Signal to the health check to run since we just destroyed a connections
    32  		// and we might be below minConns now
    33  		c.p.triggerHealthCheck()
    34  		return
    35  	}
    36  
    37  	// If the pool is consistently being used, we might never get to check the
    38  	// lifetime of a connection since we only check idle connections in checkConnsHealth
    39  	// so we also check the lifetime here and force a health check
    40  	if c.p.isExpired(res) {
    41  		atomic.AddInt64(&c.p.lifetimeDestroyCount, 1)
    42  		res.Destroy()
    43  		// Signal to the health check to run since we just destroyed a connections
    44  		// and we might be below minConns now
    45  		c.p.triggerHealthCheck()
    46  		return
    47  	}
    48  
    49  	if c.p.afterRelease == nil {
    50  		res.Release()
    51  		return
    52  	}
    53  
    54  	go func() {
    55  		if c.p.afterRelease(conn) {
    56  			res.Release()
    57  		} else {
    58  			res.Destroy()
    59  			// Signal to the health check to run since we just destroyed a connections
    60  			// and we might be below minConns now
    61  			c.p.triggerHealthCheck()
    62  		}
    63  	}()
    64  }
    65  
    66  // Hijack assumes ownership of the connection from the pool. Caller is responsible for closing the connection. Hijack
    67  // will panic if called on an already released or hijacked connection.
    68  func (c *Conn) Hijack() *pgx.Conn {
    69  	if c.res == nil {
    70  		panic("cannot hijack already released or hijacked connection")
    71  	}
    72  
    73  	conn := c.Conn()
    74  	res := c.res
    75  	c.res = nil
    76  
    77  	res.Hijack()
    78  
    79  	return conn
    80  }
    81  
    82  func (c *Conn) Exec(ctx context.Context, sql string, arguments ...any) (pgconn.CommandTag, error) {
    83  	return c.Conn().Exec(ctx, sql, arguments...)
    84  }
    85  
    86  func (c *Conn) Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error) {
    87  	return c.Conn().Query(ctx, sql, args...)
    88  }
    89  
    90  func (c *Conn) QueryRow(ctx context.Context, sql string, args ...any) pgx.Row {
    91  	return c.Conn().QueryRow(ctx, sql, args...)
    92  }
    93  
    94  func (c *Conn) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults {
    95  	return c.Conn().SendBatch(ctx, b)
    96  }
    97  
    98  func (c *Conn) CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, rowSrc pgx.CopyFromSource) (int64, error) {
    99  	return c.Conn().CopyFrom(ctx, tableName, columnNames, rowSrc)
   100  }
   101  
   102  // Begin starts a transaction block from the *Conn without explicitly setting a transaction mode (see BeginTx with TxOptions if transaction mode is required).
   103  func (c *Conn) Begin(ctx context.Context) (pgx.Tx, error) {
   104  	return c.Conn().Begin(ctx)
   105  }
   106  
   107  // BeginTx starts a transaction block from the *Conn with txOptions determining the transaction mode.
   108  func (c *Conn) BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error) {
   109  	return c.Conn().BeginTx(ctx, txOptions)
   110  }
   111  
   112  func (c *Conn) Ping(ctx context.Context) error {
   113  	return c.Conn().Ping(ctx)
   114  }
   115  
   116  func (c *Conn) Conn() *pgx.Conn {
   117  	return c.connResource().conn
   118  }
   119  
   120  func (c *Conn) connResource() *connResource {
   121  	return c.res.Value()
   122  }
   123  
   124  func (c *Conn) getPoolRow(r pgx.Row) *poolRow {
   125  	return c.connResource().getPoolRow(c, r)
   126  }
   127  
   128  func (c *Conn) getPoolRows(r pgx.Rows) *poolRows {
   129  	return c.connResource().getPoolRows(c, r)
   130  }
   131
View as plain text