gorm/advanced.html
2017-03-23 00:16:10 +08:00

884 lines
26 KiB
HTML

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Advanced Usage · GORM Guide</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.2">
<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="advanced.html" />
<link rel="prev" href="callbacks.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<div class="book-summary">
<nav role="navigation">
<ul class="summary">
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
<b>1.1.</b>
Getting Started with GORM
</a>
</li>
<li class="chapter " data-level="1.2" data-path="database.html">
<a href="database.html">
<b>1.2.</b>
Database
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="database.html">
<a href="database.html#connecting-to-a-database">
<b>1.2.1.</b>
Database Connection
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="database.html">
<a href="database.html#migration">
<b>1.2.2.</b>
Migration
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="models.html">
<a href="models.html">
<b>1.3.</b>
Models
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="models.html">
<a href="models.html#model-definition">
<b>1.3.1.</b>
Model Definition
</a>
</li>
<li class="chapter " data-level="1.3.2" data-path="models.html">
<a href="models.html#conventions">
<b>1.3.2.</b>
Conventions & Overriding
</a>
</li>
<li class="chapter " data-level="1.3.3" data-path="associations.html">
<a href="associations.html">
<b>1.3.3.</b>
Associations
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.3.1" data-path="associations.html">
<a href="associations.html#belongs-to">
<b>1.3.3.1.</b>
Belongs To
</a>
</li>
<li class="chapter " data-level="1.3.3.2" data-path="associations.html">
<a href="associations.html#has-one">
<b>1.3.3.2.</b>
Has One
</a>
</li>
<li class="chapter " data-level="1.3.3.3" data-path="associations.html">
<a href="associations.html#has-many">
<b>1.3.3.3.</b>
Has Many
</a>
</li>
<li class="chapter " data-level="1.3.3.4" data-path="associations.html">
<a href="associations.html#many-to-many">
<b>1.3.3.4.</b>
Many To Many
</a>
</li>
<li class="chapter " data-level="1.3.3.5" data-path="associations.html">
<a href="associations.html#polymorphism">
<b>1.3.3.5.</b>
Polymorphism
</a>
</li>
<li class="chapter " data-level="1.3.3.6" data-path="associations.html">
<a href="associations.html#association-mode">
<b>1.3.3.6.</b>
Association Mode
</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="crud.html">
<a href="crud.html">
<b>1.4.</b>
CRUD: Reading and Writing Data
</a>
<ul class="articles">
<li class="chapter " data-level="1.4.1" data-path="crud.html">
<a href="crud.html#create">
<b>1.4.1.</b>
Create
</a>
</li>
<li class="chapter " data-level="1.4.2" data-path="crud.html">
<a href="crud.html#query">
<b>1.4.2.</b>
Query
</a>
</li>
<li class="chapter " data-level="1.4.3" data-path="crud.html">
<a href="crud.html#preloading-eager-loading">
<b>1.4.3.</b>
Preloading (Eager Loading)
</a>
</li>
<li class="chapter " data-level="1.4.4" data-path="crud.html">
<a href="crud.html#update">
<b>1.4.4.</b>
Update
</a>
</li>
<li class="chapter " data-level="1.4.5" data-path="crud.html">
<a href="crud.html#delete">
<b>1.4.5.</b>
Delete / Soft Delete
</a>
</li>
<li class="chapter " data-level="1.4.6" data-path="crud.html">
<a href="crud.html#associations">
<b>1.4.6.</b>
Associations
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.5" data-path="callbacks.html">
<a href="callbacks.html">
<b>1.5.</b>
Callbacks
</a>
</li>
<li class="chapter active" data-level="1.6" data-path="advanced.html">
<a href="advanced.html">
<b>1.6.</b>
Advanced Usage
</a>
<ul class="articles">
<li class="chapter " data-level="1.6.1" data-path="advanced.html">
<a href="advanced.html#error-handling">
<b>1.6.1.</b>
Error Handling
</a>
</li>
<li class="chapter " data-level="1.6.2" data-path="advanced.html">
<a href="advanced.html#transactions">
<b>1.6.2.</b>
Transactions
</a>
</li>
<li class="chapter " data-level="1.6.3" data-path="advanced.html">
<a href="advanced.html#sql-builder">
<b>1.6.3.</b>
Raw SQL & SQL Builder
</a>
</li>
<li class="chapter " data-level="1.6.4" data-path="advanced.html">
<a href="advanced.html#generic-database-interface-sqldb">
<b>1.6.4.</b>
Generic database interface sql.DB
</a>
</li>
<li class="chapter " data-level="1.6.5" data-path="advanced.html">
<a href="advanced.html#compose-primary-key">
<b>1.6.5.</b>
Composite Primary Key
</a>
</li>
<li class="chapter " data-level="1.6.6" data-path="advanced.html">
<a href="advanced.html#logger">
<b>1.6.6.</b>
Overriding Logger
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.7" data-path="development.html">
<a href="development.html">
<b>1.7.</b>
Development
</a>
<ul class="articles">
<li class="chapter " data-level="1.7.1" data-path="development.html">
<a href="development.html#architecture">
<b>1.7.1.</b>
Architecture
</a>
</li>
<li class="chapter " data-level="1.7.2" data-path="development.html">
<a href="development.html#write-plugins">
<b>1.7.2.</b>
Write Plugins
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.8" data-path="changelog.html">
<a href="changelog.html">
<b>1.8.</b>
Change Log
</a>
</li>
<li class="divider"></li>
</ul>
</nav>
</div>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Advanced Usage</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="advanced-usage">Advanced Usage</h1>
<!-- toc -->
<h2 id="error-handling">Error Handling</h2>
<p>After perform any operations, if there are any error happened, GORM will set it to <code>*DB</code>&apos;s <code>Error</code> field</p>
<pre><code class="lang-go"><span class="hljs-keyword">if</span> err := db.Where(<span class="hljs-string">&quot;name = ?&quot;</span>, <span class="hljs-string">&quot;jinzhu&quot;</span>).First(&amp;user).Error; err != <span class="hljs-literal">nil</span> {
<span class="hljs-comment">// error handling...</span>
}
<span class="hljs-comment">// If there are more than one error happened, get all of them with `GetErrors`, it returns `[]error`</span>
db.First(&amp;user).Limit(<span class="hljs-number">10</span>).Find(&amp;users).GetErrors()
<span class="hljs-comment">// Check if returns RecordNotFound error</span>
db.Where(<span class="hljs-string">&quot;name = ?&quot;</span>, <span class="hljs-string">&quot;hello world&quot;</span>).First(&amp;user).RecordNotFound()
<span class="hljs-keyword">if</span> db.Model(&amp;user).Related(&amp;credit_card).RecordNotFound() {
<span class="hljs-comment">// no credit card found handling</span>
}
</code></pre>
<h2 id="transactions">Transactions</h2>
<p>To perform a set of operations within a transaction, the general flow is as below.</p>
<pre><code class="lang-go"><span class="hljs-comment">// begin a transaction</span>
tx := db.Begin()
<span class="hljs-comment">// do some database operations in the transaction (use &apos;tx&apos; from this point, not &apos;db&apos;)</span>
tx.Create(...)
<span class="hljs-comment">// ...</span>
<span class="hljs-comment">// rollback the transaction in case of error</span>
tx.Rollback()
<span class="hljs-comment">// Or commit the transaction</span>
tx.Commit()
</code></pre>
<h3 id="a-specific-example">A Specific Example</h3>
<pre><code class="lang-go"><span class="hljs-keyword">func</span> CreateAnimals(db *gorm.DB) err {
tx := db.Begin()
<span class="hljs-comment">// Note the use of tx as the database handle once you are within a transaction</span>
<span class="hljs-keyword">if</span> err := tx.Create(&amp;Animal{Name: <span class="hljs-string">&quot;Giraffe&quot;</span>}).Error; err != <span class="hljs-literal">nil</span> {
tx.Rollback()
<span class="hljs-keyword">return</span> err
}
<span class="hljs-keyword">if</span> err := tx.Create(&amp;Animal{Name: <span class="hljs-string">&quot;Lion&quot;</span>}).Error; err != <span class="hljs-literal">nil</span> {
tx.Rollback()
<span class="hljs-keyword">return</span> err
}
tx.Commit()
<span class="hljs-keyword">return</span> <span class="hljs-literal">nil</span>
}
</code></pre>
<h2 id="sql-builder">SQL Builder</h2>
<h4 id="run-raw-sql">Run Raw SQL</h4>
<p>Run Raw SQL</p>
<pre><code class="lang-go">db.Exec(<span class="hljs-string">&quot;DROP TABLE users;&quot;</span>)
db.Exec(<span class="hljs-string">&quot;UPDATE orders SET shipped_at=? WHERE id IN (?)&quot;</span>, time.Now, []<span class="hljs-keyword">int64</span>{<span class="hljs-number">11</span>,<span class="hljs-number">22</span>,<span class="hljs-number">33</span>})
<span class="hljs-comment">// Scan</span>
<span class="hljs-keyword">type</span> Result <span class="hljs-keyword">struct</span> {
Name <span class="hljs-keyword">string</span>
Age <span class="hljs-keyword">int</span>
}
<span class="hljs-keyword">var</span> result Result
db.Raw(<span class="hljs-string">&quot;SELECT name, age FROM users WHERE name = ?&quot;</span>, <span class="hljs-number">3</span>).Scan(&amp;result)
</code></pre>
<h4 id="sqlrow--sqlrows">sql.Row &amp; sql.Rows</h4>
<p>Get query result as <code>*sql.Row</code> or <code>*sql.Rows</code></p>
<pre><code class="lang-go">row := db.Table(<span class="hljs-string">&quot;users&quot;</span>).Where(<span class="hljs-string">&quot;name = ?&quot;</span>, <span class="hljs-string">&quot;jinzhu&quot;</span>).Select(<span class="hljs-string">&quot;name, age&quot;</span>).Row() <span class="hljs-comment">// (*sql.Row)</span>
row.Scan(&amp;name, &amp;age)
rows, err := db.Model(&amp;User{}).Where(<span class="hljs-string">&quot;name = ?&quot;</span>, <span class="hljs-string">&quot;jinzhu&quot;</span>).Select(<span class="hljs-string">&quot;name, age, email&quot;</span>).Rows() <span class="hljs-comment">// (*sql.Rows, error)</span>
<span class="hljs-keyword">defer</span> rows.Close()
<span class="hljs-keyword">for</span> rows.Next() {
...
rows.Scan(&amp;name, &amp;age, &amp;email)
...
}
<span class="hljs-comment">// Raw SQL</span>
rows, err := db.Raw(<span class="hljs-string">&quot;select name, age, email from users where name = ?&quot;</span>, <span class="hljs-string">&quot;jinzhu&quot;</span>).Rows() <span class="hljs-comment">// (*sql.Rows, error)</span>
<span class="hljs-keyword">defer</span> rows.Close()
<span class="hljs-keyword">for</span> rows.Next() {
...
rows.Scan(&amp;name, &amp;age, &amp;email)
...
}
</code></pre>
<h4 id="scan-sqlrows-in-iteration">Scan sql.Rows In Iteration</h4>
<pre><code class="lang-go">rows, err := db.Model(&amp;User{}).Where(<span class="hljs-string">&quot;name = ?&quot;</span>, <span class="hljs-string">&quot;jinzhu&quot;</span>).Select(<span class="hljs-string">&quot;name, age, email&quot;</span>).Rows() <span class="hljs-comment">// (*sql.Rows, error)</span>
<span class="hljs-keyword">defer</span> rows.Close()
<span class="hljs-keyword">for</span> rows.Next() {
<span class="hljs-keyword">var</span> user User
db.ScanRows(rows, &amp;user)
<span class="hljs-comment">// do something</span>
}
</code></pre>
<h2 id="generic-database-interface-sqldb">Generic database interface sql.DB</h2>
<p>Get generic database interface <a href="http://golang.org/pkg/database/sql/#DB" target="_blank">*sql.DB</a> from <code>*gorm.DB</code> connection</p>
<pre><code class="lang-go"><span class="hljs-comment">// Get generic database object `*sql.DB` to use its functions</span>
db.DB()
<span class="hljs-comment">// Ping</span>
db.DB().Ping()
</code></pre>
<h4 id="connection-pool">Connection Pool</h4>
<pre><code class="lang-go">db.DB().SetMaxIdleConns(<span class="hljs-number">10</span>)
db.DB().SetMaxOpenConns(<span class="hljs-number">100</span>)
</code></pre>
<h2 id="composite-primary-key">Composite Primary Key</h2>
<p>Set multiple fields as primary key to enable composite primary key</p>
<pre><code class="lang-go"><span class="hljs-keyword">type</span> Product <span class="hljs-keyword">struct</span> {
ID <span class="hljs-keyword">string</span> <span class="hljs-string">`gorm:&quot;primary_key&quot;`</span>
LanguageCode <span class="hljs-keyword">string</span> <span class="hljs-string">`gorm:&quot;primary_key&quot;`</span>
}
</code></pre>
<h2 id="logger">Logger</h2>
<p>Gorm has built-in logger support, by default, it will print happened errors</p>
<pre><code class="lang-go"><span class="hljs-comment">// Enable Logger, show detailed log</span>
db.LogMode(<span class="hljs-literal">true</span>)
<span class="hljs-comment">// Diable Logger, don&apos;t show any log</span>
db.LogMode(<span class="hljs-literal">false</span>)
<span class="hljs-comment">// Debug a single operation, show detailed log for this operation</span>
db.Debug().Where(<span class="hljs-string">&quot;name = ?&quot;</span>, <span class="hljs-string">&quot;jinzhu&quot;</span>).First(&amp;User{})
</code></pre>
<h4 id="customize-logger">Customize Logger</h4>
<p>Refer GORM&apos;s default logger for how to customize it <a href="https://github.com/jinzhu/gorm/blob/master/logger.go" target="_blank">https://github.com/jinzhu/gorm/blob/master/logger.go</a></p>
<pre><code class="lang-go">db.SetLogger(gorm.Logger{revel.TRACE})
db.SetLogger(log.New(os.Stdout, <span class="hljs-string">&quot;\r\n&quot;</span>, <span class="hljs-number">0</span>))
</code></pre>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="callbacks.html" class="navigation navigation-prev " aria-label="Previous page: Callbacks">
<i class="fa fa-angle-left"></i>
</a>
<a href="advanced.html#error-handling" class="navigation navigation-next " aria-label="Next page: Error Handling">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Advanced Usage","level":"1.6","depth":1,"next":{"title":"Error Handling","level":"1.6.1","depth":2,"anchor":"#error-handling","path":"advanced.md","ref":"advanced.md#error-handling","articles":[]},"previous":{"title":"Callbacks","level":"1.5","depth":1,"path":"callbacks.md","ref":"callbacks.md","articles":[]},"dir":"ltr"},"config":{"plugins":["github","edit-link"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"fontsettings":{"theme":"night","family":"sans","size":2},"github":{"url":"https://github.com/jinzhu/gorm"},"edit-link":{"label":"Edit This Page","base":"https://github.com/jinzhu/gorm/edit/gh-pages/documents/"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"GORM Guide","gitbook":"*"},"file":{"path":"advanced.md","mtime":"2017-03-22T16:01:57.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-03-22T16:04:18.436Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-github/plugin.js"></script>
<script src="gitbook/gitbook-plugin-edit-link/plugin.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>