903 lines
30 KiB
HTML
903 lines
30 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Models · 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="models.html" />
|
|
|
|
|
|
<link rel="prev" href="database.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 active" 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 " 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="." >Models</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="models">Models</h1>
|
|
<!-- toc -->
|
|
<ul>
|
|
<li><a href="#model-definition">Model Definition</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="#change-default-tablenames">Change default tablenames</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-definition">Model Definition</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">func</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="change-default-tablenames">Change default tablenames</h3>
|
|
<p>You can apply any rules on the default table name by defining the <code>DefaultTableNameHandler</code></p>
|
|
<pre><code>gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string {
|
|
return "prefix_" + defaultTableName;
|
|
}
|
|
</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="crud.html#soft-delete">Soft Delete</a></p>
|
|
|
|
|
|
</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="database.html#migration" class="navigation navigation-prev " aria-label="Previous page: Migration">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="models.html#model-definition" class="navigation navigation-next " aria-label="Next page: Model Definition">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Models","level":"1.3","depth":1,"next":{"title":"Model Definition","level":"1.3.1","depth":2,"anchor":"#model-definition","path":"models.md","ref":"models.md#model-definition","articles":[]},"previous":{"title":"Migration","level":"1.2.2","depth":2,"anchor":"#migration","path":"database.md","ref":"database.md#migration","articles":[]},"dir":"ltr"},"config":{"plugins":["toc","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":{"github":{"url":"https://github.com/jinzhu/gorm"},"toc":{"addClass":true,"className":"toc"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"night","family":"sans","size":2},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/jinzhu/gorm/edit/gh-pages/documents/"},"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":"models.md","mtime":"2016-10-27T02:32:23.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2016-10-27T04:34:17.895Z"},"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>
|
|
|