914 lines
		
	
	
		
			27 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			914 lines
		
	
	
		
			27 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!DOCTYPE HTML>
 | 
						|
<html lang="" >
 | 
						|
    <head>
 | 
						|
        <title>Associations · GORM Guide</title>
 | 
						|
        <meta charset="UTF-8">
 | 
						|
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
 | 
						|
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
 | 
						|
        <meta name="description" content="Specify Foreign Key">
 | 
						|
        <meta name="generator" content="GitBook 3.0.0-pre.5">
 | 
						|
        
 | 
						|
        
 | 
						|
        
 | 
						|
    
 | 
						|
    <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"
 | 
						|
    data-level="2.3"
 | 
						|
    data-chapter-title="Associations"
 | 
						|
    data-filepath="associations.md"
 | 
						|
    data-basepath="."
 | 
						|
    data-revision="Wed Mar 23 2016 07:30:36 GMT+0800 (CST)"
 | 
						|
    data-innerlanguage="">
 | 
						|
    
 | 
						|
 | 
						|
<div class="book-summary">
 | 
						|
    
 | 
						|
    <nav role="navigation">
 | 
						|
        <ul class="summary">
 | 
						|
            
 | 
						|
            
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="0" data-path="./">
 | 
						|
            
 | 
						|
                <a href="./">
 | 
						|
            
 | 
						|
                    
 | 
						|
                    Getting Started with GORM
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="1" data-path="database.html">
 | 
						|
            
 | 
						|
                <a href="database.html">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>1.</b>
 | 
						|
                    
 | 
						|
                    Database
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
            <ul class="articles">
 | 
						|
                
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="1.1" data-path="database.html">
 | 
						|
            
 | 
						|
                <a href="database.html#connecting-to-a-database">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>1.1.</b>
 | 
						|
                    
 | 
						|
                    Database Connection
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="1.2" data-path="database.html">
 | 
						|
            
 | 
						|
                <a href="database.html#migration">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>1.2.</b>
 | 
						|
                    
 | 
						|
                    Migration
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
 | 
						|
            </ul>
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="2" data-path="models.html">
 | 
						|
            
 | 
						|
                <a href="models.html">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.</b>
 | 
						|
                    
 | 
						|
                    Models
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
            <ul class="articles">
 | 
						|
                
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="2.1" data-path="models.html">
 | 
						|
            
 | 
						|
                <a href="models.html#model-definition">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.1.</b>
 | 
						|
                    
 | 
						|
                    Model Definition
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="2.2" data-path="models.html">
 | 
						|
            
 | 
						|
                <a href="models.html#conventions">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.2.</b>
 | 
						|
                    
 | 
						|
                    Conventions & Overriding
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter active" data-level="2.3" data-path="associations.html">
 | 
						|
            
 | 
						|
                <a href="associations.html">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.3.</b>
 | 
						|
                    
 | 
						|
                    Associations
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
            <ul class="articles">
 | 
						|
                
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="2.3.1" data-path="associations.html">
 | 
						|
            
 | 
						|
                <a href="associations.html#belongs-to">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.3.1.</b>
 | 
						|
                    
 | 
						|
                    Belongs To
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="2.3.2" data-path="associations.html">
 | 
						|
            
 | 
						|
                <a href="associations.html#has-one">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.3.2.</b>
 | 
						|
                    
 | 
						|
                    Has One
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="2.3.3" data-path="associations.html">
 | 
						|
            
 | 
						|
                <a href="associations.html#has-many">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.3.3.</b>
 | 
						|
                    
 | 
						|
                    Has Many
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="2.3.4" data-path="associations.html">
 | 
						|
            
 | 
						|
                <a href="associations.html#many-to-many">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.3.4.</b>
 | 
						|
                    
 | 
						|
                    Many To Many
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="2.3.5" data-path="associations.html">
 | 
						|
            
 | 
						|
                <a href="associations.html#polymorphism">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.3.5.</b>
 | 
						|
                    
 | 
						|
                    Polymorphism
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="2.3.6" data-path="associations.html">
 | 
						|
            
 | 
						|
                <a href="associations.html#association-mode">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.3.6.</b>
 | 
						|
                    
 | 
						|
                    Association Mode
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
 | 
						|
            </ul>
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
 | 
						|
            </ul>
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="3" data-path="curd.html">
 | 
						|
            
 | 
						|
                <a href="curd.html">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>3.</b>
 | 
						|
                    
 | 
						|
                    CRUD: Reading and Writing Data
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
            <ul class="articles">
 | 
						|
                
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="3.1" data-path="curd.html">
 | 
						|
            
 | 
						|
                <a href="curd.html#create">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>3.1.</b>
 | 
						|
                    
 | 
						|
                    Create
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="3.2" data-path="curd.html">
 | 
						|
            
 | 
						|
                <a href="curd.html#query">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>3.2.</b>
 | 
						|
                    
 | 
						|
                    Query
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="3.3" data-path="curd.html">
 | 
						|
            
 | 
						|
                <a href="curd.html#preloading-eager-loading">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>3.3.</b>
 | 
						|
                    
 | 
						|
                    Preloading (Eager Loading)
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="3.4" data-path="curd.html">
 | 
						|
            
 | 
						|
                <a href="curd.html#update">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>3.4.</b>
 | 
						|
                    
 | 
						|
                    Update
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="3.5" data-path="curd.html">
 | 
						|
            
 | 
						|
                <a href="curd.html#delete">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>3.5.</b>
 | 
						|
                    
 | 
						|
                    Delete / Soft Delete
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
 | 
						|
            </ul>
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="4" data-path="callbacks.html">
 | 
						|
            
 | 
						|
                <a href="callbacks.html">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>4.</b>
 | 
						|
                    
 | 
						|
                    Callbacks
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="5" data-path="advanced.html">
 | 
						|
            
 | 
						|
                <a href="advanced.html">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>5.</b>
 | 
						|
                    
 | 
						|
                    Advanced Usage
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
            <ul class="articles">
 | 
						|
                
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="5.1" data-path="advanced.html">
 | 
						|
            
 | 
						|
                <a href="advanced.html#error-handling">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>5.1.</b>
 | 
						|
                    
 | 
						|
                    Error Handling
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="5.2" data-path="advanced.html">
 | 
						|
            
 | 
						|
                <a href="advanced.html#transactions">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>5.2.</b>
 | 
						|
                    
 | 
						|
                    Transactions
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="5.3" data-path="advanced.html">
 | 
						|
            
 | 
						|
                <a href="advanced.html#sql-builder">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>5.3.</b>
 | 
						|
                    
 | 
						|
                    Raw SQL & SQL Builder
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="5.4" data-path="advanced.html">
 | 
						|
            
 | 
						|
                <a href="advanced.html#generic-database-interface-sqldb">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>5.4.</b>
 | 
						|
                    
 | 
						|
                    Generic database interface sql.DB
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="5.5" data-path="advanced.html">
 | 
						|
            
 | 
						|
                <a href="advanced.html#compose-primary-key">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>5.5.</b>
 | 
						|
                    
 | 
						|
                    Composite Primary Key
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="5.6" data-path="advanced.html">
 | 
						|
            
 | 
						|
                <a href="advanced.html#logger">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>5.6.</b>
 | 
						|
                    
 | 
						|
                    Overriding Logger
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
 | 
						|
            </ul>
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="6" data-path="development.html">
 | 
						|
            
 | 
						|
                <a href="development.html">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>6.</b>
 | 
						|
                    
 | 
						|
                    Development
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
            <ul class="articles">
 | 
						|
                
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="6.1" data-path="development.html">
 | 
						|
            
 | 
						|
                <a href="development.html#architecture">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>6.1.</b>
 | 
						|
                    
 | 
						|
                    Architecture
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="6.2" data-path="development.html">
 | 
						|
            
 | 
						|
                <a href="development.html#write-plugins">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>6.2.</b>
 | 
						|
                    
 | 
						|
                    Write Plugins
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
 | 
						|
            </ul>
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
        <li class="chapter " data-level="7" data-path="changelog.html">
 | 
						|
            
 | 
						|
                <a href="changelog.html">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>7.</b>
 | 
						|
                    
 | 
						|
                    Change Log
 | 
						|
            
 | 
						|
                </a>
 | 
						|
            
 | 
						|
 | 
						|
            
 | 
						|
        </li>
 | 
						|
    
 | 
						|
 | 
						|
            <li class="divider"></li>
 | 
						|
            
 | 
						|
        </ul>
 | 
						|
    </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">
 | 
						|
                            <section class="normal markdown-section">
 | 
						|
                            
 | 
						|
                            <h1 id="associations">Associations</h1>
 | 
						|
