mirror of https://github.com/vapor/docs.git
1887 lines
47 KiB
HTML
1887 lines
47 KiB
HTML
|
|
|
|
|
|
|
|
<!DOCTYPE html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
|
|
|
|
|
|
|
|
|
<meta name="lang:clipboard.copy" content="Copy to clipboard">
|
|
|
|
<meta name="lang:clipboard.copied" content="Copied to clipboard">
|
|
|
|
<meta name="lang:search.language" content="en">
|
|
|
|
<meta name="lang:search.result.none" content="No matching documents">
|
|
|
|
<meta name="lang:search.result.one" content="1 matching document">
|
|
|
|
<meta name="lang:search.result.other" content="# matching documents">
|
|
|
|
<meta name="lang:search.tokenizer" content="[\s\-]+">
|
|
|
|
<link rel="shortcut icon" href="../../assets/images/favicon.png">
|
|
<meta name="generator" content="mkdocs-0.17.2, mkdocs-material-2.0.4">
|
|
|
|
|
|
|
|
<title>Getting Started - Vapor Docs</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/application-709eec9410.css">
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/application-23f75ab9c7.palette.css">
|
|
|
|
|
|
|
|
<script src="../../assets/javascripts/modernizr-e826f8942a.js"></script>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
|
|
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
|
|
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body data-md-color-primary="blue" data-md-color-accent="purple">
|
|
|
|
|
|
<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" data-md-component="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-header-nav__button md-logo">
|
|
|
|
<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>
|
|
|
|
|
|
Getting Started
|
|
|
|
</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" role="dialog">
|
|
<label class="md-search__overlay" for="search"></label>
|
|
<div class="md-search__inner">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" required placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
|
|
<label class="md-icon md-search__icon" for="search"></label>
|
|
<button type="reset" class="md-icon md-search__icon" data-md-component="reset"></button>
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="result">
|
|
<div class="md-search-result__meta">
|
|
Type to start searching
|
|
</div>
|
|
<ol class="md-search-result__list"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<div class="md-header-nav__source">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://github.com/vapor/vapor/" 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">
|
|
<span class="md-nav__button md-logo">
|
|
|
|
<img src="../../images/droplet-white.svg" width="24" height="24">
|
|
|
|
</span>
|
|
Vapor Docs
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://github.com/vapor/vapor/" 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">
|
|
Install
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-2">
|
|
Install
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../install/macos/" title="macOS" class="md-nav__link">
|
|
macOS
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../install/ubuntu/" title="Ubuntu" class="md-nav__link">
|
|
Ubuntu
|
|
</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">
|
|
Getting started
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-3">
|
|
Getting started
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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/toolbox/" title="Toolbox" class="md-nav__link">
|
|
Toolbox
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/spm/" title="SPM" class="md-nav__link">
|
|
SPM
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/xcode/" title="Xcode" class="md-nav__link">
|
|
Xcode
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/structure/" title="Folder Structure" class="md-nav__link">
|
|
Folder Structure
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/application/" title="Application" class="md-nav__link">
|
|
Application
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/controllers/" title="Controllers" class="md-nav__link">
|
|
Controllers
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/routing/" title="Routing" class="md-nav__link">
|
|
Routing
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/content/" title="Content" class="md-nav__link">
|
|
Content
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/futures/" title="Futures" class="md-nav__link">
|
|
Futures
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/cloud/" title="Deployment" class="md-nav__link">
|
|
Deployment
|
|
</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">
|
|
Concepts
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-4">
|
|
Concepts
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../concepts/vapor/" title="Vapor" class="md-nav__link">
|
|
Vapor
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../concepts/services/" title="Services" class="md-nav__link">
|
|
Services
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../concepts/http/" title="HTTP" class="md-nav__link">
|
|
HTTP
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../concepts/code-contributions/" title="Code Contributions" class="md-nav__link">
|
|
Code Contributions
|
|
</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">
|
|
Async
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-5">
|
|
Async
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../async/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../async/futures/" title="Futures" class="md-nav__link">
|
|
Futures
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../async/streams/" title="Streams" class="md-nav__link">
|
|
Streams
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../async/eventloop/" title="EventLoop" class="md-nav__link">
|
|
EventLoop
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../async/reactive/" title="Reactive Programming" class="md-nav__link">
|
|
Reactive Programming
|
|
</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">
|
|
HTTP
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-6">
|
|
HTTP
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../http/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</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/client/" title="Client" class="md-nav__link">
|
|
Client
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../http/cookies/" title="Cookies" class="md-nav__link">
|
|
Cookies
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../http/headers/" title="Headers" class="md-nav__link">
|
|
Headers
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../http/method/" title="Methods" class="md-nav__link">
|
|
Methods
|
|
</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/multipart/" title="Multipart" class="md-nav__link">
|
|
Multipart
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../http/status/" title="Status codes" class="md-nav__link">
|
|
Status codes
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../http/uri/" title="URI" class="md-nav__link">
|
|
URI
|
|
</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 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">
|
|
Getting Started
|
|
</label>
|
|
|
|
<a href="./" title="Getting Started" class="md-nav__link md-nav__link--active">
|
|
Getting Started
|
|
</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="#database" title="Database" class="md-nav__link">
|
|
Database
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#fluent" title="Fluent" class="md-nav__link">
|
|
Fluent
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#configuring-fluent" title="Configuring Fluent" class="md-nav__link">
|
|
Configuring Fluent
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#service-provider" title="Service Provider" class="md-nav__link">
|
|
Service Provider
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#config" title="Config" class="md-nav__link">
|
|
Config
|
|
</a>
|
|
|
|
<nav class="md-nav">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#identifier" title="Identifier" class="md-nav__link">
|
|
Identifier
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#databases" title="Databases" class="md-nav__link">
|
|
Databases
|
|
</a>
|
|
|
|
<nav class="md-nav">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#type" title="Type" class="md-nav__link">
|
|
Type
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#instance" title="Instance" class="md-nav__link">
|
|
Instance
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#migrations" title="Migrations" class="md-nav__link">
|
|
Migrations
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#done" title="Done" class="md-nav__link">
|
|
Done
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../models/" title="Models" class="md-nav__link">
|
|
Models
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../migrations/" title="Migrations" class="md-nav__link">
|
|
Migrations
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../querying/" title="Querying" class="md-nav__link">
|
|
Querying
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../query-builder/" title="Query Builder" class="md-nav__link">
|
|
Query Builder
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../schema-builder/" title="Schema Builder" class="md-nav__link">
|
|
Schema Builder
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../migration/" title="Migration" class="md-nav__link">
|
|
Migration
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../relations/" title="Relations" class="md-nav__link">
|
|
Relations
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../pivot/" title="Pivot" class="md-nav__link">
|
|
Pivot
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../transaction/" title="Transaction" class="md-nav__link">
|
|
Transaction
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../database/" title="Database" class="md-nav__link">
|
|
Database
|
|
</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">
|
|
Databases
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-8">
|
|
Databases
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-8-1" type="checkbox" id="nav-8-1">
|
|
|
|
<label class="md-nav__link" for="nav-8-1">
|
|
MongoDB
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
|
<label class="md-nav__title" for="nav-8-1">
|
|
MongoDB
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../databases/mongodb/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../databases/mongodb/bson/" title="BSON" class="md-nav__link">
|
|
BSON
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../databases/mongodb/basics/" title="Basics" class="md-nav__link">
|
|
Basics
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../databases/mongodb/interpreting/" title="Interpreting tutorials" class="md-nav__link">
|
|
Interpreting tutorials
|
|
</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-2" type="checkbox" id="nav-8-2">
|
|
|
|
<label class="md-nav__link" for="nav-8-2">
|
|
MySQL
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="2">
|
|
<label class="md-nav__title" for="nav-8-2">
|
|
MySQL
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../databases/mysql/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../databases/mysql/basics/" title="Basics" class="md-nav__link">
|
|
Basics
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../databases/mysql/prepared-statements/" title="Prepared Statements" class="md-nav__link">
|
|
Prepared Statements
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</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">
|
|
Leaf
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-9">
|
|
Leaf
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../leaf/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../leaf/basics/" title="Basics" class="md-nav__link">
|
|
Basics
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../leaf/custom-tags/" title="Custom tags" class="md-nav__link">
|
|
Custom tags
|
|
</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/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../redis/basics/" title="Basics" class="md-nav__link">
|
|
Basics
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../redis/custom-commands/" title="Custom commands" class="md-nav__link">
|
|
Custom commands
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../redis/pub-sub/" title="Publish and Subscribe" class="md-nav__link">
|
|
Publish and Subscribe
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../redis/pipeline/" title="Pipeline" class="md-nav__link">
|
|
Pipeline
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../websocket/websocket/" title="WebSocket" class="md-nav__link">
|
|
WebSocket
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../services/getting-started/" title="Services" class="md-nav__link">
|
|
Services
|
|
</a>
|
|
</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">
|
|
Crypto
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-13">
|
|
Crypto
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../crypto/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../crypto/base64/" title="Base64" class="md-nav__link">
|
|
Base64
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../crypto/hash/" title="Hashes" class="md-nav__link">
|
|
Hashes
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../crypto/mac/" title="Message authentication" class="md-nav__link">
|
|
Message authentication
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../crypto/passwords/" title="Password hashing" class="md-nav__link">
|
|
Password hashing
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../crypto/random/" title="Random" class="md-nav__link">
|
|
Random
|
|
</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">
|
|
Version (3.0-alpha)
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-14">
|
|
Version (3.0-alpha)
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../version/1_5/" title="1.5" class="md-nav__link">
|
|
1.5
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../version/2_0/" title="2.0" class="md-nav__link">
|
|
2.0
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../version/3_0/" title="3.0-alpha" class="md-nav__link">
|
|
3.0-alpha
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../version/support/" title="Support" class="md-nav__link">
|
|
Support
|
|
</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="#database" title="Database" class="md-nav__link">
|
|
Database
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#fluent" title="Fluent" class="md-nav__link">
|
|
Fluent
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#configuring-fluent" title="Configuring Fluent" class="md-nav__link">
|
|
Configuring Fluent
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#service-provider" title="Service Provider" class="md-nav__link">
|
|
Service Provider
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#config" title="Config" class="md-nav__link">
|
|
Config
|
|
</a>
|
|
|
|
<nav class="md-nav">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#identifier" title="Identifier" class="md-nav__link">
|
|
Identifier
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#databases" title="Databases" class="md-nav__link">
|
|
Databases
|
|
</a>
|
|
|
|
<nav class="md-nav">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#type" title="Type" class="md-nav__link">
|
|
Type
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#instance" title="Instance" class="md-nav__link">
|
|
Instance
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#migrations" title="Migrations" class="md-nav__link">
|
|
Migrations
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#done" title="Done" class="md-nav__link">
|
|
Done
|
|
</a>
|
|
|
|
</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/beta/3.0/docs/fluent/getting-started.md" title="Edit this page" class="md-icon md-content__icon"></a>
|
|
|
|
|
|
<h1 id="adding-fluent-to-your-project">Adding Fluent to your Project<a class="headerlink" href="#adding-fluent-to-your-project" title="Permanent link">¶</a></h1>
|
|
<p>Fluent (<a href="https://github.com/vapor/fluent">vapor/fluent</a>) is a type-safe, fast, and easy-to-use ORM built for Swift.
|
|
It takes advantage of Swift's strong type system to provide an elegant API for your database.</p>
|
|
<h2 id="database">Database<a class="headerlink" href="#database" title="Permanent link">¶</a></h2>
|
|
<p>In addition to adding Fluent to your project, you must also add a Fluent compatible database.
|
|
Fluent does not include any databases by default. All official databases have a getting started guide similar to this one.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>database</th>
|
|
<th>library</th>
|
|
<th>driver</th>
|
|
<th>guide</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>PostgreSQL</td>
|
|
<td>vapor/postgres</td>
|
|
<td>vapor/fluent-postgres</td>
|
|
<td><a href="../../databases/postgres/getting-started.md">PostgreSQL → Package</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>MySQL</td>
|
|
<td>vapor/mysql</td>
|
|
<td>vapor/fluent-mysql</td>
|
|
<td><a href="../../databases/mysql/getting-started.md">MySQL → Package</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>SQLite</td>
|
|
<td>vapor/sqlite</td>
|
|
<td>vapor/fluent-sqlite</td>
|
|
<td><a href="../../databases/sqlite/getting-started.md">SQLite → Package</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>MongoDB</td>
|
|
<td>mongokitten/mongokitten</td>
|
|
<td>vapor/fluent-mongokitten</td>
|
|
<td><a href="http://github.com/vapor/fluent-mongokitten/readme.md">README.md</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Tip</p>
|
|
<p>Any database can be made to work with Fluent by conforming to its <a href="../database/">Database</a> protocol.
|
|
For a list of all compatible database types, search GitHub for the <a href="https://github.com/topics/fluent-driver">fluent-driver</a> topic.</p>
|
|
</div>
|
|
<h2 id="fluent">Fluent<a class="headerlink" href="#fluent" title="Permanent link">¶</a></h2>
|
|
<p>After you have added your database driver, simply add the Fluent package to your Package manifest.</p>
|
|
<div class="codehilite"><pre><span></span><span class="c1">// swift-tools-version:4.0</span>
|
|
<span class="kd">import</span> <span class="nc">PackageDescription</span>
|
|
|
|
<span class="kd">let</span> <span class="nv">package</span> <span class="p">=</span> <span class="n">Package</span><span class="p">(</span>
|
|
<span class="n">name</span><span class="p">:</span> <span class="s">"Project"</span><span class="p">,</span>
|
|
<span class="n">dependencies</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">...</span>
|
|
<span class="p">.</span><span class="n">package</span><span class="p">(</span><span class="n">url</span><span class="p">:</span> <span class="s">"https://github.com/vapor/fluent.git"</span><span class="p">,</span> <span class="p">.</span><span class="n">upToNextMajor</span><span class="p">(</span><span class="n">from</span><span class="p">:</span> <span class="s">"3.0.0"</span><span class="p">)),</span>
|
|
<span class="p">],</span>
|
|
<span class="n">targets</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">.</span><span class="n">target</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="s">"Project"</span><span class="p">,</span> <span class="n">dependencies</span><span class="p">:</span> <span class="p">[</span><span class="s">"Fluent"</span><span class="p">,</span> <span class="p">...</span> <span class="p">])</span>
|
|
<span class="p">]</span>
|
|
<span class="p">)</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>If this is your first time adding a dependency, you should read our introduction to <a href="../../getting-started/spm.md">Package.swift</a>.</p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Use <code>import Fluent</code> to access Fluent's APIs.</p>
|
|
</div>
|
|
<p>Once you have Fluent added to your project, you are ready to configure your database(s).</p>
|
|
<h2 id="configuring-fluent">Configuring Fluent<a class="headerlink" href="#configuring-fluent" title="Permanent link">¶</a></h2>
|
|
<p>Fluent integrates seamlessly into your Vapor project using <a href="../../getting-started/application/#services">services</a>.
|
|
In this section we will add the Fluent service provider to your application and configure your databases.</p>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Warning</p>
|
|
<p>This section assumes you have added both <a href="./#fluent">Fluent</a> and a <a href="./#database">Fluent database</a> to your package.</p>
|
|
</div>
|
|
<h2 id="service-provider">Service Provider<a class="headerlink" href="#service-provider" title="Permanent link">¶</a></h2>
|
|
<p>The first step to using Fluent, is registering it with your Vapor application.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">import</span> <span class="nc">Fluent</span>
|
|
|
|
<span class="p">...</span>
|
|
|
|
<span class="k">try</span> <span class="n">services</span><span class="p">.</span><span class="n">instance</span><span class="p">(</span><span class="n">FluentProvider</span><span class="p">())</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>Register the <code>FluentProvider</code> in the <a href="../../getting-started/structure/#configure">configure section</a> of your application.</p>
|
|
<div class="admonition question">
|
|
<p class="admonition-title">Question</p>
|
|
<p>Learn more about how service providers work in <a href="../../getting-started/application/#providers">Getting Started: Application</a>
|
|
and <a href="../../concepts/services/#providers">Concepts: Services</a>.</p>
|
|
</div>
|
|
<h2 id="config">Config<a class="headerlink" href="#config" title="Permanent link">¶</a></h2>
|
|
<p>Once the service provider has been added, we can configure one or more databases
|
|
to be used with Fluent.</p>
|
|
<h3 id="identifier">Identifier<a class="headerlink" href="#identifier" title="Permanent link">¶</a></h3>
|
|
<p>Each database you use with Fluent must have a unique identifier. The easiest way to
|
|
keep track of this identifier is to add it as static extension to <code>DatabaseIdentifier</code>.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">import</span> <span class="nc">Fluent</span>
|
|
<span class="kd">import</span> <span class="nc">FluentMySQL</span>
|
|
<span class="kd">import</span> <span class="nc">FluentSQLite</span>
|
|
|
|
<span class="kd">extension</span> <span class="nc">DatabaseIdentifier</span> <span class="p">{</span>
|
|
<span class="kd">static</span> <span class="kd">var</span> <span class="nv">foo</span><span class="p">:</span> <span class="n">DatabaseIdentifier</span><span class="p"><</span><span class="n">SQLiteDatabase</span><span class="p">></span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="p">.</span><span class="kd">init</span><span class="p">(</span><span class="s">"foo"</span><span class="p">)</span>
|
|
<span class="p">}</span>
|
|
|
|
<span class="kd">static</span> <span class="kd">var</span> <span class="nv">bar</span><span class="p">:</span> <span class="n">DatabaseIdentifier</span><span class="p"><</span><span class="n">MySQLDatabase</span><span class="p">></span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="p">.</span><span class="kd">init</span><span class="p">(</span><span class="s">"bar"</span><span class="p">)</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>Now we can use the identifier anywhere in our project:</p>
|
|
<div class="codehilite"><pre><span></span><span class="n">req</span><span class="p">.</span><span class="n">database</span><span class="p">(.</span><span class="n">foo</span><span class="p">)</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>The <a href="../../getting-started/structure/#configure">configure section</a> of your project is a good place to put this extension.</p>
|
|
<h3 id="databases">Databases<a class="headerlink" href="#databases" title="Permanent link">¶</a></h3>
|
|
<p>Now that we have created a unique identifier for our database, we can register it
|
|
to our application using <code>DatabaseConfig</code>. A good place to do this is in the
|
|
<a href="../../getting-started/structure/#configure">configure section</a> of your project.</p>
|
|
<p>You can add databases to the <code>DatabaseConfig</code> using either a type (<code>.self</code>) or an instance.</p>
|
|
<h4 id="type">Type<a class="headerlink" href="#type" title="Permanent link">¶</a></h4>
|
|
<p>If you register a database type (like <code>SQLiteDatabase.self</code>), Fluent will ask the application
|
|
to create an instance of your database at boot.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">import</span> <span class="nc">Fluent</span>
|
|
<span class="kd">import</span> <span class="nc">FluentSQLite</span>
|
|
|
|
<span class="p">...</span>
|
|
|
|
<span class="kd">var</span> <span class="nv">databaseConfig</span> <span class="p">=</span> <span class="n">DatabaseConfig</span><span class="p">()</span>
|
|
|
|
<span class="n">databaseConfig</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">database</span><span class="p">:</span> <span class="n">SQLiteDatabase</span><span class="p">.</span><span class="kc">self</span><span class="p">,</span> <span class="k">as</span><span class="p">:</span> <span class="p">.</span><span class="n">foo</span><span class="p">)</span>
|
|
|
|
<span class="n">services</span><span class="p">.</span><span class="n">instance</span><span class="p">(</span><span class="n">databaseConfig</span><span class="p">)</span>
|
|
</pre></div>
|
|
|
|
|
|
<h4 id="instance">Instance<a class="headerlink" href="#instance" title="Permanent link">¶</a></h4>
|
|
<p>You can also register a pre-initialized database. This is especially useful if you'd
|
|
like to configure two instances of the same database type.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">import</span> <span class="nc">Fluent</span>
|
|
<span class="kd">import</span> <span class="nc">FluentMySQL</span>
|
|
|
|
<span class="p">...</span>
|
|
|
|
<span class="kd">var</span> <span class="nv">databaseConfig</span> <span class="p">=</span> <span class="n">DatabaseConfig</span><span class="p">()</span>
|
|
|
|
<span class="kd">let</span> <span class="nv">mysql</span> <span class="p">=</span> <span class="n">MySQLDatabase</span><span class="p">(...)</span>
|
|
<span class="n">databaseConfig</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">database</span><span class="p">:</span> <span class="n">mysql</span><span class="p">,</span> <span class="k">as</span><span class="p">:</span> <span class="p">.</span><span class="n">bar</span><span class="p">)</span>
|
|
|
|
<span class="n">services</span><span class="p">.</span><span class="n">instance</span><span class="p">(</span><span class="n">databaseConfig</span><span class="p">)</span>
|
|
</pre></div>
|
|
|
|
|
|
<h3 id="migrations">Migrations<a class="headerlink" href="#migrations" title="Permanent link">¶</a></h3>
|
|
<p>If your database uses schemas (most SQL databases do, whereas NoSQL databases don't), you will also want to configure
|
|
your migrations using <code>MigrationConfig</code>.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">import</span> <span class="nc">Fluent</span>
|
|
|
|
<span class="p">...</span>
|
|
|
|
<span class="kd">var</span> <span class="nv">migrationConfig</span> <span class="p">=</span> <span class="n">MigrationConfig</span><span class="p">()</span>
|
|
|
|
<span class="n">migrationConfig</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">migration</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="n">database</span><span class="p">:</span> <span class="p">.</span><span class="n">foo</span><span class="p">)</span>
|
|
|
|
<span class="n">services</span><span class="p">.</span><span class="n">instance</span><span class="p">(</span><span class="n">migrationConfig</span><span class="p">)</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>You can read more about migrations in <a href="../migrations/">Fluent: Migrations</a>.</p>
|
|
<h2 id="done">Done<a class="headerlink" href="#done" title="Permanent link">¶</a></h2>
|
|
<p>You should now be able to compile and run your application. The next step is to create your models.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-nav">
|
|
<nav class="md-footer-nav__inner md-grid">
|
|
|
|
<a href="../../http/uri/" title="URI" 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>
|
|
URI
|
|
</span>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
<a href="../models/" title="Models" 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>
|
|
Models
|
|
</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 © 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>
|
|
|
|
<a href="https://github.com/vapor" class="md-footer-social__link fa fa-github"></a>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
|
|
<script src="../../assets/javascripts/application-8e4952e681.js"></script>
|
|
|
|
<script>app.initialize({version:"0.17.2",url:{base:"../.."}})</script>
|
|
|
|
|
|
|
|
|
|
<script>!function(e,t,a,n,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(a),i=t.getElementsByTagName(a)[0],c.async=1,c.src=n,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)})});var query=document.forms.search.query;query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script>
|
|
|
|
|
|
</body>
|
|
</html> |