826 lines
		
	
	
		
			24 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			826 lines
		
	
	
		
			24 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!DOCTYPE HTML>
 | 
						|
<html lang="" >
 | 
						|
    <head>
 | 
						|
        <title>Database · 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="When connect to a database, you need to import the database's driver first, for example:">
 | 
						|
        <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="database.html" />
 | 
						|
    
 | 
						|
    
 | 
						|
    <link rel="prev" href="./" />
 | 
						|
    
 | 
						|
 | 
						|
    </head>
 | 
						|
    <body>
 | 
						|
        
 | 
						|
<div class="book"
 | 
						|
    data-level="1"
 | 
						|
    data-chapter-title="Database"
 | 
						|
    data-filepath="database.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 active" 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-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="." >Database</a>
 | 
						|
    </h1>
 | 
						|
</div>
 | 
						|
 | 
						|
 | 
						|
 | 
						|
                    <div class="page-wrapper" tabindex="-1" role="main">
 | 
						|
                        <div class="page-inner">
 | 
						|
                            <section class="normal markdown-section">
 | 
						|
                            
 | 
						|
                            <h1 id="database">Database</h1>
 | 
						|
<!-- toc -->
 | 
						|
<ul>
 | 
						|
<li><a href="#connecting-to-a-database">Connecting to a database</a><ul>
 | 
						|
<li><a href="#mysql">MySQL</a></li>
 | 
						|
<li><a href="#postgresql">PostgreSQL</a></li>
 | 
						|
<li><a href="#sqlite3">Sqlite3</a></li>
 | 
						|
<li><a href="#write-dialect-for-unsupported-databases">Write Dialect for unsupported databases</a></li>
 | 
						|
</ul>
 | 
						|
</li>
 | 
						|
<li><a href="#migration">Migration</a><ul>
 | 
						|
<li><a href="#auto-migration">Auto Migration</a></li>
 | 
						|
<li><a href="#has-table">Has Table</a></li>
 | 
						|
<li><a href="#create-table">Create Table</a></li>
 | 
						|
<li><a href="#drop-table">Drop table</a></li>
 | 
						|
<li><a href="#modifycolumn">ModifyColumn</a></li>
 | 
						|
<li><a href="#dropcolumn">DropColumn</a></li>
 | 
						|
<li><a href="#add-foreign-key">Add Foreign Key</a></li>
 | 
						|
<li><a href="#indexes">Indexes</a></li>
 | 
						|
</ul>
 | 
						|
</li>
 | 
						|
</ul>
 | 
						|
<!-- toc stop -->
 | 
						|
<h2 id="connecting-to-a-database">Connecting to a database</h2>
 | 
						|
<p>When connect to a database, you need to import the database's driver first, for example:</p>
 | 
						|
<pre><code class="lang-go"><span class="hljs-keyword">import</span> _ <span class="hljs-string">"github.com/go-sql-driver/mysql"</span>
 | 
						|
</code></pre>
 | 
						|
<p>GORM has wrapped some drivers, for easier to remember the import path, so you could import the mysql driver with</p>
 | 
						|
<pre><code class="lang-go"><span class="hljs-keyword">import</span> _ <span class="hljs-string">"github.com/jinzhu/gorm/dialects/mysql"</span>
 | 
						|
<span class="hljs-comment">// import _ "github.com/jinzhu/gorm/dialects/postgres"</span>
 | 
						|
<span class="hljs-comment">// import _ "github.com/jinzhu/gorm/dialects/sqlite"</span>
 | 
						|
<span class="hljs-comment">// import _ "github.com/jinzhu/gorm/dialects/mssql"</span>
 | 
						|
</code></pre>
 | 
						|
<h4 id="mysql">MySQL</h4>
 | 
						|
<p><strong>NOTE</strong> in order to handle <code>time.Time</code> you need to include <code>parseTime</code> as param <a href="https://github.com/go-sql-driver/mysql#parameters" target="_blank">more supported parameters</a></p>
 | 
						|
<pre><code class="lang-go"><span class="hljs-keyword">import</span> (
 | 
						|
    <span class="hljs-string">"github.com/jinzhu/gorm"</span>
 | 
						|
    _ <span class="hljs-string">"github.com/jinzhu/gorm/dialects/mysql"</span>
 | 
						|
)
 | 
						|
 | 
						|
