Skip to content

docs(datatypes): improve details on TEXT #3247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kyleconroy merged 3 commits into from
Mar 7, 2024
Merged

docs(datatypes): improve details on TEXT #3247

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8229e38
feat(datatypes): improve details on TEXT
josethz00 Mar 5, 2024
7f2eab6
docs(datatypes): correct nullable TEXT description
josethz00 Mar 6, 2024
db11568
docs(datatypes): remove incorrect assumption
josethz00 Mar 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(datatypes): correct nullable TEXT description
  • Loading branch information
@josethz00
josethz00 authored Mar 6, 2024
commit 7f2eab6f00491501024cf7ade8b32b479017637d
6 changes: 5 additions & 1 deletion docs/reference/datatypes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,11 @@ type Book struct {

## TEXT

For PostgreSQL, when you have a column with the `TEXT` type, sqlc will map it to `pgtype.Text` by default. If you want to use it as a string in your Golang application, you will need to override it. The `TEXT` datatype is an unlimited size VARCHAR, so, for this reason, if you want to map the `TEXT` SQL datatype to a Golang `string`, you must set the option `pointer: true` in your overrides config. The same applies to MySQL and other supported SQL databases.
In PostgreSQL, when you have a column with the TEXT type, sqlc will map it to a Go string by default. This default mapping applies to `TEXT` columns that are not nullable. However, for nullable `TEXT` columns, sqlc maps them to `pgtype.Text` when using the pgx/v5 driver. This distinction is crucial for developers looking to handle null values appropriately in their Go applications.

To accommodate nullable strings and map them to `*string` in Go, you can use the `emit_pointers_for_null_types` option in your sqlc configuration. This option ensures that nullable SQL columns are represented as pointer types in Go, allowing for a clear distinction between null and non-null values. Another way to do this is by passing the option `pointer: true` when you are overriding the `TEXT` datatype in you sqlc config file.

This behavior is consistent across other supported SQL databases by sqlc, not just PostgreSQL.

## Geometry

Expand Down