How to create foreign keys in gorm?

In GORM, creating foreign keys primarily involves two steps: defining models and using tags to specify foreign key relationships. Here, I will detail how to perform these two steps and provide a concrete example.

Step 1: Defining Models

First, you need to define your data models. In Go, models are typically defined as structs. Assume we have two models: User and Profile, where Profile is associated with User.

go
type User struct {
    gorm.Model
    Name     string
    Profile  Profile
}

type Profile struct {
    gorm.Model
    UserID  uint // foreign key
    Address string
}

In this example, the UserID field in the Profile struct serves as the foreign key, linking Profile to the User model.

Step 2: Using Tags to Specify Foreign Key Relationships

When defining model fields, you can use GORM tags to specify foreign key relationships. In GORM, the ForeignKey tag identifies which field acts as the foreign key, while the References tag specifies which field in the main table the foreign key references. If not explicitly defined, GORM defaults to using the primary key of the main table (typically ID) as the referenced field.

In the User and Profile example, to explicitly define the foreign key relationship, modify the User struct as follows:

go
type User struct {
    gorm.Model
    Name     string
    Profile  Profile `gorm:"foreignKey:UserID"`
}

Here, the foreignKey:UserID tag instructs GORM that the UserID field in Profile should be used as the foreign key connecting User and Profile.

Creating and Migrating the Database

After defining models and specifying foreign key relationships, you can use GORM's migration tool to create database tables. For example:

go
db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
if err != nil {
    panic("failed to connect database")
}

// Auto-migration mode
db.AutoMigrate(&User{}, &Profile{})

This code automatically creates or updates database tables based on your model definitions, correctly implementing foreign key constraints.

Summary

By following these steps, you can effectively create and manage foreign keys in GORM. This not only ensures data integrity but also optimizes query efficiency through foreign key relationships. In practical project development, properly designing database models and their relationships is essential for building more stable and efficient applications.