From bed16ba6c168342f4aff80836751d8ca63946372 Mon Sep 17 00:00:00 2001 From: Yvan da Silva Date: Fri, 6 Sep 2024 09:07:44 +0200 Subject: [PATCH 1/2] docs: add missing documentation about copyfrom Add documentation for query annotation. Add config reference for required by . --- docs/reference/config.md | 2 ++ docs/reference/query-annotations.md | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/docs/reference/config.md b/docs/reference/config.md index 2629babf4b..2c532f8432 100644 --- a/docs/reference/config.md +++ b/docs/reference/config.md @@ -135,6 +135,8 @@ The `gen` mapping supports the following keys: - Output directory for generated code. - `sql_package`: - Either `pgx/v4`, `pgx/v5` or `database/sql`. Defaults to `database/sql`. +- `sql_driver`: + - Either `github.com/jackc/pgx/v4`, `github.com/jackc/pgx/v5`, `github.com/lib/pq` or `github.com/go-sql-driver/mysql`. No defaults, required if query annotation `:copyfrom` is used. - `emit_db_tags`: - If true, add DB tags to generated structs. Defaults to `false`. - `emit_prepared_queries`: diff --git a/docs/reference/query-annotations.md b/docs/reference/query-annotations.md index 0045f49fa7..4fabe05aae 100644 --- a/docs/reference/query-annotations.md +++ b/docs/reference/query-annotations.md @@ -222,3 +222,9 @@ func (b *CreateBookBatchResults) Close() error { //... } ``` + +## `:copyfrom` + +__NOTE: This command is driver and package specific, see [how to insert](../howto/insert.md#using-copyfrom) + +This command is used to insert rows a lot faster than sequential inserts. From b732e85c93960dcdbc0c62b234eb106c2c552118 Mon Sep 17 00:00:00 2001 From: Yvan da Silva Date: Fri, 6 Sep 2024 09:16:18 +0200 Subject: [PATCH 2/2] docs: fix sql_driver config grammar --- docs/reference/config.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/config.md b/docs/reference/config.md index 2c532f8432..9d334834f0 100644 --- a/docs/reference/config.md +++ b/docs/reference/config.md @@ -136,7 +136,7 @@ The `gen` mapping supports the following keys: - `sql_package`: - Either `pgx/v4`, `pgx/v5` or `database/sql`. Defaults to `database/sql`. - `sql_driver`: - - Either `github.com/jackc/pgx/v4`, `github.com/jackc/pgx/v5`, `github.com/lib/pq` or `github.com/go-sql-driver/mysql`. No defaults, required if query annotation `:copyfrom` is used. + - Either `github.com/jackc/pgx/v4`, `github.com/jackc/pgx/v5`, `github.com/lib/pq` or `github.com/go-sql-driver/mysql`. No defaults. Required if query annotation `:copyfrom` is used. - `emit_db_tags`: - If true, add DB tags to generated structs. Defaults to `false`. - `emit_prepared_queries`: