mirror
/
vapor-docs
mirror of https://github.com/vapor/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
vapor-docs/build/2.0/fluent/model/index.html

2264 lines
61 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="shortcut icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-0.16.2, mkdocs-material-1.1.1">
<title>Model - Vapor Docs</title>
<script src="../../assets/javascripts/modernizr-56ade86843.js"></script>
<link rel="stylesheet" href="../../assets/stylesheets/application-e5b48ab351.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto Slab:300,400,400i,700|Source+Code+Pro">
<style>body,input{font-family:"Roboto Slab","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Source Code Pro","Courier New",Courier,monospace}</style>
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="../../stylesheets/extra.css">
</head>
<body>
<svg class="md-svg">
<defs>
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
</defs>
</svg>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="search">
<label class="md-overlay" data-md-component="overlay" for="drawer"></label>
<header class="md-header">
<nav class="md-header-nav md-grid">
<div class="md-flex">
<div class="md-flex__cell md-flex__cell--shrink">
<a href="../.." title="Vapor Docs" class="md-logo md-header-nav__button">
<img src="../../images/droplet-white.svg" width="24" height="24">
</a>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
</div>
<div class="md-flex__cell md-flex__cell--stretch">
<span class="md-flex__ellipsis md-header-nav__title">
<span class="md-header-nav__parent">
Fluent
</span>
Model
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
<div class="md-search" data-md-component="search">
<div class="md-search__overlay"></div>
<div class="md-search__inner">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" placeholder="Search" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
<label class="md-icon md-search__icon" for="search"></label>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="result"></div>
</div>
</div>
</div>
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
<a href="https://github.com/vapor/documentation" title="Go to repository" class="md-source" data-md-source="github">
<div class="md-source__icon">
<svg viewBox="0 0 24 24" width="24" height="24">
<use xlink:href="#github" width="24" height="24"></use>
</svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container">
<main class="md-main">
<div class="md-main__inner md-grid" data-md-component="container">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title md-nav__title--site" for="drawer">
<i class="md-logo md-nav__button">
<img src="../../images/droplet-white.svg">
</i>
Vapor Docs
</label>
<div class="md-nav__source">
<a href="https://github.com/vapor/documentation" title="Go to repository" class="md-source" data-md-source="github">
<div class="md-source__icon">
<svg viewBox="0 0 24 24" width="24" height="24">
<use xlink:href="#github" width="24" height="24"></use>
</svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." title="Overview" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
<label class="md-nav__link" for="nav-2">
Getting started
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-2">
Getting started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../getting-started/install-on-macos/" title="Install: macOS" class="md-nav__link">
Install: macOS
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/install-on-ubuntu/" title="Install: Ubuntu" class="md-nav__link">
Install: Ubuntu
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/toolbox/" title="Toolbox" class="md-nav__link">
Toolbox
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/hello-world/" title="Hello, World" class="md-nav__link">
Hello, World
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/manual/" title="Manual" class="md-nav__link">
Manual
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/xcode/" title="Xcode" class="md-nav__link">
Xcode
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
<label class="md-nav__link" for="nav-3">
Vapor
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-3">
Vapor
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../vapor/folder-structure/" title="Folder Structure" class="md-nav__link">
Folder Structure
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/droplet/" title="Droplet" class="md-nav__link">
Droplet
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/views/" title="Views" class="md-nav__link">
Views
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/controllers/" title="Controllers" class="md-nav__link">
Controllers
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/hash/" title="Hash" class="md-nav__link">
Hash
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/log/" title="Log" class="md-nav__link">
Log
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/commands/" title="Commands" class="md-nav__link">
Commands
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
<label class="md-nav__link" for="nav-4">
Settings
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-4">
Settings
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../settings/config/" title="Config" class="md-nav__link">
Config
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
<label class="md-nav__link" for="nav-5">
JSON
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-5">
JSON
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../json/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../json/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
<label class="md-nav__link" for="nav-6">
Routing
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-6">
Routing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../routing/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/parameters/" title="Parameters" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/group/" title="Group" class="md-nav__link">
Group
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/collection/" title="Collection" class="md-nav__link">
Collection
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7" checked>
<label class="md-nav__link" for="nav-7">
Fluent
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-7">
Fluent
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="toc">
<label class="md-nav__link md-nav__link--active" for="toc">
Model
</label>
<a href="./" title="Model" class="md-nav__link md-nav__link--active">
Model
</a>
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#crud" title="CRUD" class="md-nav__link">
CRUD
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#save" title="Save" class="md-nav__link">
Save
</a>
</li>
<li class="md-nav__item">
<a href="#find" title="Find" class="md-nav__link">
Find
</a>
</li>
<li class="md-nav__item">
<a href="#delete" title="Delete" class="md-nav__link">
Delete
</a>
</li>
<li class="md-nav__item">
<a href="#all" title="All" class="md-nav__link">
All
</a>
</li>
<li class="md-nav__item">
<a href="#count" title="Count" class="md-nav__link">
Count
</a>
</li>
<li class="md-nav__item">
<a href="#chunk" title="Chunk" class="md-nav__link">
Chunk
</a>
</li>
<li class="md-nav__item">
<a href="#query" title="Query" class="md-nav__link">
Query
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#timestamps" title="Timestamps" class="md-nav__link">
Timestamps
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#migration" title="Migration" class="md-nav__link">
Migration
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#soft-delete" title="Soft Delete" class="md-nav__link">
Soft Delete
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#including-deleted" title="Including Deleted" class="md-nav__link">
Including Deleted
</a>
</li>
<li class="md-nav__item">
<a href="#lifecycle" title="Lifecycle" class="md-nav__link">
Lifecycle
</a>
</li>
<li class="md-nav__item">
<a href="#migration_1" title="Migration" class="md-nav__link">
Migration
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#convenience" title="Convenience" class="md-nav__link">
Convenience
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#assert-exists" title="Assert Exists" class="md-nav__link">
Assert Exists
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#life-cycle" title="Life Cycle" class="md-nav__link">
Life Cycle
</a>
</li>
<li class="md-nav__item">
<a href="#entity" title="Entity" class="md-nav__link">
Entity
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#name" title="Name" class="md-nav__link">
Name
</a>
</li>
<li class="md-nav__item">
<a href="#entity_1" title="Entity" class="md-nav__link">
Entity
</a>
</li>
<li class="md-nav__item">
<a href="#id-type" title="ID Type" class="md-nav__link">
ID Type
</a>
</li>
<li class="md-nav__item">
<a href="#key-naming-convention" title="Key Naming Convention" class="md-nav__link">
Key Naming Convention
</a>
</li>
<li class="md-nav__item">
<a href="#id-key" title="ID Key" class="md-nav__link">
ID Key
</a>
</li>
<li class="md-nav__item">
<a href="#foreign-id-key" title="Foreign ID Key" class="md-nav__link">
Foreign ID Key
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../database/" title="Database" class="md-nav__link">
Database
</a>
</li>
<li class="md-nav__item">
<a href="../query/" title="Query" class="md-nav__link">
Query
</a>
</li>
<li class="md-nav__item">
<a href="../relations/" title="Relations" class="md-nav__link">
Relations
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
<label class="md-nav__link" for="nav-8">
Cache
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-8">
Cache
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cache/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../cache/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
<label class="md-nav__link" for="nav-9">
MySQL
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-9">
MySQL
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../mysql/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../mysql/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../mysql/driver/" title="Driver" class="md-nav__link">
Driver
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
<label class="md-nav__link" for="nav-10">
Redis
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-10">
Redis
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../redis/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../redis/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11">
<label class="md-nav__link" for="nav-11">
Auth
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-11">
Auth
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../auth/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/helper/" title="Helper" class="md-nav__link">
Helper
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/password/" title="Password" class="md-nav__link">
Password
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/persist/" title="Persist" class="md-nav__link">
Persist
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-12" type="checkbox" id="nav-12">
<label class="md-nav__link" for="nav-12">
Sessions
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-12">
Sessions
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../sessions/sessions/" title="Sessions" class="md-nav__link">
Sessions
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-13" type="checkbox" id="nav-13">
<label class="md-nav__link" for="nav-13">
HTTP
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-13">
HTTP
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../http/request/" title="Request" class="md-nav__link">
Request
</a>
</li>
<li class="md-nav__item">
<a href="../../http/response/" title="Response" class="md-nav__link">
Response
</a>
</li>
<li class="md-nav__item">
<a href="../../http/middleware/" title="Middleware" class="md-nav__link">
Middleware
</a>
</li>
<li class="md-nav__item">
<a href="../../http/body/" title="Body" class="md-nav__link">
Body
</a>
</li>
<li class="md-nav__item">
<a href="../../http/response-representable/" title="ResponseRepresentable" class="md-nav__link">
ResponseRepresentable
</a>
</li>
<li class="md-nav__item">
<a href="../../http/responder/" title="Responder" class="md-nav__link">
Responder
</a>
</li>
<li class="md-nav__item">
<a href="../../http/client/" title="Client" class="md-nav__link">
Client
</a>
</li>
<li class="md-nav__item">
<a href="../../http/server/" title="Server" class="md-nav__link">
Server
</a>
</li>
<li class="md-nav__item">
<a href="../../http/cors/" title="CORS" class="md-nav__link">
CORS
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-14" type="checkbox" id="nav-14">
<label class="md-nav__link" for="nav-14">
Leaf
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-14">
Leaf
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../leaf/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../leaf/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../leaf/leaf/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../validation/overview/" title="Validation" class="md-nav__link">
Validation
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-16" type="checkbox" id="nav-16">
<label class="md-nav__link" for="nav-16">
Node
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-16">
Node
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../node/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-17" type="checkbox" id="nav-17">
<label class="md-nav__link" for="nav-17">
Core
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-17">
Core
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../core/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../core/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-18" type="checkbox" id="nav-18">
<label class="md-nav__link" for="nav-18">
Bits
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-18">
Bits
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../bits/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../bits/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-19" type="checkbox" id="nav-19">
<label class="md-nav__link" for="nav-19">
Debugging
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-19">
Debugging
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../debugging/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../debugging/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-20" type="checkbox" id="nav-20">
<label class="md-nav__link" for="nav-20">
Advanced
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-20">
Advanced
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../advanced/modules/" title="Modules" class="md-nav__link">
Modules
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-21" type="checkbox" id="nav-21">
<label class="md-nav__link" for="nav-21">
Version (2.0)
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-21">
Version (2.0)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../switch/1_5/" title="1.5" class="md-nav__link">
1.5
</a>
</li>
<li class="md-nav__item">
<a href="../../switch/2_0/" title="2.0" class="md-nav__link">
2.0
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary">
<label class="md-nav__title" for="toc">Table of contents</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="#crud" title="CRUD" class="md-nav__link">
CRUD
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#save" title="Save" class="md-nav__link">
Save
</a>
</li>
<li class="md-nav__item">
<a href="#find" title="Find" class="md-nav__link">
Find
</a>
</li>
<li class="md-nav__item">
<a href="#delete" title="Delete" class="md-nav__link">
Delete
</a>
</li>
<li class="md-nav__item">
<a href="#all" title="All" class="md-nav__link">
All
</a>
</li>
<li class="md-nav__item">
<a href="#count" title="Count" class="md-nav__link">
Count
</a>
</li>
<li class="md-nav__item">
<a href="#chunk" title="Chunk" class="md-nav__link">
Chunk
</a>
</li>
<li class="md-nav__item">
<a href="#query" title="Query" class="md-nav__link">
Query
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#timestamps" title="Timestamps" class="md-nav__link">
Timestamps
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#migration" title="Migration" class="md-nav__link">
Migration
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#soft-delete" title="Soft Delete" class="md-nav__link">
Soft Delete
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#including-deleted" title="Including Deleted" class="md-nav__link">
Including Deleted
</a>
</li>
<li class="md-nav__item">
<a href="#lifecycle" title="Lifecycle" class="md-nav__link">
Lifecycle
</a>
</li>
<li class="md-nav__item">
<a href="#migration_1" title="Migration" class="md-nav__link">
Migration
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#convenience" title="Convenience" class="md-nav__link">
Convenience
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#assert-exists" title="Assert Exists" class="md-nav__link">
Assert Exists
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#life-cycle" title="Life Cycle" class="md-nav__link">
Life Cycle
</a>
</li>
<li class="md-nav__item">
<a href="#entity" title="Entity" class="md-nav__link">
Entity
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#name" title="Name" class="md-nav__link">
Name
</a>
</li>
<li class="md-nav__item">
<a href="#entity_1" title="Entity" class="md-nav__link">
Entity
</a>
</li>
<li class="md-nav__item">
<a href="#id-type" title="ID Type" class="md-nav__link">
ID Type
</a>
</li>
<li class="md-nav__item">
<a href="#key-naming-convention" title="Key Naming Convention" class="md-nav__link">
Key Naming Convention
</a>
</li>
<li class="md-nav__item">
<a href="#id-key" title="ID Key" class="md-nav__link">
ID Key
</a>
</li>
<li class="md-nav__item">
<a href="#foreign-id-key" title="Foreign ID Key" class="md-nav__link">
Foreign ID Key
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/vapor/documentation/edit/master/2.0/docs/fluent/model.md" title="Edit this page" class="md-icon md-content__edit">edit</a>
<h1 id="model">Model<a class="headerlink" href="#model" title="Permanent link">&para;</a></h1>
<p>Models are the Swift representations of the data in your database. As such, they are central to most of Fluent's APIs. </p>
<p>This guide is an overview of the protocol requirements and methods associated with models.</p>
<div class="admonition seealso">
<p class="admonition-title">Seealso</p>
<p>Check out the <a href="../getting-started/">getting started</a> guide for an introductory overview on using models.</p>
</div>
<h2 id="crud">CRUD<a class="headerlink" href="#crud" title="Permanent link">&para;</a></h2>
<p>Models have several basic methods for creating, reading, updating, and deleting.</p>
<h3 id="save">Save<a class="headerlink" href="#save" title="Permanent link">&para;</a></h3>
<p>Persists the entity into the data store and sets the <code>id</code> property.</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">pet</span> <span class="p">=</span> <span class="n">Pet</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="s">&quot;Spud&quot;</span><span class="p">,</span> <span class="n">age</span><span class="p">:</span> <span class="mi">2</span><span class="p">)</span>
<span class="k">try</span> <span class="n">pet</span><span class="p">.</span><span class="n">save</span><span class="p">()</span>
</pre></div>
<h3 id="find">Find<a class="headerlink" href="#find" title="Permanent link">&para;</a></h3>
<p>Finds the model with the supplied identifier or returns <code>nil</code>.</p>
<div class="codehilite"><pre><span></span><span class="k">guard</span> <span class="kd">let</span> <span class="nv">pet</span> <span class="p">=</span> <span class="k">try</span> <span class="n">Pets</span><span class="p">.</span><span class="bp">find</span><span class="p">(</span><span class="mi">42</span><span class="p">)</span> <span class="k">else</span> <span class="p">{</span>
<span class="k">throw</span> <span class="n">Abort</span><span class="p">.</span><span class="n">notFound</span>
<span class="p">}</span>
<span class="bp">print</span><span class="p">(</span><span class="n">pet</span><span class="p">.</span><span class="n">name</span><span class="p">)</span>
</pre></div>
<h3 id="delete">Delete<a class="headerlink" href="#delete" title="Permanent link">&para;</a></h3>
<p>Deletes the entity from the data store if the entity has previously been fetched or saved.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">pet</span><span class="p">.</span><span class="n">delete</span><span class="p">()</span>
</pre></div>
<h3 id="all">All<a class="headerlink" href="#all" title="Permanent link">&para;</a></h3>
<p>Returns all entities for this model.</p>
<div class="codehilite"><pre><span></span><span class="k">for</span> <span class="n">pet</span> <span class="k">in</span> <span class="k">try</span> <span class="n">Pets</span><span class="p">.</span><span class="n">all</span><span class="p">()</span> <span class="p">{</span>
<span class="bp">print</span><span class="p">(</span><span class="n">pet</span><span class="p">.</span><span class="n">name</span><span class="p">)</span>
<span class="p">}</span>
</pre></div>
<h3 id="count">Count<a class="headerlink" href="#count" title="Permanent link">&para;</a></h3>
<p>Returns a count of all entities for this model.</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">count</span> <span class="p">=</span> <span class="k">try</span> <span class="n">Pets</span><span class="p">.</span><span class="bp">count</span><span class="p">()</span>
</pre></div>
<h3 id="chunk">Chunk<a class="headerlink" href="#chunk" title="Permanent link">&para;</a></h3>
<p>Returns chunked arrays of a supplied size for all of the entities for this model.</p>
<p>This is a great way to parse through all models of a large data set.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">Pets</span><span class="p">.</span><span class="n">chunk</span><span class="p">(</span><span class="mi">20</span><span class="p">)</span> <span class="p">{</span> <span class="n">pets</span> <span class="k">in</span>
<span class="c1">//</span>
<span class="p">}</span>
</pre></div>
<h3 id="query">Query<a class="headerlink" href="#query" title="Permanent link">&para;</a></h3>
<p>Creates a <code>Query</code> instance for this <code>Model</code>.</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">query</span> <span class="p">=</span> <span class="k">try</span> <span class="n">Pet</span><span class="p">.</span><span class="n">makeQuery</span><span class="p">()</span>
</pre></div>
<p>To learn more about crafting complex queries, see the <a href="../query/">query</a> section.</p>
<h2 id="timestamps">Timestamps<a class="headerlink" href="#timestamps" title="Permanent link">&para;</a></h2>
<p>To add timestamps to your model, simply conform it to <code>Timestampable</code>.</p>
<div class="codehilite"><pre><span></span><span class="kd">extension</span> <span class="nc">User</span><span class="p">:</span> <span class="n">Timestampable</span> <span class="p">{</span> <span class="p">}</span>
</pre></div>
<p>You can access the updated at and created at times on any model instance.</p>
<div class="codehilite"><pre><span></span><span class="n">user</span><span class="p">.</span><span class="n">updatedAt</span> <span class="c1">// Date?</span>
<span class="n">user</span><span class="p">.</span><span class="n">createdAt</span> <span class="c1">// Date?</span>
</pre></div>
<p>When filtering or sorting on the timestamp data, you can use the timestamp keys from the class.</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">newUsers</span> <span class="p">=</span> <span class="k">try</span> <span class="n">User</span>
<span class="p">.</span><span class="n">makeQuery</span><span class="p">()</span>
<span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="n">User</span><span class="p">.</span><span class="n">createdAtKey</span><span class="p">,</span> <span class="p">.</span><span class="n">greaterThan</span><span class="p">,</span> <span class="p">...)</span>
<span class="p">.</span><span class="n">all</span><span class="p">()</span>
</pre></div>
<p>You can also override the timestamp keys if you have custom needs.</p>
<div class="codehilite"><pre><span></span><span class="kd">extension</span> <span class="nc">User</span><span class="p">:</span> <span class="n">Timestampable</span> <span class="p">{</span>
<span class="kd">static</span> <span class="kd">var</span> <span class="nv">updatedAtKey</span><span class="p">:</span> <span class="nb">String</span> <span class="p">{</span> <span class="k">return</span> <span class="s">&quot;custom_updated_at&quot;</span> <span class="p">}</span>
<span class="kd">static</span> <span class="kd">var</span> <span class="nv">createdAtKey</span><span class="p">:</span> <span class="nb">String</span> <span class="p">{</span> <span class="k">return</span> <span class="s">&quot;custom_created_at&quot;</span> <span class="p">}</span>
<span class="p">}</span>
</pre></div>
<h3 id="migration">Migration<a class="headerlink" href="#migration" title="Permanent link">&para;</a></h3>
<p><code>Timestampable</code> models will automatically have created at and updated at keys added during
<a href="../database/#Create">database create</a> calls.</p>
<p>Should you need to manually add <code>Timestampable</code> to an existing model, you can use the <code>date()</code> method
in a <a href="../database/#Migrations">migration</a>.</p>
<div class="codehilite"><pre><span></span><span class="n">database</span><span class="p">.</span><span class="n">modify</span><span class="p">(</span><span class="n">User</span><span class="p">.</span><span class="kc">self</span><span class="p">)</span> <span class="p">{</span> <span class="n">builder</span> <span class="k">in</span>
<span class="n">builder</span><span class="p">.</span><span class="n">date</span><span class="p">(</span><span class="n">User</span><span class="p">.</span><span class="n">createdAtKey</span><span class="p">)</span>
<span class="n">builder</span><span class="p">.</span><span class="n">date</span><span class="p">(</span><span class="n">User</span><span class="p">.</span><span class="n">updatedAtKey</span><span class="p">)</span>
<span class="p">}</span>
</pre></div>
<h2 id="soft-delete">Soft Delete<a class="headerlink" href="#soft-delete" title="Permanent link">&para;</a></h2>
<p>Soft delete is a way of "deleting" a model from all fetch and update queries to Fluent but not actually deleting the model from the database. Soft deleted models can also be restored. </p>
<p>To make your model soft deletable, simply conform it to <code>SoftDeletable</code>.</p>
<div class="codehilite"><pre><span></span><span class="kd">extension</span> <span class="nc">User</span><span class="p">:</span> <span class="n">SoftDeletable</span> <span class="p">{</span> <span class="p">}</span>
</pre></div>
<p>Once your model is soft deletable, all calls to <code>delete()</code> will set the deleted at flag instead of actually
deleting the model.</p>
<p>To restore a model, call <code>.restore()</code>. To actually delete a model from the database, call <code>.forceDelete()</code>.</p>
<p>You can also override the soft delete key if you have custom needs.</p>
<div class="codehilite"><pre><span></span><span class="kd">extension</span> <span class="nc">User</span><span class="p">:</span> <span class="n">SoftDeletable</span> <span class="p">{</span>
<span class="kd">static</span> <span class="kd">var</span> <span class="nv">deletedAtKey</span><span class="p">:</span> <span class="nb">String</span> <span class="p">{</span> <span class="k">return</span> <span class="s">&quot;custom_deleted_at&quot;</span> <span class="p">}</span>
<span class="p">}</span>
</pre></div>
<h3 id="including-deleted">Including Deleted<a class="headerlink" href="#including-deleted" title="Permanent link">&para;</a></h3>
<p>When a model is soft deleted, it will be affected by any queries made with the Fluent query builder.</p>
<p>To include soft deleted models, for instance if you want to restore them, use the <code>.withSoftDeleted()</code> method
on the query builder.</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">allUsers</span> <span class="p">=</span> <span class="k">try</span> <span class="n">User</span><span class="p">.</span><span class="n">makeQuery</span><span class="p">().</span><span class="n">withSoftDeleted</span><span class="p">().</span><span class="n">all</span><span class="p">()</span>
</pre></div>
<h3 id="lifecycle">Lifecycle<a class="headerlink" href="#lifecycle" title="Permanent link">&para;</a></h3>
<p>You can hook into the soft delete events of a model.</p>
<div class="codehilite"><pre><span></span><span class="kd">extension</span> <span class="nc">User</span><span class="p">:</span> <span class="n">SoftDeletable</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">willSoftDelete</span><span class="p">()</span> <span class="kr">throws</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="kd">func</span> <span class="nf">didSoftDelete</span><span class="p">()</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="kd">func</span> <span class="nf">willForceDelete</span><span class="p">()</span> <span class="kr">throws</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="kd">func</span> <span class="nf">didForceDelete</span><span class="p">()</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="kd">func</span> <span class="nf">willRestore</span><span class="p">()</span> <span class="kr">throws</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="kd">func</span> <span class="nf">didRestore</span><span class="p">()</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="p">}</span>
</pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Throwing during a <code>will</code> hook will prevent the action from happening.</p>
</div>
<h3 id="migration_1">Migration<a class="headerlink" href="#migration_1" title="Permanent link">&para;</a></h3>
<p><code>SoftDeletable</code> models will automatically have a deleted at key added during
<a href="../database/#create">database create</a> calls.</p>
<p>Should you need to manually add <code>SoftDeletable</code> to an existing model, you can use the <code>date()</code> method
in a <a href="../database/#migrations">migration</a>.</p>
<div class="codehilite"><pre><span></span><span class="n">database</span><span class="p">.</span><span class="n">modify</span><span class="p">(</span><span class="n">User</span><span class="p">.</span><span class="kc">self</span><span class="p">)</span> <span class="p">{</span> <span class="n">builder</span> <span class="k">in</span>
<span class="n">builder</span><span class="p">.</span><span class="n">date</span><span class="p">(</span><span class="n">User</span><span class="p">.</span><span class="n">deletedAtKey</span><span class="p">,</span> <span class="kr">optional</span><span class="p">:</span> <span class="kc">true</span><span class="p">)</span>
<span class="p">}</span>
</pre></div>
<h2 id="convenience">Convenience<a class="headerlink" href="#convenience" title="Permanent link">&para;</a></h2>
<h3 id="assert-exists">Assert Exists<a class="headerlink" href="#assert-exists" title="Permanent link">&para;</a></h3>
<p>The identifier property of a model is optional since models may not have been saved yet.</p>
<p>You can get the identifier or throw an error if the model has not been saved yet by calling <code>assertExists()</code>.</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">id</span> <span class="p">=</span> <span class="k">try</span> <span class="n">pet</span><span class="p">.</span><span class="n">assertExists</span><span class="p">()</span>
<span class="bp">print</span><span class="p">(</span><span class="n">id</span><span class="p">)</span> <span class="c1">// not optional</span>
</pre></div>
<h2 id="life-cycle">Life Cycle<a class="headerlink" href="#life-cycle" title="Permanent link">&para;</a></h2>
<p>The following life-cycle methods can be implemented on your model to hook into internal operations.</p>
<div class="codehilite"><pre><span></span><span class="c1">/// Called before the entity will be created.</span>
<span class="c1">/// Throwing will cancel the creation.</span>
<span class="kd">func</span> <span class="nf">willCreate</span><span class="p">()</span> <span class="kr">throws</span>
<span class="c1">/// Called after the entity has been created.</span>
<span class="kd">func</span> <span class="nf">didCreate</span><span class="p">()</span>
<span class="c1">/// Called before the entity will be updated.</span>
<span class="c1">/// Throwing will cancel the update.</span>
<span class="kd">func</span> <span class="nf">willUpdate</span><span class="p">()</span> <span class="kr">throws</span>
<span class="c1">/// Called after the entity has been updated.</span>
<span class="kd">func</span> <span class="nf">didUpdate</span><span class="p">()</span>
<span class="c1">/// Called before the entity will be deleted.</span>
<span class="c1">/// Throwing will cancel the deletion.</span>
<span class="kd">func</span> <span class="nf">willDelete</span><span class="p">()</span> <span class="kr">throws</span>
<span class="c1">/// Called after the entity has been deleted.</span>
<span class="kd">func</span> <span class="nf">didDelete</span><span class="p">()</span>
</pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Throwing in a <code>willFoo()</code> method will cancel the operation.</p>
</div>
<p>Here's an example of implementing the <code>didDelete</code> method.</p>
<div class="codehilite"><pre><span></span><span class="kr">final</span> <span class="kd">class</span> <span class="nc">Pet</span><span class="p">:</span> <span class="n">Model</span> <span class="p">{</span>
<span class="p">...</span>
<span class="kd">func</span> <span class="nf">didDelete</span><span class="p">()</span> <span class="p">{</span>
<span class="bp">print</span><span class="p">(</span><span class="s">&quot;Deleted </span><span class="si">\(</span><span class="n">name</span><span class="si">)</span><span class="s">&quot;</span><span class="p">)</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<h2 id="entity">Entity<a class="headerlink" href="#entity" title="Permanent link">&para;</a></h2>
<p>Entity is the base Fluent protocol that Model conforms to. It is responsible for providing all information the
database or query may need when saving, fetching, or deleting your models.</p>
<h3 id="name">Name<a class="headerlink" href="#name" title="Permanent link">&para;</a></h3>
<p>The singular relational name of this model. Also used for internal storage. Example: Pet = "pet".</p>
<p>This value should usually not be overriden. </p>
<div class="codehilite"><pre><span></span><span class="kr">final</span> <span class="kd">class</span> <span class="nc">Pet</span><span class="p">:</span> <span class="n">Model</span> <span class="p">{</span>
<span class="kd">static</span> <span class="kd">let</span> <span class="nv">name</span> <span class="p">=</span> <span class="s">&quot;pet&quot;</span>
<span class="p">}</span>
</pre></div>
<h3 id="entity_1">Entity<a class="headerlink" href="#entity_1" title="Permanent link">&para;</a></h3>
<p>The plural relational name of this model. Used as the collection or table name. </p>
<p>Example: Pet = "pets".</p>
<p>This value should be overriden if the table name for your model is non-standard.</p>
<div class="codehilite"><pre><span></span><span class="kr">final</span> <span class="kd">class</span> <span class="nc">Pet</span><span class="p">:</span> <span class="n">Model</span> <span class="p">{</span>
<span class="kd">static</span> <span class="kd">let</span> <span class="nv">entity</span> <span class="p">=</span> <span class="s">&quot;pets&quot;</span>
<span class="p">}</span>
</pre></div>
<h3 id="id-type">ID Type<a class="headerlink" href="#id-type" title="Permanent link">&para;</a></h3>
<p>The type of identifier used for both the local and foreign id keys. </p>
<p>Example: uuid, integer, etc.</p>
<p>This value should be overriden if a particular model in your database uses a different ID type.</p>
<div class="codehilite"><pre><span></span><span class="kr">final</span> <span class="kd">class</span> <span class="nc">Pet</span><span class="p">:</span> <span class="n">Model</span> <span class="p">{</span>
<span class="kd">static</span> <span class="kd">let</span> <span class="nv">idType</span> <span class="p">=</span> <span class="p">.</span><span class="n">uuid</span>
<span class="p">}</span>
</pre></div>
<p>This can also be overridden at the database level using config.</p>
<p><code>Config/fluent.json</code></p>
<div class="codehilite"><pre><span></span><span class="p">{</span>
<span class="nt">&quot;idType&quot;</span><span class="p">:</span> <span class="s2">&quot;uuid&quot;</span>
<span class="p">}</span>
</pre></div>
<p>Or programatically.</p>
<div class="codehilite"><pre><span></span><span class="n">drop</span><span class="p">.</span><span class="n">database</span><span class="p">?.</span><span class="n">idType</span> <span class="p">=</span> <span class="p">.</span><span class="n">uuid</span>
</pre></div>
<h3 id="key-naming-convention">Key Naming Convention<a class="headerlink" href="#key-naming-convention" title="Permanent link">&para;</a></h3>
<p>The naming convetion to use for foreign id keys, table names, etc.</p>
<p>Example: snake_case vs. camelCase.</p>
<p>This value should be overridden if a particular model in your database uses a different key naming convention.</p>
<div class="codehilite"><pre><span></span><span class="kr">final</span> <span class="kd">class</span> <span class="nc">Pet</span><span class="p">:</span> <span class="n">Model</span> <span class="p">{</span>
<span class="kd">static</span> <span class="kd">let</span> <span class="nv">keyNamingConvention</span> <span class="p">=</span> <span class="p">.</span><span class="n">snake_case</span>
<span class="p">}</span>
</pre></div>
<p>This can also be overridden at the database level using config.</p>
<p><code>Config/fluent.json</code></p>
<div class="codehilite"><pre><span></span><span class="p">{</span>
<span class="nt">&quot;keyNamingConvention&quot;</span><span class="p">:</span> <span class="s2">&quot;snake_case&quot;</span>
<span class="p">}</span>
</pre></div>
<p>Or programatically.</p>
<div class="codehilite"><pre><span></span><span class="n">drop</span><span class="p">.</span><span class="n">database</span><span class="p">?.</span><span class="n">keyNamingConvention</span> <span class="p">=</span> <span class="p">.</span><span class="n">snake_case</span>
</pre></div>
<h3 id="id-key">ID Key<a class="headerlink" href="#id-key" title="Permanent link">&para;</a></h3>
<p>The name of the column that corresponds to this entity's identifying key.</p>
<p>The default is 'database.driver.idKey', and then "id"</p>
<div class="codehilite"><pre><span></span><span class="kr">final</span> <span class="kd">class</span> <span class="nc">Pet</span><span class="p">:</span> <span class="n">Model</span> <span class="p">{</span>
<span class="kd">static</span> <span class="kd">let</span> <span class="nv">idKey</span> <span class="p">=</span> <span class="s">&quot;id&quot;</span>
<span class="p">}</span>
</pre></div>
<h3 id="foreign-id-key">Foreign ID Key<a class="headerlink" href="#foreign-id-key" title="Permanent link">&para;</a></h3>
<p>The name of the column that points to this entity's id when referenced from other tables or collections.</p>
<p>Example: "foo_id".</p>
<div class="codehilite"><pre><span></span><span class="kr">final</span> <span class="kd">class</span> <span class="nc">Pet</span><span class="p">:</span> <span class="n">Model</span> <span class="p">{</span>
<span class="kd">static</span> <span class="kd">let</span> <span class="nv">foreignIdKey</span> <span class="p">=</span> <span class="s">&quot;pet_id&quot;</span>
<span class="p">}</span>
</pre></div>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="../getting-started/" title="Getting Started" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
</div>
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Previous
</span>
Getting Started
</span>
</div>
</a>
<a href="../database/" title="Database" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
<span class="md-flex__ellipsis">
<span class="md-footer-nav__direction">
Next
</span>
Database
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
<div class="md-footer-copyright__highlight">
Copyright &copy; 2017 Qutheory, LLC
</div>
powered by
<a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
and
<a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
Material for MkDocs</a>
</div>
<div class="md-footer-social">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<a href="https://twitter.com/@codevapor" class="md-footer-social__link fa fa-twitter"></a>
<a href="http://vapor.team/" class="md-footer-social__link fa fa-slack"></a>
</div>
</div>
</div>
</footer>
</div>
<script src="../../assets/javascripts/application-f6cd941c96.js"></script>
<script>app.initialize({url:{base:"../.."}})</script>
<script>!function(e,t,n,a,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(n),i=t.getElementsByTagName(n)[0],c.async=1,c.src=a,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","UA-76177358-4","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})}),document.forms.search.query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink