839 lines
		
	
	
		
			27 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			839 lines
		
	
	
		
			27 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!DOCTYPE HTML>
 | 
						|
<html lang="" >
 | 
						|
    <head>
 | 
						|
        <title>Models · 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="Base model definition gorm.Model, including fields ID, CreatedAt, UpdatedAt, DeletedAt, you could embed it in your model, or only write those fields you wa">
 | 
						|
        <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="models.html" />
 | 
						|
    
 | 
						|
    
 | 
						|
    <link rel="prev" href="database.html" />
 | 
						|
    
 | 
						|
 | 
						|
    </head>
 | 
						|
    <body>
 | 
						|
        
 | 
						|
<div class="book"
 | 
						|
    data-level="2"
 | 
						|
    data-chapter-title="Models"
 | 
						|
    data-filepath="models.md"
 | 
						|
    data-basepath="."
 | 
						|
    data-revision="Wed Mar 09 2016 07:36:05 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 active" 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-defination">
 | 
						|
            
 | 
						|
                    
 | 
						|
                        <b>2.1.</b>
 | 
						|
                    
 | 
						|
                    Model Defination
 | 
						|
            
 | 
						|
                </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 " 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="." >Models</a>
 | 
						|
    </h1>
 | 
						|
</div>
 | 
						|
 | 
						|
 | 
						|
 | 
						|
                    <div class="page-wrapper" tabindex="-1" role="main">
 | 
						|
                        <div class="page-inner">
 | 
						|
                            <section class="normal markdown-section">
 | 
						|
                            
 | 
						|
                            <h1 id="models">Models</h1>
 | 
						|
<!-- toc -->
 | 
						|
<ul>
 | 
						|
<li><a href="#model-defination">Model Defination</a></li>
 | 
						|
<li><a href="#conventions">Conventions</a><ul>
 | 
						|
<li><a href="#gormmodel-struct"><code>gorm.Model</code> struct</a></li>
 | 
						|
<li><a href="#table-name-is-the-pluralized-version-of-struct-name">Table name is the pluralized version of struct name</a></li>
 | 
						|
<li><a href="#column-name-is-the-snake-case-of-fields-name">Column name is the snake case of field's name</a></li>
 | 
						|
<li><a href="#field-id-as-primary-key">Field <code>ID</code> as primary key</a></li>
 | 
						|
<li><a href="#field-createdat-used-to-store-records-created-time">Field <code>CreatedAt</code> used to store record's created time</a></li>
 | 
						|
<li><a href="#use-updatedat-used-to-store-records-updated-time">Use <code>UpdatedAt</code> used to store record's updated time</a></li>
 | 
						|
<li><a href="#use-deletedat-to-store-records-deleted-time-if-field-exists">Use <code>DeletedAt</code> to store record's deleted time if field exists</a></li>
 | 
						|
</ul>
 | 
						|
</li>
 | 
						|
</ul>
 | 
						|
<!-- toc stop -->
 | 
						|
<h2 id="model-defination">Model Defination</h2>
 | 
						|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
 | 
						|
    gorm.Model
 | 
						|
    Birthday     time.Time
 | 
						|
    Age          <span class="hljs-keyword">int</span>
 | 
						|
    Name         <span class="hljs-keyword">string</span>  <span class="hljs-string">`gorm:"size:255"`</span> <span class="hljs-comment">// Default size for string is 255, reset it with this tag</span>
 | 
						|
    Num          <span class="hljs-keyword">int</span>     <span class="hljs-string">`gorm:"AUTO_INCREMENT"`</span>
 | 
						|
 | 
						|
    CreditCard        CreditCard      <span class="hljs-comment">// One-To-One relationship (has one - use CreditCard's UserID as foreign key)</span>
 | 
						|
    Emails            []Email         <span class="hljs-comment">// One-To-Many relationship (has many - use Email's UserID as foreign key)</span>
 | 
						|
 | 
						|
    BillingAddress    Address         <span class="hljs-comment">// One-To-One relationship (belongs to - use BillingAddressID as foreign key)</span>
 | 
						|
    BillingAddressID  sql.NullInt64
 | 
						|
 | 
						|
    ShippingAddress   Address         <span class="hljs-comment">// One-To-One relationship (belongs to - use ShippingAddressID as foreign key)</span>
 | 
						|
    ShippingAddressID <span class="hljs-keyword">int</span>
 | 
						|
 | 
						|
    IgnoreMe          <span class="hljs-keyword">int</span> <span class="hljs-string">`gorm:"-"`</span>   <span class="hljs-comment">// Ignore this field</span>
 | 
						|
    Languages         []Language <span class="hljs-string">`gorm:"many2many:user_languages;"`</span> <span class="hljs-comment">// Many-To-Many relationship, 'user_languages' is join table</span>
 | 
						|
}
 | 
						|
 | 
						|
