1032 lines
34 KiB
HTML
1032 lines
34 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Associations · GORM Guide</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="description" content="">
|
|
<meta name="generator" content="GitBook 3.2.3">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/style.css">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="HandheldFriendly" content="true"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
|
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
|
|
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
|
|
|
|
|
|
<link rel="next" href="associations.html" />
|
|
|
|
|
|
<link rel="prev" href="models.html" />
|
|
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<div class="book">
|
|
<div class="book-summary">
|
|
|
|
|
|
<div id="book-search-input" role="search">
|
|
<input type="text" placeholder="Type to search" />
|
|
</div>
|
|
|
|
|
|
<nav role="navigation">
|
|
|
|
|
|
|
|
<div class="book-summary">
|
|
|
|
<nav role="navigation">
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" data-path="./">
|
|
|
|
<a href="./">
|
|
|
|
|
|
<b>1.1.</b>
|
|
|
|
Getting Started with GORM
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2" data-path="database.html">
|
|
|
|
<a href="database.html">
|
|
|
|
|
|
<b>1.2.</b>
|
|
|
|
Database
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.2.1" data-path="database.html">
|
|
|
|
<a href="database.html#connecting-to-a-database">
|
|
|
|
|
|
<b>1.2.1.</b>
|
|
|
|
Database Connection
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2.2" data-path="database.html">
|
|
|
|
<a href="database.html#migration">
|
|
|
|
|
|
<b>1.2.2.</b>
|
|
|
|
Migration
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3" data-path="models.html">
|
|
|
|
<a href="models.html">
|
|
|
|
|
|
<b>1.3.</b>
|
|
|
|
Models
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.3.1" data-path="models.html">
|
|
|
|
<a href="models.html#model-definition">
|
|
|
|
|
|
<b>1.3.1.</b>
|
|
|
|
Model Definition
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.2" data-path="models.html">
|
|
|
|
<a href="models.html#conventions">
|
|
|
|
|
|
<b>1.3.2.</b>
|
|
|
|
Conventions & Overriding
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="1.3.3" data-path="associations.html">
|
|
|
|
<a href="associations.html">
|
|
|
|
|
|
<b>1.3.3.</b>
|
|
|
|
Associations
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.3.3.1" data-path="associations.html">
|
|
|
|
<a href="associations.html#belongs-to">
|
|
|
|
|
|
<b>1.3.3.1.</b>
|
|
|
|
Belongs To
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.3.2" data-path="associations.html">
|
|
|
|
<a href="associations.html#has-one">
|
|
|
|
|
|
<b>1.3.3.2.</b>
|
|
|
|
Has One
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.3.3" data-path="associations.html">
|
|
|
|
<a href="associations.html#has-many">
|
|
|
|
|
|
<b>1.3.3.3.</b>
|
|
|
|
Has Many
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.3.4" data-path="associations.html">
|
|
|
|
<a href="associations.html#many-to-many">
|
|
|
|
|
|
<b>1.3.3.4.</b>
|
|
|
|
Many To Many
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.3.5" data-path="associations.html">
|
|
|
|
<a href="associations.html#polymorphism">
|
|
|
|
|
|
<b>1.3.3.5.</b>
|
|
|
|
Polymorphism
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.3.6" data-path="associations.html">
|
|
|
|
<a href="associations.html#association-mode">
|
|
|
|
|
|
<b>1.3.3.6.</b>
|
|
|
|
Association Mode
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.4" data-path="dialects.html">
|
|
|
|
<a href="dialects.html#dialect-data-type">
|
|
|
|
|
|
<b>1.3.4.</b>
|
|
|
|
Dialect Specific Data Type
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4" data-path="crud.html">
|
|
|
|
<a href="crud.html">
|
|
|
|
|
|
<b>1.4.</b>
|
|
|
|
CRUD: Reading and Writing Data
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.1" data-path="crud.html">
|
|
|
|
<a href="crud.html#create">
|
|
|
|
|
|
<b>1.4.1.</b>
|
|
|
|
Create
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.2" data-path="crud.html">
|
|
|
|
<a href="crud.html#query">
|
|
|
|
|
|
<b>1.4.2.</b>
|
|
|
|
Query
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.3" data-path="crud.html">
|
|
|
|
<a href="crud.html#preloading-eager-loading">
|
|
|
|
|
|
<b>1.4.3.</b>
|
|
|
|
Preloading (Eager Loading)
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.4" data-path="crud.html">
|
|
|
|
<a href="crud.html#update">
|
|
|
|
|
|
<b>1.4.4.</b>
|
|
|
|
Update
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.5" data-path="crud.html">
|
|
|
|
<a href="crud.html#delete">
|
|
|
|
|
|
<b>1.4.5.</b>
|
|
|
|
Delete / Soft Delete
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4.6" data-path="crud.html">
|
|
|
|
<a href="crud.html#associations">
|
|
|
|
|
|
<b>1.4.6.</b>
|
|
|
|
Associations
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.5" data-path="callbacks.html">
|
|
|
|
<a href="callbacks.html">
|
|
|
|
|
|
<b>1.5.</b>
|
|
|
|
Callbacks
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6" data-path="advanced.html">
|
|
|
|
<a href="advanced.html">
|
|
|
|
|
|
<b>1.6.</b>
|
|
|
|
Advanced Usage
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.6.1" data-path="advanced.html">
|
|
|
|
<a href="advanced.html#error-handling">
|
|
|
|
|
|
<b>1.6.1.</b>
|
|
|
|
Error Handling
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6.2" data-path="advanced.html">
|
|
|
|
<a href="advanced.html#transactions">
|
|
|
|
|
|
<b>1.6.2.</b>
|
|
|
|
Transactions
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6.3" data-path="advanced.html">
|
|
|
|
<a href="advanced.html#sql-builder">
|
|
|
|
|
|
<b>1.6.3.</b>
|
|
|
|
Raw SQL & SQL Builder
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6.4" data-path="advanced.html">
|
|
|
|
<a href="advanced.html#generic-database-interface-sqldb">
|
|
|
|
|
|
<b>1.6.4.</b>
|
|
|
|
Generic database interface sql.DB
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6.5" data-path="advanced.html">
|
|
|
|
<a href="advanced.html#compose-primary-key">
|
|
|
|
|
|
<b>1.6.5.</b>
|
|
|
|
Composite Primary Key
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.6.6" data-path="advanced.html">
|
|
|
|
<a href="advanced.html#logger">
|
|
|
|
|
|
<b>1.6.6.</b>
|
|
|
|
Overriding Logger
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.7" data-path="development.html">
|
|
|
|
<a href="development.html">
|
|
|
|
|
|
<b>1.7.</b>
|
|
|
|
Development
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.7.1" data-path="development.html">
|
|
|
|
<a href="development.html#architecture">
|
|
|
|
|
|
<b>1.7.1.</b>
|
|
|
|
Architecture
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.7.2" data-path="development.html">
|
|
|
|
<a href="development.html#write-plugins">
|
|
|
|
|
|
<b>1.7.2.</b>
|
|
|
|
Write Plugins
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.8" data-path="changelog.html">
|
|
|
|
<a href="changelog.html">
|
|
|
|
|
|
<b>1.8.</b>
|
|
|
|
Change Log
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="book-body">
|
|
|
|
<div class="body-inner">
|
|
|
|
|
|
|
|
<div class="book-header" role="navigation">
|
|
|
|
|
|
<!-- Title -->
|
|
<h1>
|
|
<i class="fa fa-circle-o-notch fa-spin"></i>
|
|
<a href="." >Associations</a>
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="page-wrapper" tabindex="-1" role="main">
|
|
<div class="page-inner">
|
|
|
|
<div id="book-search-results">
|
|
<div class="search-noresults">
|
|
|
|
<section class="normal markdown-section">
|
|
|
|
<h1 id="associations">Associations</h1>
|
|
<!-- toc -->
|
|
<h2 id="belongs-to">Belongs To</h2>
|
|
<pre><code class="lang-go"><span class="hljs-comment">// `User` belongs to `Profile`, `ProfileID` is the foreign key</span>
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Profile Profile
|
|
ProfileID <span class="hljs-keyword">int</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> Profile <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Name <span class="hljs-keyword">string</span>
|
|
}
|
|
|
|
db.Model(&user).Related(&profile)
|
|
<span class="hljs-comment">//// SELECT * FROM profiles WHERE id = 111; // 111 is user's foreign key ProfileID</span>
|
|
</code></pre>
|
|
<p><em>Specify Foreign Key</em></p>
|
|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> Profile <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Name <span class="hljs-keyword">string</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Profile Profile <span class="hljs-string">`gorm:"foreignkey:ProfileRefer"`</span> <span class="hljs-comment">// use ProfileRefer as foreign key</span>
|
|
ProfileRefer <span class="hljs-keyword">uint</span>
|
|
}
|
|
</code></pre>
|
|
<p><em>Specify Foreign Key & Association Key</em></p>
|
|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> Profile <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Refer <span class="hljs-keyword">int</span>
|
|
Name <span class="hljs-keyword">string</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Profile Profile <span class="hljs-string">`gorm:"foreignkey:ProfileID;association_foreignkey:Refer"`</span>
|
|
ProfileID <span class="hljs-keyword">int</span>
|
|
}
|
|
</code></pre>
|
|
<h2 id="has-one">Has One</h2>
|
|
<pre><code class="lang-go"><span class="hljs-comment">// User has one CreditCard, UserID is the foreign key</span>
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
CreditCard CreditCard
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> CreditCard <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
UserID <span class="hljs-keyword">uint</span>
|
|
Number <span class="hljs-keyword">string</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">var</span> card CreditCard
|
|
db.Model(&user).Related(&card, <span class="hljs-string">"CreditCard"</span>)
|
|
<span class="hljs-comment">//// SELECT * FROM credit_cards WHERE user_id = 123; // 123 is user's primary key</span>
|
|
<span class="hljs-comment">// CreditCard is user's field name, it means get user's CreditCard relations and fill it into variable card</span>
|
|
<span class="hljs-comment">// If the field name is same as the variable's type name, like above example, it could be omitted, like:</span>
|
|
db.Model(&user).Related(&card)
|
|
</code></pre>
|
|
<p><em>Specify Foreign Key</em></p>
|
|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> Profile <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Name <span class="hljs-keyword">string</span>
|
|
UserRefer <span class="hljs-keyword">uint</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Profile Profile <span class="hljs-string">`gorm:"foreignkey:UserRefer"`</span>
|
|
}
|
|
</code></pre>
|
|
<p><em>Specify Foreign Key & Association Key</em></p>
|
|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> Profile <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Name <span class="hljs-keyword">string</span>
|
|
UserID <span class="hljs-keyword">uint</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Refer <span class="hljs-keyword">uint</span>
|
|
Profile Profile <span class="hljs-string">`gorm:"foreignkey:UserID;association_foreignkey:Refer"`</span>
|
|
}
|
|
</code></pre>
|
|
<h2 id="has-many">Has Many</h2>
|
|
<pre><code class="lang-go"><span class="hljs-comment">// User has many emails, UserID is the foreign key</span>
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Emails []Email
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> Email <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Email <span class="hljs-keyword">string</span>
|
|
UserID <span class="hljs-keyword">uint</span>
|
|
}
|
|
|
|
db.Model(&user).Related(&emails)
|
|
<span class="hljs-comment">//// SELECT * FROM emails WHERE user_id = 111; // 111 is user's primary key</span>
|
|
</code></pre>
|
|
<p><em>Specify Foreign Key</em></p>
|
|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> Profile <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Name <span class="hljs-keyword">string</span>
|
|
UserRefer <span class="hljs-keyword">uint</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Profiles []Profile <span class="hljs-string">`gorm:"foreignkey:UserRefer"`</span>
|
|
}
|
|
</code></pre>
|
|
<p><em>Specify Foreign Key & Association Key</em></p>
|
|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> Profile <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Name <span class="hljs-keyword">string</span>
|
|
UserID <span class="hljs-keyword">uint</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Refer <span class="hljs-keyword">uint</span>
|
|
Profiles []Profile <span class="hljs-string">`gorm:"foreignkey:UserID;association_foreignkey:Refer"`</span>
|
|
}
|
|
</code></pre>
|
|
<h2 id="many-to-many">Many To Many</h2>
|
|
<pre><code class="lang-go"><span class="hljs-comment">// User has and belongs to many languages, use `user_languages` as join table</span>
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Languages []Language <span class="hljs-string">`gorm:"many2many:user_languages;"`</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> Language <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Name <span class="hljs-keyword">string</span>
|
|
}
|
|
|
|
db.Model(&user).Related(&languages, <span class="hljs-string">"Languages"</span>)
|
|
<span class="hljs-comment">//// SELECT * FROM "languages" INNER JOIN "user_languages" ON "user_languages"."language_id" = "languages"."id" WHERE "user_languages"."user_id" = 111</span>
|
|
|
|
db.Preload(<span class="hljs-string">"Languages"</span>).First(&user)
|
|
</code></pre>
|
|
<p><em>With back-reference :</em></p>
|
|
<pre><code class="lang-go"><span class="hljs-comment">// User has and belongs to many languages, use `user_languages` as join table</span>
|
|
<span class="hljs-comment">// Make sure the two models are in different files</span>
|
|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Languages []Language <span class="hljs-string">`gorm:"many2many:user_languages;"`</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> Language <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Name <span class="hljs-keyword">string</span>
|
|
Users []User <span class="hljs-string">`gorm:"many2many:user_languages;"`</span>
|
|
}
|
|
|
|
db.Model(&language).Related(&users)
|
|
<span class="hljs-comment">//// SELECT * FROM "users" INNER JOIN "user_languages" ON "user_languages"."user_id" = "users"."id" WHERE ("user_languages"."language_id" IN ('111'))</span>
|
|
</code></pre>
|
|
<p><em>Specify Foreign Key & Association Key</em></p>
|
|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> CustomizePerson <span class="hljs-keyword">struct</span> {
|
|
IdPerson <span class="hljs-keyword">string</span> <span class="hljs-string">`gorm:"primary_key:true"`</span>
|
|
Accounts []CustomizeAccount <span class="hljs-string">`gorm:"many2many:PersonAccount;association_foreignkey:idAccount;foreignkey:idPerson"`</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> CustomizeAccount <span class="hljs-keyword">struct</span> {
|
|
IdAccount <span class="hljs-keyword">string</span> <span class="hljs-string">`gorm:"primary_key:true"`</span>
|
|
Name <span class="hljs-keyword">string</span>
|
|
}
|
|
</code></pre>
|
|
<p>It will create a many2many relationship for those two structs, and their relations will be saved into join table <code>PersonAccount</code> with foreign keys <code>customize_person_id_person</code> AND <code>customize_account_id_account</code></p>
|
|
<p><em>Specify jointable's foreign key</em></p>
|
|
<p>If you want to change join table's foreign keys, you could use tag <code>association_jointable_foreignkey</code>, <code>jointable_foreignkey</code></p>
|
|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> CustomizePerson <span class="hljs-keyword">struct</span> {
|
|
IdPerson <span class="hljs-keyword">string</span> <span class="hljs-string">`gorm:"primary_key:true"`</span>
|
|
Accounts []CustomizeAccount <span class="hljs-string">`gorm:"many2many:PersonAccount;foreignkey:idPerson;association_foreignkey:idAccount;association_jointable_foreignkey:account_id;jointable_foreignkey:person_id;"`</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> CustomizeAccount <span class="hljs-keyword">struct</span> {
|
|
IdAccount <span class="hljs-keyword">string</span> <span class="hljs-string">`gorm:"primary_key:true"`</span>
|
|
Name <span class="hljs-keyword">string</span>
|
|
}
|
|
</code></pre>
|
|
<h3 id="self-referencing-many-to-many-relationship">Self-Referencing Many To Many Relationship</h3>
|
|
<p>To define a self-referencing many2many relationship, you have to change association's foreign key in the join table.</p>
|
|
<p>to make it different with source's foreign key, which is generated using struct's name and its priamry key, for example:</p>
|
|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
|
|
gorm.Model
|
|
Friends []*User <span class="hljs-string">`gorm:"many2many:friendships;association_jointable_foreignkey:friend_id"`</span>
|
|
}
|
|
</code></pre>
|
|
<p>GORM will create a join table with foreign key <code>user_id</code> and <code>friend_id</code>, and use it to save user's self-reference relationship.</p>
|
|
<p>Then you can operate it like normal relations, e.g:</p>
|
|
<pre><code class="lang-go">DB.Preload(<span class="hljs-string">"Friends"</span>).First(&user, <span class="hljs-string">"id = ?"</span>, <span class="hljs-number">1</span>)
|
|
|
|
DB.Model(&user).Association(<span class="hljs-string">"Friends"</span>).Append(&User{Name: <span class="hljs-string">"friend1"</span>}, &User{Name: <span class="hljs-string">"friend2"</span>})
|
|
|
|
DB.Model(&user).Association(<span class="hljs-string">"Friends"</span>).Delete(&User{Name: <span class="hljs-string">"friend2"</span>})
|
|
|
|
DB.Model(&user).Association(<span class="hljs-string">"Friends"</span>).Replace(&User{Name: <span class="hljs-string">"new friend"</span>})
|
|
|
|
DB.Model(&user).Association(<span class="hljs-string">"Friends"</span>).Clear()
|
|
|
|
DB.Model(&user).Association(<span class="hljs-string">"Friends"</span>).Count()
|
|
</code></pre>
|
|
<h2 id="polymorphism">Polymorphism</h2>
|
|
<p>Supports polymorphic has-many and has-one associations.</p>
|
|
<pre><code class="lang-go"> <span class="hljs-keyword">type</span> Cat <span class="hljs-keyword">struct</span> {
|
|
Id <span class="hljs-keyword">int</span>
|
|
Name <span class="hljs-keyword">string</span>
|
|
Toy Toy <span class="hljs-string">`gorm:"polymorphic:Owner;"`</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> Dog <span class="hljs-keyword">struct</span> {
|
|
Id <span class="hljs-keyword">int</span>
|
|
Name <span class="hljs-keyword">string</span>
|
|
Toy Toy <span class="hljs-string">`gorm:"polymorphic:Owner;"`</span>
|
|
}
|
|
|
|
<span class="hljs-keyword">type</span> Toy <span class="hljs-keyword">struct</span> {
|
|
Id <span class="hljs-keyword">int</span>
|
|
Name <span class="hljs-keyword">string</span>
|
|
OwnerId <span class="hljs-keyword">int</span>
|
|
OwnerType <span class="hljs-keyword">string</span>
|
|
}
|
|
</code></pre>
|
|
<p>Note: polymorphic belongs-to and many-to-many are explicitly NOT supported, and will throw errors.</p>
|
|
<h2 id="association-mode">Association Mode</h2>
|
|
<p>Association Mode contains some helper methods to handle relationship things easily.</p>
|
|
<pre><code class="lang-go"><span class="hljs-comment">// Start Association Mode</span>
|
|
<span class="hljs-keyword">var</span> user User
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>)
|
|
<span class="hljs-comment">// `user` is the source, it need to be a valid record (contains primary key)</span>
|
|
<span class="hljs-comment">// `Languages` is source's field name for a relationship.</span>
|
|
<span class="hljs-comment">// If those conditions not matched, will return an error, check it with:</span>
|
|
<span class="hljs-comment">// db.Model(&user).Association("Languages").Error</span>
|
|
|
|
|
|
<span class="hljs-comment">// Query - Find out all related associations</span>
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>).Find(&languages)
|
|
|
|
|
|
<span class="hljs-comment">// Append - Append new associations for many2many, has_many, will replace current association for has_one, belongs_to</span>
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>).Append([]Language{languageZH, languageEN})
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>).Append(Language{Name: <span class="hljs-string">"DE"</span>})
|
|
|
|
|
|
<span class="hljs-comment">// Delete - Remove relationship between source & passed arguments, won't delete those arguments</span>
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>).Delete([]Language{languageZH, languageEN})
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>).Delete(languageZH, languageEN)
|
|
|
|
|
|
<span class="hljs-comment">// Replace - Replace current associations with new one</span>
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>).Replace([]Language{languageZH, languageEN})
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>).Replace(Language{Name: <span class="hljs-string">"DE"</span>}, languageEN)
|
|
|
|
|
|
<span class="hljs-comment">// Count - Return the count of current associations</span>
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>).Count()
|
|
|
|
|
|
<span class="hljs-comment">// Clear - Remove relationship between source & current associations, won't delete those associations</span>
|
|
db.Model(&user).Association(<span class="hljs-string">"Languages"</span>).Clear()
|
|
</code></pre>
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
<div class="search-results">
|
|
<div class="has-results">
|
|
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
|
|
</div>
|
|
<div class="no-results">
|
|
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<a href="models.html#conventions" class="navigation navigation-prev " aria-label="Previous page: Conventions & Overriding">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="associations.html#belongs-to" class="navigation navigation-next " aria-label="Next page: Belongs To">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Associations","level":"1.3.3","depth":2,"next":{"title":"Belongs To","level":"1.3.3.1","depth":3,"anchor":"#belongs-to","path":"associations.md","ref":"associations.md#belongs-to","articles":[]},"previous":{"title":"Conventions & Overriding","level":"1.3.2","depth":2,"anchor":"#conventions","path":"models.md","ref":"models.md#conventions","articles":[]},"dir":"ltr"},"config":{"plugins":["github","edit-link"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"fontsettings":{"theme":"night","family":"sans","size":2},"github":{"url":"https://github.com/jinzhu/gorm"},"edit-link":{"label":"Edit This Page","base":"https://github.com/jinzhu/gorm/edit/gh-pages/documents/"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"GORM Guide","gitbook":"*"},"file":{"path":"associations.md","mtime":"2018-02-12T02:57:36.244Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-02-12T03:02:46.423Z"},"basePath":".","book":{"language":""}});
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
<script src="gitbook/gitbook.js"></script>
|
|
<script src="gitbook/theme.js"></script>
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-github/plugin.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-edit-link/plugin.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-search/search.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
|
|
|
|
|
|
|
|
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|