1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
|
package db
import (
"fmt"
"go/ast"
"go/types"
"net/url"
"slices"
"strings"
"github.com/lxc/incus/v6/cmd/generate-database/lex"
"github.com/lxc/incus/v6/shared/util"
)
// Mapping holds information for mapping database tables to a Go structure.
type Mapping struct {
Local bool // Whether the entity is in the same package as the generated code.
FilterLocal bool // Whether the entity is in the same package as the generated code.
Package string // Package of the Go struct
Name string // Name of the Go struct.
Fields []*Field // Metadata about the Go struct.
Filterable bool // Whether the Go struct has a Filter companion struct for filtering queries.
Filters []*Field // Metadata about the Go struct used for filter fields.
Type TableType // Type of table structure for this Go struct.
}
// TableType represents the logical type of the table defined by the Go struct.
type TableType int
// EntityTable represents the type for any entity that maps to a Go struct.
var EntityTable = TableType(0)
// ReferenceTable represents the type for for any entity that contains an
// 'entity_id' field mapping to a parent entity.
var ReferenceTable = TableType(1)
// AssociationTable represents the type for an entity that associates two
// other entities.
var AssociationTable = TableType(2)
// MapTable represents the type for a table storing key/value pairs.
var MapTable = TableType(3)
// NaturalKey returns the struct fields that can be used as natural key for
// uniquely identifying a row in the underlying table (==.
//
// By convention the natural key field is the one called "Name", unless
// specified otherwise with the `db:natural_key` tags.
func (m *Mapping) NaturalKey() []*Field {
key := []*Field{}
for _, field := range m.Fields {
if field.Config.Get("primary") != "" {
key = append(key, field)
}
}
if len(key) == 0 {
// Default primary key.
key = append(key, m.FieldByName("Name"))
}
return key
}
// Identifier returns the field that uniquely identifies this entity.
func (m *Mapping) Identifier() *Field {
for _, field := range m.NaturalKey() {
if field.Name == "Name" || field.Name == "Fingerprint" {
return field
}
}
return nil
}
// TableName determines the table associated to the struct.
// - Individual fields may bypass this with their own `sql=<table>.<column>` tags.
// - The override `table=<name>` directive key is checked first.
// - The struct name itself is used to approximate the table name if none of the above apply.
func (m *Mapping) TableName(entity string, override string) string {
table := entityTable(entity, override)
if m.Type == ReferenceTable || m.Type == MapTable {
table = "%s_" + table
}
return table
}
// ContainsFields checks that the mapping contains fields with the same type
// and name of given ones.
func (m *Mapping) ContainsFields(fields []*Field) bool {
matches := map[*Field]bool{}
for _, field := range m.Fields {
for _, other := range fields {
if field.Name == other.Name && field.Type.Name == other.Type.Name {
matches[field] = true
}
}
}
return len(matches) == len(fields)
}
// FieldByName returns the field with the given name, if any.
func (m *Mapping) FieldByName(name string) *Field {
for _, field := range m.Fields {
if field.Name == name {
return field
}
}
return nil
}
// ActiveFilters returns the active filter fields for the kind of method.
func (m *Mapping) ActiveFilters(kind string) []*Field {
names := activeFilters(kind)
fields := []*Field{}
for _, name := range names {
field := m.FieldByName(name)
if field != nil {
fields = append(fields, field)
}
}
return fields
}
// FieldColumnName returns the column name of the field with the given name,
// prefixed with the entity's table name.
func (m *Mapping) FieldColumnName(name string, table string) string {
field := m.FieldByName(name)
return fmt.Sprintf("%s.%s", table, field.Column())
}
// FilterFieldByName returns the field with the given name if that field can be
// used as query filter, an error otherwise.
func (m *Mapping) FilterFieldByName(name string) (*Field, error) {
for _, filter := range m.Filters {
if name == filter.Name {
if filter.Type.Code != TypeColumn {
return nil, fmt.Errorf("Unknown filter %q not a column", name)
}
return filter, nil
}
}
return nil, fmt.Errorf("Unknown filter %q", name)
}
// ColumnFields returns the fields that map directly to a database column,
// either on this table or on a joined one.
func (m *Mapping) ColumnFields(exclude ...string) []*Field {
fields := []*Field{}
for _, field := range m.Fields {
if slices.Contains(exclude, field.Name) {
continue
}
if field.Type.Code == TypeColumn {
fields = append(fields, field)
}
}
return fields
}
// ScalarFields returns the fields that map directly to a single database
// column on another table that can be joined to this one.
func (m *Mapping) ScalarFields() []*Field {
fields := []*Field{}
for _, field := range m.Fields {
if field.Config.Get("join") != "" || field.Config.Get("leftjoin") != "" {
fields = append(fields, field)
}
}
return fields
}
// RefFields returns the fields that are one-to-many references to other
// tables.
func (m *Mapping) RefFields() []*Field {
fields := []*Field{}
for _, field := range m.Fields {
if field.Type.Code == TypeSlice || field.Type.Code == TypeMap {
fields = append(fields, field)
}
}
return fields
}
// FieldArgs converts the given fields to function arguments, rendering their
// name and type.
func (m *Mapping) FieldArgs(fields []*Field, extra ...string) string {
args := []string{}
for _, field := range fields {
name := lex.Minuscule(field.Name)
if name == "type" {
name = lex.Minuscule(m.Name) + field.Name
}
arg := fmt.Sprintf("%s %s", name, field.Type.Name)
args = append(args, arg)
}
args = append(args, extra...)
return strings.Join(args, ", ")
}
// FieldParams converts the given fields to function parameters, rendering their
// name.
func (m *Mapping) FieldParams(fields []*Field) string {
args := make([]string, len(fields))
for i, field := range fields {
name := lex.Minuscule(field.Name)
if name == "type" {
name = lex.Minuscule(m.Name) + field.Name
}
args[i] = name
}
return strings.Join(args, ", ")
}
// FieldParamsMarshal converts the given fields to function parameters, rendering their
// name. If the field is configured to marshal input/output, the name will be `marshaled{name}`.
func (m *Mapping) FieldParamsMarshal(fields []*Field) string {
args := make([]string, len(fields))
for i, field := range fields {
name := lex.Minuscule(field.Name)
if name == "type" {
name = lex.Minuscule(m.Name) + field.Name
}
if util.IsNeitherFalseNorEmpty(field.Config.Get("marshal")) {
name = fmt.Sprintf("marshaled%s", field.Name)
}
args[i] = name
}
return strings.Join(args, ", ")
}
// ImportType returns the type of the entity for the mapping, prefixing the import package if necessary.
func (m *Mapping) ImportType() string {
name := lex.PascalCase(m.Name)
if m.Local {
return name
}
return m.Package + "." + lex.PascalCase(name)
}
// ImportFilterType returns the Filter type of the entity for the mapping, prefixing the import package if necessary.
func (m *Mapping) ImportFilterType() string {
name := lex.PascalCase(entityFilter(m.Name))
if m.FilterLocal {
return name
}
return m.Package + "." + name
}
// Field holds all information about a field in a Go struct that is relevant
// for database code generation.
type Field struct {
Name string
Type Type
Primary bool // Whether this field is part of the natural primary key.
Config url.Values
}
// Stmt must be used only on a non-columnar field. It returns the name of
// statement that should be used to fetch this field. A statement with that
// name must have been generated for the entity at hand.
func (f *Field) Stmt() string {
switch f.Name {
case "UsedBy":
return "used_by"
default:
return ""
}
}
// IsScalar returns true if the field is a scalar column value from a joined table.
func (f *Field) IsScalar() bool {
return f.joinConfig() != ""
}
// IsIndirect returns true if the field is a scalar column value from a joined
// table that in turn requires another join.
func (f *Field) IsIndirect() bool {
return f.IsScalar() && f.Config.Get("via") != ""
}
// IsPrimary returns true if the field part of the natural key.
func (f *Field) IsPrimary() bool {
return f.Config.Get("primary") != "" || f.Name == "Name"
}
// Column returns the name of the database column the field maps to. The type
// code of the field must be TypeColumn.
func (f *Field) Column() string {
if f.Type.Code != TypeColumn {
panic("attempt to get column name of non-column field")
}
column := lex.SnakeCase(f.Name)
join := f.joinConfig()
if join != "" {
column = fmt.Sprintf("%s AS %s", join, column)
}
return column
}
// SelectColumn returns a column name suitable for use with 'SELECT' statements.
// - Applies a `coalesce()` function if the 'coalesce' tag is present.
// - Returns the column in the form '<joinTable>.<joinColumn> AS <column>' if the `join` tag is present.
func (f *Field) SelectColumn(mapping *Mapping, primaryTable string) (string, error) {
// ReferenceTable and MapTable require specific fields, so parse those instead of checking tags.
if mapping.Type == ReferenceTable || mapping.Type == MapTable {
table := primaryTable
column := fmt.Sprintf("%s.%s", table, lex.SnakeCase(f.Name))
column = strings.ReplaceAll(column, "reference", "%s")
return column, nil
}
tableName, columnName, err := f.SQLConfig()
if err != nil {
return "", err
}
if tableName == "" {
tableName = primaryTable
}
if columnName == "" {
columnName = lex.SnakeCase(f.Name)
}
var column string
join := f.joinConfig()
if join != "" {
column = join
} else {
column = fmt.Sprintf("%s.%s", tableName, columnName)
}
coalesce, ok := f.Config["coalesce"]
if ok {
column = fmt.Sprintf("coalesce(%s, %s)", column, coalesce[0])
}
if join != "" {
column = fmt.Sprintf("%s AS %s", column, columnName)
}
return column, nil
}
// OrderBy returns a column name suitable for use with the 'ORDER BY' clause.
func (f *Field) OrderBy(mapping *Mapping, primaryTable string) (string, error) {
// ReferenceTable and MapTable require specific fields, so parse those instead of checking tags.
if mapping.Type == ReferenceTable || mapping.Type == MapTable {
table := primaryTable
column := fmt.Sprintf("%s.%s", table, lex.SnakeCase(f.Name))
column = strings.ReplaceAll(column, "reference", "%s")
return column, nil
}
if f.IsScalar() {
tableName, _, err := f.ScalarTableColumn()
if err != nil {
return "", err
}
return tableName + ".id", nil
}
tableName, columnName, err := f.SQLConfig()
if err != nil {
return "", nil
}
if columnName == "" {
columnName = lex.SnakeCase(f.Name)
}
if tableName == "" {
tableName = primaryTable
}
if tableName != "" {
return fmt.Sprintf("%s.%s", tableName, columnName), nil
}
return fmt.Sprintf("%s.%s", entityTable(mapping.Name, tableName), columnName), nil
}
// JoinClause returns an SQL 'JOIN' clause using the 'join' and 'joinon' tags, if present.
func (f *Field) JoinClause(mapping *Mapping, table string) (string, error) {
joinTemplate := "\n JOIN %s ON %s = %s.id"
if f.Config.Get("join") != "" && f.Config.Get("leftjoin") != "" {
return "", fmt.Errorf("Cannot join and leftjoin at the same time for field %q of struct %q", f.Name, mapping.Name)
}
join := f.joinConfig()
if f.Config.Get("leftjoin") != "" {
joinTemplate = strings.ReplaceAll(joinTemplate, "JOIN", "LEFT JOIN")
}
joinTable, _, ok := strings.Cut(join, ".")
if !ok {
return "", fmt.Errorf("'join' tag for field %q of struct %q must be of form <table>.<column>", f.Name, mapping.Name)
}
joinOn := f.Config.Get("joinon")
if joinOn == "" {
tableName, columnName, err := f.SQLConfig()
if err != nil {
return "", err
}
if tableName != "" && columnName != "" {
joinOn = fmt.Sprintf("%s.%s", tableName, columnName)
} else {
joinOn = fmt.Sprintf("%s.%s_id", table, lex.Singular(joinTable))
}
}
_, _, ok = strings.Cut(joinOn, ".")
if !ok {
return "", fmt.Errorf("'joinon' tag of field %q of struct %q must be of form '<table>.<column>'", f.Name, mapping.Name)
}
return fmt.Sprintf(joinTemplate, joinTable, joinOn, joinTable), nil
}
// InsertColumn returns a column name and parameter value suitable for an 'INSERT', 'UPDATE', or 'DELETE' statement.
// - If a 'join' tag is present, the package will be searched for the corresponding 'jointableID' registered statement
// to select the ID to insert into this table.
// - If a 'joinon' tag is present, but this table is not among the conditions, then the join will be considered indirect,
// and an empty string will be returned.
func (f *Field) InsertColumn(mapping *Mapping, primaryTable string, defs map[*ast.Ident]types.Object, registeredSQLStmts map[string]string) (string, string, error) {
var column string
var value string
var err error
if f.IsScalar() {
tableName, columnName, err := f.SQLConfig()
if err != nil {
return "", "", err
}
if tableName == "" {
tableName = primaryTable
}
// If there is a 'joinon' tag present without this table in the condition, then assume there is no column for this field.
joinOn := f.Config.Get("joinon")
if joinOn != "" {
before, after, ok := strings.Cut(joinOn, ".")
if !ok {
return "", "", fmt.Errorf("'joinon' tag of field %q of struct %q must be of form '<table>.<column>'", f.Name, mapping.Name)
}
columnName = after
if tableName != before {
return "", "", nil
}
}
table, _, ok := strings.Cut(f.joinConfig(), ".")
if !ok {
return "", "", fmt.Errorf("'join' tag of field %q of struct %q must be of form <table>.<column>", f.Name, mapping.Name)
}
if columnName != "" {
column = columnName
} else {
column = lex.Singular(table) + "_id"
}
varName := stmtCodeVar(lex.Singular(table), "ID")
joinStmt, err := ParseStmt(varName, defs, registeredSQLStmts)
if err != nil {
return "", "", fmt.Errorf("Failed to find registered statement %q for field %q of struct %q: %w", varName, f.Name, mapping.Name, err)
}
value = fmt.Sprintf("(%s)", strings.ReplaceAll(strings.ReplaceAll(joinStmt, "`", ""), "\n", ""))
value = strings.ReplaceAll(value, " ", " ")
} else {
column, err = f.SelectColumn(mapping, primaryTable)
if err != nil {
return "", "", err
}
// Strip the table name and coalesce function if present.
_, column, _ = strings.Cut(column, ".")
column, _, _ = strings.Cut(column, ",")
if mapping.Type == ReferenceTable || mapping.Type == MapTable {
column = strings.ReplaceAll(column, "reference", "%s")
}
value = "?"
}
return column, value, nil
}
func (f *Field) joinConfig() string {
join := f.Config.Get("join")
if join == "" {
join = f.Config.Get("leftjoin")
}
return join
}
// SQLConfig returns the table and column specified by the 'sql' config key, if present.
func (f *Field) SQLConfig() (string, string, error) {
where := f.Config.Get("sql")
if where == "" {
return "", "", nil
}
table, column, ok := strings.Cut(where, ".")
if !ok {
return "", "", fmt.Errorf("'sql' config for field %q should be of the form <table>.<column>", f.Name)
}
return table, column, nil
}
// ScalarTableColumn gets the table and column from the join configuration.
func (f *Field) ScalarTableColumn() (string, string, error) {
join := f.joinConfig()
if join == "" {
return "", "", fmt.Errorf("Missing join config for field %q", f.Name)
}
joinFields := strings.Split(join, ".")
if len(joinFields) != 2 {
return "", "", fmt.Errorf("Join config must be of the format <table>.<column> for field %q", f.Name)
}
return joinFields[0], joinFields[1], nil
}
// FieldNames returns the names of the given fields.
func FieldNames(fields []*Field) []string {
names := []string{}
for _, f := range fields {
names = append(names, f.Name)
}
return names
}
// Type holds all information about a field in a field type that is relevant
// for database code generation.
type Type struct {
Name string
Code int
}
// Possible type code.
const (
TypeColumn = iota
TypeSlice
TypeMap
)
|