<span class="hljs-keyword">type</span> Email <span class="hljs-keyword">struct</span> {
 | 
						|
    ID      <span class="hljs-keyword">int</span>
 | 
						|
    UserID  <span class="hljs-keyword">int</span>     <span class="hljs-string">`gorm:"index"`</span> <span class="hljs-comment">// Foreign key (belongs to), tag `index` will create index for this column</span>
 | 
						|
    Email   <span class="hljs-keyword">string</span>  <span class="hljs-string">`gorm:"type:varchar(100);unique_index"`</span> <span class="hljs-comment">// `type` set sql type, `unique_index` will create unique index for this column</span>
 | 
						|
    Subscribed <span class="hljs-keyword">bool</span>
 | 
						|
}
 | 
						|
 | 
						|
<span class="hljs-keyword">type</span> Address <span class="hljs-keyword">struct</span> {
 | 
						|
    ID       <span class="hljs-keyword">int</span>
 | 
						|
    Address1 <span class="hljs-keyword">string</span>         <span class="hljs-string">`gorm:"not null;unique"`</span> <span class="hljs-comment">// Set field as not nullable and unique</span>
 | 
						|
    Address2 <span class="hljs-keyword">string</span>         <span class="hljs-string">`gorm:"type:varchar(100);unique"`</span>
 | 
						|
    Post     sql.NullString <span class="hljs-string">`gorm:"not null"`</span>
 | 
						|
}
 | 
						|
 | 
						|
<span class="hljs-keyword">type</span> Language <span class="hljs-keyword">struct</span> {
 | 
						|
    ID   <span class="hljs-keyword">int</span>
 | 
						|
    Name <span class="hljs-keyword">string</span> <span class="hljs-string">`gorm:"index:idx_name_code"`</span> <span class="hljs-comment">// Create index with name, and will create combined index if find other fields defined same name</span>
 | 
						|
    Code <span class="hljs-keyword">string</span> <span class="hljs-string">`gorm:"index:idx_name_code"`</span> <span class="hljs-comment">// `unique_index` also works</span>
 | 
						|
}
 | 
						|
 | 
						|
<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>
 | 
						|
}
 | 
						|
</code></pre>
 | 
						|
<h2 id="conventions">Conventions</h2>
 | 
						|
<h3 id="gormmodel-struct"><code>gorm.Model</code> struct</h3>
 | 
						|
<p>Base model definition <code>gorm.Model</code>, including fields <code>ID</code>, <code>CreatedAt</code>, <code>UpdatedAt</code>, <code>DeletedAt</code>, you could embed it in your model, or only write those fields you want</p>
 | 
						|
<pre><code class="lang-go"><span class="hljs-comment">// Base Model's definition</span>
 | 
						|
<span class="hljs-keyword">type</span> Model <span class="hljs-keyword">struct</span> {
 | 
						|
  ID        <span class="hljs-keyword">uint</span> <span class="hljs-string">`gorm:"primary_key"`</span>
 | 
						|
  CreatedAt time.Time
 | 
						|
  UpdatedAt time.Time
 | 
						|
  DeletedAt *time.Time
 | 
						|
}
 | 
						|
 | 
						|
<span class="hljs-comment">// Add fields `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`</span>
 | 
						|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
 | 
						|
  gorm.Model
 | 
						|
  Name <span class="hljs-keyword">string</span>
 | 
						|
}
 | 
						|
 | 
						|
<span class="hljs-comment">// Only need field `ID`, `CreatedAt`</span>
 | 
						|
<span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
 | 
						|
  ID        <span class="hljs-keyword">uint</span>
 | 
						|
  CreatedAt time.Time
 | 
						|
  Name      <span class="hljs-keyword">string</span>
 | 
						|
}
 | 
						|
</code></pre>
 | 
						|
<h3 id="table-name-is-the-pluralized-version-of-struct-name">Table name is the pluralized version of struct name</h3>
 | 
						|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {} <span class="hljs-comment">// default table name is `users`</span>
 | 
						|
 | 
						|
<span class="hljs-comment">// set User's table name to be `profiles</span>
 | 
						|
<span class="hljs-keyword">type</span> (User) TableName() <span class="hljs-keyword">string</span> {
 | 
						|
  <span class="hljs-keyword">return</span> <span class="hljs-string">"profiles"</span>
 | 
						|
}
 | 
						|
 | 
						|
<span class="hljs-keyword">func</span> (u User) TableName() <span class="hljs-keyword">string</span> {
 | 
						|
    <span class="hljs-keyword">if</span> u.Role == <span class="hljs-string">"admin"</span> {
 | 
						|
        <span class="hljs-keyword">return</span> <span class="hljs-string">"admin_users"</span>
 | 
						|
    } <span class="hljs-keyword">else</span> {
 | 
						|
        <span class="hljs-keyword">return</span> <span class="hljs-string">"users"</span>
 | 
						|
    }
 | 
						|
}
 | 
						|
 | 
						|
<span class="hljs-comment">// Disable table name's pluralization globally</span>
 | 
						|
db.SingularTable(<span class="hljs-literal">true</span>) <span class="hljs-comment">// if set this to true, `User`'s default table name will be `user`, table name setted with `TableName` won't be affected</span>
 | 
						|