<span class="hljs-keyword">func</span> main() {
 | 
						|
  db, err := gorm.Open(<span class="hljs-string">"mysql"</span>, <span class="hljs-string">"user:password@/dbname?charset=utf8&parseTime=True&loc=Local"</span>)
 | 
						|
}
 | 
						|
</code></pre>
 | 
						|
<h4 id="postgresql">PostgreSQL</h4>
 | 
						|
<pre><code class="lang-go"><span class="hljs-keyword">import</span> (
 | 
						|
    <span class="hljs-string">"github.com/jinzhu/gorm"</span>
 | 
						|
    _ <span class="hljs-string">"github.com/jinzhu/gorm/dialects/postgres"</span>
 | 
						|
)
 | 
						|
 | 
						|
<span class="hljs-keyword">func</span> main() {
 | 
						|
  db, err := gorm.Open(<span class="hljs-string">"postgres"</span>, <span class="hljs-string">"user=gorm dbname=gorm sslmode=disable"</span>)
 | 
						|
}
 | 
						|
</code></pre>
 | 
						|
<h4 id="sqlite3">Sqlite3</h4>
 | 
						|
<pre><code class="lang-go"><span class="hljs-keyword">import</span> (
 | 
						|
    <span class="hljs-string">"github.com/jinzhu/gorm"</span>
 | 
						|
    _ <span class="hljs-string">"github.com/jinzhu/gorm/dialects/sqlite"</span>
 | 
						|
)
 | 
						|
 | 
						|
<span class="hljs-keyword">func</span> main() {
 | 
						|
  db, err := gorm.Open(<span class="hljs-string">"sqlite3"</span>, <span class="hljs-string">"/tmp/gorm.db"</span>)
 | 
						|
}
 | 
						|
</code></pre>
 | 
						|
<h4 id="write-dialect-for-unsupported-databases">Write Dialect for unsupported databases</h4>
 | 
						|
<p>GORM officially support above databases, but you could write a dialect for those unsupported databaes,</p>
 | 
						|
<p>Refer: <a href="https://github.com/jinzhu/gorm/blob/master/dialect.go" target="_blank">https://github.com/jinzhu/gorm/blob/master/dialect.go</a></p>
 | 
						|
<h2 id="migration">Migration</h2>
 | 
						|
<h3 id="auto-migration">Auto Migration</h3>
 | 
						|
<p>Automatically migrate your schema, to keep your schema update to date</p>
 | 
						|
<p><strong>WARNING</strong> AutoMigrate will ONLY create tables, missing columns and missing indexes, <strong>WON'T</strong> change existing column's type or delete unused columns to protect your data</p>
 | 
						|
<pre><code class="lang-go">db.AutoMigrate(&User{})
 | 
						|
 | 
						|
db.AutoMigrate(&User{}, &Product{}, &Order{})
 | 
						|
 | 
						|
<span class="hljs-comment">// Add table suffix when create tables</span>
 | 
						|
db.Set(<span class="hljs-string">"gorm:table_options"</span>, <span class="hljs-string">"ENGINE=InnoDB"</span>).AutoMigrate(&User{})
 | 
						|
</code></pre>
 | 
						|
<h3 id="has-table">Has Table</h3>
 | 
						|
<pre><code class="lang-go"><span class="hljs-comment">// Check model `User`'s table exists or not</span>
 | 
						|
db.HasTable(&User{})
 | 
						|
 | 
						|
<span class="hljs-comment">// Check table `users` exists or not</span>
 | 
						|
db.HasTable(<span class="hljs-string">"users"</span>)
 | 
						|
</code></pre>
 | 
						|
<h3 id="create-table">Create Table</h3>
 | 
						|
<pre><code class="lang-go"><span class="hljs-comment">// Create table for model `User`</span>
 | 
						|
db.CreateTable(&User{})
 | 
						|
 | 
						|
<span class="hljs-comment">// will append "ENGINE=InnoDB" to the SQL statement when creating table `users`</span>
 | 
						|
db.Set(<span class="hljs-string">"gorm:table_options"</span>, <span class="hljs-string">"ENGINE=InnoDB"</span>).CreateTable(&User{})
 | 
						|
</code></pre>
 | 
						|
<h3 id="drop-table">Drop table</h3>
 | 
						|
<pre><code class="lang-go"><span class="hljs-comment">// Drop model `User`'s table</span>
 | 
						|
