From c130b2d74a1ef1e708200c084f8be9ec9bf06961 Mon Sep 17 00:00:00 2001 From: Jack Christensen Date: Sat, 29 Oct 2022 09:48:45 -0500 Subject: [PATCH] Update CopyFrom documentation to be clearer Regarding binary requirement and enums in particular. https://github.com/jackc/pgx/issues/1338 --- copy_from.go | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/copy_from.go b/copy_from.go index c8b98c57..41acafdc 100644 --- a/copy_from.go +++ b/copy_from.go @@ -193,12 +193,14 @@ func (ct *copyFrom) buildCopyBuf(buf []byte, sd *pgconn.StatementDescription) (b return false, buf, nil } -// CopyFrom uses the PostgreSQL copy protocol to perform bulk data insertion. -// It returns the number of rows copied and an error. +// CopyFrom uses the PostgreSQL copy protocol to perform bulk data insertion. It returns the number of rows copied and +// an error. // -// CopyFrom requires all values use the binary format. Almost all types -// implemented by pgx use the binary format by default. Types implementing -// Encoder can only be used if they encode to the binary format. +// CopyFrom requires all values use the binary format. A pgtype.Type that supports the binary format must be registered +// for the type of each column. Almost all types implemented by pgx support the binary format. +// +// Even though enum types appear to be strings they still must be registered to use with CopyFrom. This can be done with +// Conn.LoadType and pgtype.Map.RegisterType. func (c *Conn) CopyFrom(ctx context.Context, tableName Identifier, columnNames []string, rowSrc CopyFromSource) (int64, error) { ct := ©From{ conn: c,