0f4df23290
Some checks failed
kotlin / test (push) Has been skipped
python / test (push) Has been skipped
typescript / test (push) Has been skipped
go / build darwin/amd64 (push) Has been cancelled
go / build linux/amd64 (push) Has been cancelled
go / build windows/amd64 (push) Has been cancelled
go / build darwin/arm64 (push) Has been cancelled
go / build linux/arm64 (push) Has been cancelled
go / build windows/arm64 (push) Has been cancelled
go / test (push) Has been cancelled
go / vuln_check (push) Has been cancelled
123 lines
2.2 KiB
Markdown
123 lines
2.2 KiB
Markdown
# Renaming fields
|
|
|
|
Struct field names are generated from column names using a simple algorithm:
|
|
split the column name on underscores and capitalize the first letter of each
|
|
part.
|
|
|
|
```
|
|
account -> Account
|
|
spotify_url -> SpotifyUrl
|
|
app_id -> AppID
|
|
```
|
|
|
|
If you're not happy with a field's generated name, use the `rename` mapping
|
|
to pick a new name. The keys are column names and the values are the struct
|
|
field name to use.
|
|
|
|
```yaml
|
|
version: "2"
|
|
sql:
|
|
- schema: "postgresql/schema.sql"
|
|
queries: "postgresql/query.sql"
|
|
engine: "postgresql"
|
|
gen:
|
|
go:
|
|
package: "authors"
|
|
out: "postgresql"
|
|
rename:
|
|
spotify_url: "SpotifyURL"
|
|
```
|
|
|
|
## Tables
|
|
|
|
The output structs associated with tables can also be renamed. By default,
|
|
the struct name will be the singular version of the table name. For example,
|
|
the `authors` table will generate an `Author` struct and the `book_publishers`
|
|
table will generate a `BookPublisher` struct.
|
|
|
|
```sql
|
|
CREATE TABLE authors (
|
|
id BIGSERIAL PRIMARY KEY,
|
|
name text NOT NULL,
|
|
bio text
|
|
);
|
|
|
|
CREATE TABLE book_publishers (
|
|
id BIGSERIAL PRIMARY KEY,
|
|
name text NOT NULL
|
|
);
|
|
```
|
|
|
|
```go
|
|
package db
|
|
|
|
import (
|
|
"database/sql"
|
|
)
|
|
|
|
type Author struct {
|
|
ID int64
|
|
Name string
|
|
Bio sql.NullString
|
|
}
|
|
|
|
type Publisher struct {
|
|
ID int64
|
|
Name string
|
|
}
|
|
```
|
|
|
|
To rename these structs, you must use the generated struct name. In this
|
|
example, that would be `author` and `book_publisher`. Use the `rename` map to
|
|
change the name of these struct to `Writer` and `BookPublisher` (note the
|
|
camel-casing and the underscore for multi-worded tables).
|
|
|
|
```yaml
|
|
version: '1'
|
|
packages:
|
|
- path: db
|
|
engine: postgresql
|
|
schema: query.sql
|
|
queries: query.sql
|
|
rename:
|
|
author: Writer
|
|
book_publisher: Publisher
|
|
```
|
|
|
|
```yaml
|
|
version: "2"
|
|
sql:
|
|
- engine: postgresql
|
|
queries: query.sql
|
|
schema: query.sql
|
|
overrides:
|
|
go:
|
|
rename:
|
|
author: Writer
|
|
book_publisher: Publisher
|
|
```
|
|
|
|
```go
|
|
package db
|
|
|
|
import (
|
|
"database/sql"
|
|
)
|
|
|
|
type Writer struct {
|
|
ID int64
|
|
Name string
|
|
Bio sql.NullString
|
|
}
|
|
|
|
type Publisher struct {
|
|
ID int64
|
|
Name string
|
|
}
|
|
```
|
|
|
|
## Limitations
|
|
|
|
Rename mappings apply to an entire package. Therefore, a column named `foo` and
|
|
a table name `foo` can't map to different rename values.
|