db.DropTable(&User{})
 | 
						|
 | 
						|
<span class="hljs-comment">// Drop table `users</span>
 | 
						|
db.DropTable(<span class="hljs-string">"users"</span>)
 | 
						|
 | 
						|
<span class="hljs-comment">// Drop model's `User`'s table and table `products`</span>
 | 
						|
db.DropTableIfExists(&User{}, <span class="hljs-string">"products"</span>)
 | 
						|
</code></pre>
 | 
						|
<h3 id="modifycolumn">ModifyColumn</h3>
 | 
						|
<p>Modify column's type to given value</p>
 | 
						|
<pre><code class="lang-go"><span class="hljs-comment">// change column description's data type to `text` for model `User`</span>
 | 
						|
db.Model(&User{}).ModifyColumn(<span class="hljs-string">"description"</span>, <span class="hljs-string">"text"</span>)
 | 
						|
</code></pre>
 | 
						|
<h3 id="dropcolumn">DropColumn</h3>
 | 
						|
<pre><code class="lang-go"><span class="hljs-comment">// Drop column description from model `User`</span>
 | 
						|
db.Model(&User{}).DropColumn(<span class="hljs-string">"description"</span>)
 | 
						|
</code></pre>
 | 
						|
<h3 id="add-foreign-key">Add Foreign Key</h3>
 | 
						|
<pre><code class="lang-go"><span class="hljs-comment">// Add foreign key</span>
 | 
						|
<span class="hljs-comment">// 1st param : foreignkey field</span>
 | 
						|
<span class="hljs-comment">// 2nd param : destination table(id)</span>
 | 
						|
<span class="hljs-comment">// 3rd param : ONDELETE</span>
 | 
						|
<span class="hljs-comment">// 4th param : ONUPDATE</span>
 | 
						|
db.Model(&User{}).AddForeignKey(<span class="hljs-string">"city_id"</span>, <span class="hljs-string">"cities(id)"</span>, <span class="hljs-string">"RESTRICT"</span>, <span class="hljs-string">"RESTRICT"</span>)
 | 
						|
</code></pre>
 | 
						|
<h3 id="indexes">Indexes</h3>
 | 
						|
<pre><code class="lang-go"><span class="hljs-comment">// Add index for columns `name` with given name `idx_user_name`</span>
 | 
						|
db.Model(&User{}).AddIndex(<span class="hljs-string">"idx_user_name"</span>, <span class="hljs-string">"name"</span>)
 | 
						|
 | 
						|
<span class="hljs-comment">// Add index for columns `name`, `age` with given name `idx_user_name_age`</span>
 | 
						|
db.Model(&User{}).AddIndex(<span class="hljs-string">"idx_user_name_age"</span>, <span class="hljs-string">"name"</span>, <span class="hljs-string">"age"</span>)
 | 
						|
 | 
						|
<span class="hljs-comment">// Add unique index</span>
 | 
						|
db.Model(&User{}).AddUniqueIndex(<span class="hljs-string">"idx_user_name"</span>, <span class="hljs-string">"name"</span>)
 | 
						|
 | 
						|
<span class="hljs-comment">// Add unique index for multiple columns</span>
 | 
						|
db.Model(&User{}).AddUniqueIndex(<span class="hljs-string">"idx_user_name_age"</span>, <span class="hljs-string">"name"</span>, <span class="hljs-string">"age"</span>)
 | 
						|
 | 
						|
<span class="hljs-comment">// Remove index</span>
 | 
						|
db.Model(&User{}).RemoveIndex(<span class="hljs-string">"idx_user_name"</span>)
 | 
						|
</code></pre>
 | 
						|
 | 
						|
                            
 | 
						|
                            </section>
 | 
						|
                        </div>
 | 
						|
                    </div>
 | 
						|
                
 | 
						|
            </div>
 | 
						|
 | 
						|
            
 | 
						|
                
 | 
						|
                <a href="./" class="navigation navigation-prev " aria-label="Previous page: Getting Started with GORM">
 | 
						|
                    <i class="fa fa-angle-left"></i>
 | 
						|
                </a>
 | 
						|
                
 | 
						|
                
 | 
						|
                <a href="database.html" class="navigation navigation-next " aria-label="Next page: Database Connection">
 | 
						|
                    <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>
 |