</code></pre>
 | 
						|
<h3 id="column-name-is-the-snake-case-of-fields-name">Column name is the snake case of field's name</h3>
 | 
						|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
 | 
						|
  ID <span class="hljs-keyword">uint</span>             <span class="hljs-comment">// column name will be `id`</span>
 | 
						|
  Name <span class="hljs-keyword">string</span>         <span class="hljs-comment">// column name will be `name`</span>
 | 
						|
  Birthday time.Time  <span class="hljs-comment">// column name will be `birthday`</span>
 | 
						|
  CreatedAt time.Time <span class="hljs-comment">// column name will be `created_at`</span>
 | 
						|
}
 | 
						|
 | 
						|
<span class="hljs-comment">// Overriding Column Name</span>
 | 
						|
<span class="hljs-keyword">type</span> Animal <span class="hljs-keyword">struct</span> {
 | 
						|
    AnimalId    <span class="hljs-keyword">int64</span>     <span class="hljs-string">`gorm:"column:beast_id"`</span>         <span class="hljs-comment">// set column name to `beast_id`</span>
 | 
						|
    Birthday    time.Time <span class="hljs-string">`gorm:"column:day_of_the_beast"`</span> <span class="hljs-comment">// set column name to `day_of_the_beast`</span>
 | 
						|
    Age         <span class="hljs-keyword">int64</span>     <span class="hljs-string">`gorm:"column:age_of_the_beast"`</span> <span class="hljs-comment">// set column name to `age_of_the_beast`</span>
 | 
						|
}
 | 
						|
</code></pre>
 | 
						|
<h3 id="field-id-as-primary-key">Field <code>ID</code> as primary key</h3>
 | 
						|
<pre><code class="lang-go"><span class="hljs-keyword">type</span> User <span class="hljs-keyword">struct</span> {
 | 
						|
  ID   <span class="hljs-keyword">uint</span>  <span class="hljs-comment">// field named `ID` will be the default primary field</span>
 | 
						|
  Name <span class="hljs-keyword">string</span>
 | 
						|
}
 | 
						|
 | 
						|
<span class="hljs-comment">// Set a field to be primary field with tag `primary_key`</span>
 | 
						|
<span class="hljs-keyword">type</span> Animal <span class="hljs-keyword">struct</span> {
 | 
						|
  AnimalId <span class="hljs-keyword">int64</span> <span class="hljs-string">`gorm:"primary_key"`</span> <span class="hljs-comment">// set AnimalId to be primary key</span>
 | 
						|
  Name     <span class="hljs-keyword">string</span>
 | 
						|
  Age      <span class="hljs-keyword">int64</span>
 | 
						|
}
 | 
						|
</code></pre>
 | 
						|
<h3 id="field-createdat-used-to-store-records-created-time">Field <code>CreatedAt</code> used to store record's created time</h3>
 | 
						|
<p>Create records having <code>CreatedAt</code> field will set it to current time.</p>
 | 
						|
<pre><code class="lang-go">db.Create(&user) <span class="hljs-comment">// will set `CreatedAt` to current time</span>
 | 
						|
 | 
						|
<span class="hljs-comment">// To change its value, you could use `Update`</span>
 | 
						|
db.Model(&user).Update(<span class="hljs-string">"CreatedAt"</span>, time.Now())
 | 
						|
</code></pre>
 | 
						|
<h3 id="use-updatedat-used-to-store-records-updated-time">Use <code>UpdatedAt</code> used to store record's updated time</h3>
 | 
						|
<p>Save records having <code>UpdatedAt</code> field will set it to current time.</p>
 | 
						|
<pre><code class="lang-go">db.Save(&user) <span class="hljs-comment">// will set `UpdatedAt` to current time</span>
 | 
						|
db.Model(&user).Update(<span class="hljs-string">"name"</span>, <span class="hljs-string">"jinzhu"</span>) <span class="hljs-comment">// will set `UpdatedAt` to current time</span>
 | 
						|
</code></pre>
 | 
						|
<h3 id="use-deletedat-to-store-records-deleted-time-if-field-exists">Use <code>DeletedAt</code> to store record's deleted time if field exists</h3>
 | 
						|
<p>Delete records having <code>DeletedAt</code> field, it won't be deleted from database, but only set field <code>DeletedAt</code>'s value to current time, and the record is not findable when querying, refer <a href="curd.html#soft-delete">Soft Delete</a></p>
 | 
						|
 | 
						|
                            
 | 
						|
                            </section>
 | 
						|
                        </div>
 | 
						|
                    </div>
 | 
						|
                
 | 
						|
            </div>
 | 
						|
 | 
						|
            
 | 
						|
                
 | 
						|
                <a href="database.html" class="navigation navigation-prev " aria-label="Previous page: Migration">
 | 
						|
                    <i class="fa fa-angle-left"></i>
 | 
						|
                </a>
 | 
						|
                
 | 
						|
                
 | 
						|
                <a href="models.html" class="navigation navigation-next " aria-label="Next page: Model Defination">
 | 
						|
                    <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>
 |