package pgxprocess

Import Path
	go.pact.im/x/pgxprocess (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 0 packages

Involved Source Files

	    conn.go
	  d doc.go
		Package pgxprocess provides [process.Runner] wrapper for [pgx.Conn] and
		[pgxpool.Pool].

	    errors.go
	    handle.go
	    pool.go
Package-Level Type Names (total 7, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Conn (struct)
		Conn wraps [pgx.Conn] to delay connection setup to application runtime.

		Fields (total 3, in which 1 is exported)
			Config *pgx.ConnConfig
			/* 2 unexporteds ... *//* 2 unexporteds: */
			handle handle[pgx.Conn, *pgx.Conn]
			handle.pointer atomic.Pointer[pgx.Conn]
		Methods (total 10, all are exported)
			(*Conn) Begin(ctx context.Context) (pgx.Tx, error)
			(*Conn) BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
			(*Conn) CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, rowSrc pgx.CopyFromSource) (int64, error)
			(*Conn) Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)
			(*Conn) Handle() *pgx.Conn
				Handle returns the underlying database handle.

			(*Conn) Ping(ctx context.Context) error
			(*Conn) Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
			(*Conn) QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
			(*Conn) Run(ctx context.Context, callback process.Callback) error
				Run implements the [process.Runner] interface.

			(*Conn) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults
		Implements (at least 3, in which 2 are exported)
			*Conn : go.pact.im/x/process.Runner
			*Conn : database/sql/driver.Pinger
			/* at least one unexported ... *//* at least one unexported: */
			*Conn : database

	 type Pool (struct)
		Pool wraps [pgxpool.Pool] to delay pool setup to application runtime.

		Fields (total 3, in which 1 is exported)
			Config *pgxpool.Config
			/* 2 unexporteds ... *//* 2 unexporteds: */
			handle handle[pgxpool.Pool, *pgxpool.Pool]
			handle.pointer atomic.Pointer[pgxpool.Pool]
		Methods (total 10, all are exported)
			(*Pool) Begin(ctx context.Context) (pgx.Tx, error)
			(*Pool) BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
			(*Pool) CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, rowSrc pgx.CopyFromSource) (int64, error)
			(*Pool) Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)
			(*Pool) Handle() *pgxpool.Pool
				Handle returns the underlying database handle.

			(*Pool) Ping(ctx context.Context) error
			(*Pool) Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
			(*Pool) QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
			(*Pool) Run(ctx context.Context, callback process.Callback) error
				Run implements the [process.Runner] interface.

			(*Pool) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults
		Implements (at least 3, in which 2 are exported)
			*Pool : go.pact.im/x/process.Runner
			*Pool : database/sql/driver.Pinger
			/* at least one unexported ... *//* at least one unexported: */
			*Pool : database

	/* 5 unexporteds ... *//* 5 unexporteds: */
	 type database (interface)
		database is a common interface for [pgx.Conn] and [pgxpool.Pool].

		Methods (total 8, all are exported)
			( database) Begin(context.Context) (pgx.Tx, error)
			( database) BeginTx(context.Context, pgx.TxOptions) (pgx.Tx, error)
			( database) CopyFrom(context.Context, pgx.Identifier, []string, pgx.CopyFromSource) (int64, error)
			( database) Exec(context.Context, string, ...any) (pgconn.CommandTag, error)
			( database) Ping(context.Context) error
			( database) Query(context.Context, string, ...any) (pgx.Rows, error)
			( database) QueryRow(context.Context, string, ...any) pgx.Row
			( database) SendBatch(context.Context, *pgx.Batch) pgx.BatchResults
		Implemented By (at least 6, in which 5 are exported)
			*Conn
			*Pool
			*github.com/jackc/pgx/v5.Conn
			*github.com/jackc/pgx/v5/pgxpool.Conn
			*github.com/jackc/pgx/v5/pgxpool.Pool
			/* at least one unexported ... *//* at least one unexported: */
			*handle[...]
		Implements (at least one exported)
			 database : database/sql/driver.Pinger

	 type errBatchResults (struct)

		Methods (total 4, all are exported)
			( errBatchResults) Close() error
			( errBatchResults) Exec() (pgconn.CommandTag, error)
			( errBatchResults) Query() (pgx.Rows, error)
			( errBatchResults) QueryRow() pgx.Row
		Implements (at least 2, both are exported)
			 errBatchResults : github.com/jackc/pgx/v5.BatchResults
			 errBatchResults : io.Closer

	 type errRow (struct)

		Methods (only one, which is exported)
			( errRow) Scan(_ ...any) error
		Implements (at least one exported)
			 errRow : github.com/jackc/pgx/v5.Row

	 type errRows (struct)

		Methods (total 9, all are exported)
			( errRows) Close()
			( errRows) CommandTag() pgconn.CommandTag
			( errRows) Conn() *pgx.Conn
			( errRows) Err() error
			( errRows) FieldDescriptions() []pgconn.FieldDescription
			( errRows) Next() bool
			( errRows) RawValues() [][]byte
			( errRows) Scan(_ ...any) error
			( errRows) Values() ([]any, error)
		Implements (at least 4, all are exported)
			 errRows : github.com/jackc/pgx/v5.CollectableRow
			 errRows : github.com/jackc/pgx/v5.CopyFromSource
			 errRows : github.com/jackc/pgx/v5.Row
			 errRows : github.com/jackc/pgx/v5.Rows

	 type handle[T, P] (struct)

		Type Parameters:
			T: any
			P: interface{*T; database}

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			pointer atomic.Pointer[T]
		Methods (total 9, all are exported)
			(*handle[T, P]) Begin(ctx context.Context) (pgx.Tx, error)
			(*handle[T, P]) BeginTx(ctx context.Context, txOptions pgx.TxOptions) (pgx.Tx, error)
			(*handle[T, P]) CopyFrom(ctx context.Context, tableName pgx.Identifier, columnNames []string, rowSrc pgx.CopyFromSource) (int64, error)
			(*handle[T, P]) Exec(ctx context.Context, sql string, args ...any) (pgconn.CommandTag, error)
			(*handle[T, P]) Handle() P
				Handle returns the underlying database handle.

			(*handle[T, P]) Ping(ctx context.Context) error
			(*handle[T, P]) Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
			(*handle[T, P]) QueryRow(ctx context.Context, sql string, args ...any) pgx.Row
			(*handle[T, P]) SendBatch(ctx context.Context, b *pgx.Batch) pgx.BatchResults
		Implements (at least 2, in which 1 is exported)
			*handle : database/sql/driver.Pinger
			/* at least one unexported ... *//* at least one unexported: */
			*handle : database


Package-Level Variables (only one, which is exported)

	  var ErrNotConnected error
		ErrNotConnected is an error that is returned if database handle is not
		connected.

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)