<!-- toc -->
 | 
						|
<ul>
 | 
						|
<li><a href="#belongs-to">Belongs To</a></li>
 | 
						|
<li><a href="#has-one">Has One</a></li>
 | 
						|
<li><a href="#has-many">Has Many</a></li>
 | 
						|
<li><a href="#many-to-many">Many To Many</a></li>
 | 
						|
<li><a href="#polymorphism">Polymorphism</a></li>
 | 
						|
<li><a href="#association-mode">Association Mode</a></li>
 | 
						|
</ul>
 | 
						|
<!-- toc stop -->
 | 
						|
<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">int</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">string</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;AssociationForeignKey: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">string</span>
 | 
						|
  Profile Profile <span class="hljs-string">`gorm:"ForeignKey:UserID;AssociationForeignKey: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
 | 
						|
  Profile []Profiles <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">string</span>
 | 
						|
  Profile []Profiles <span class="hljs-string">`gorm:"ForeignKey:UserID;AssociationForeignKey: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-comment">//// SELECT * FROM "languages" INNER JOIN "user_languages" ON "user_languages"."language_id" = "languages"."id" WHERE "user_languages"."user_id" = 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;AssociationForeignKey: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>
 | 
						|
<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>
 | 
						|
                
 | 
						|
            </div>
 | 
						|
 | 
						|
            
 | 
						|
                
 | 
						|
                <a href="models.html" class="navigation navigation-prev " aria-label="Previous page: Conventions & Overriding">
 | 
						|
                    <i class="fa fa-angle-left"></i>
 | 
						|
                </a>
 | 
						|
                
 | 
						|
                
 | 
						|
                <a href="associations.html" class="navigation navigation-next " aria-label="Next page: Belongs To">
 | 
						|
                    <i class="fa fa-angle-right"></i>
 | 
						|
                </a>
 | 
						|
                
 | 
						|
            
 | 
						|
        
 | 
						|
    </div>
 | 
						|
</div>
 | 
						|
 | 
						|
        
 | 
						|
    <script src="gitbook/app.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-anker-enable/anker.js"></script>
 | 
						|
        
 | 
						|
    
 | 
						|
        
 | 
						|
        <script src="gitbook/gitbook-plugin-search/lunr.min.js"></script>
 | 
						|
        
 | 
						|
    
 | 
						|
        
 | 
						|
        <script src="gitbook/gitbook-plugin-search/search.js"></script>
 | 
						|
        
 | 
						|
    
 | 
						|
        
 | 
						|
        <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
 | 
						|
        
 | 
						|
    
 | 
						|
        
 | 
						|
        <script src="gitbook/gitbook-plugin-fontsettings/buttons.js"></script>
 | 
						|
        
 | 
						|
    
 | 
						|
    <script>
 | 
						|
    require(["gitbook"], function(gitbook) {
 | 
						|
        gitbook.start({"fontsettings":{"theme":"night","size":2,"family":"sans"},"toc":{"addClass":true,"className":"toc"},"github":{"url":"https://github.com/jinzhu/gorm"},"edit-link":{"base":"https://github.com/jinzhu/gorm/edit/gh-pages/documents/","label":"Edit This Page"},"anker-enable":{},"highlight":{},"search":{"maxIndexSize":1000000},"sharing":{"all":["facebook","google","instapaper","twitter","weibo"],"facebook":true,"google":false,"instapaper":false,"twitter":true,"vk":false,"weibo":false},"theme-default":{"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"}}});
 | 
						|
    });
 | 
						|
    </script>
 | 
						|
 | 
						|
    </body>
 | 
						|
</html>
 |