mirror
/
vapor-docs
mirror of https://github.com/vapor/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
vapor-docs/build/3.0/database-kit/overview/index.html

2424 lines
63 KiB
HTML
Raw Blame History

<!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.pipeline.stopwords" content="True">
<meta name="lang:search.pipeline.trimmer" content="True">
<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.3, mkdocs-material-2.7.0">
<title>Overview - Vapor Docs</title>
<link rel="stylesheet" href="../../assets/stylesheets/application.78aab2dc.css">
<link rel="stylesheet" href="../../assets/stylesheets/application-palette.6079476c.css">
<script src="../../assets/javascripts/modernizr.1aa3b519.js"></script>
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
<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 dir="ltr" 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 19-18.125
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 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.75 8-38.375zM416 260q0 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.5-41.75
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
0-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.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
46.75-30.25t47.25-9.75q12.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>
<a href="#using-database-kit" tabindex="1" class="md-skip">
Skip to content
</a>
<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">
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
<span class="md-header-nav__topic">
Vapor Docs
</span>
<span class="md-header-nav__topic">
Overview
</span>
</div>
</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" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
<label class="md-icon md-search__icon" for="search"></label>
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
&#xE5CD;
</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="48" height="48">
</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/async/" title="Async" class="md-nav__link">
Async
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/services/" title="Services" class="md-nav__link">
Services
</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">
Async
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-4">
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/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-5" type="checkbox" id="nav-5">
<label class="md-nav__link" for="nav-5">
Console
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-5">
Console
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../console/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../console/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">
Command
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-6">
Command
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../command/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../command/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-7" type="checkbox" id="nav-7">
<label class="md-nav__link" for="nav-7">
Core
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-7">
Core
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../core/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</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-8" type="checkbox" id="nav-8">
<label class="md-nav__link" for="nav-8">
Crypto
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-8">
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/digests/" title="Digests" class="md-nav__link">
Digests
</a>
</li>
<li class="md-nav__item">
<a href="../../crypto/ciphers/" title="Ciphers" class="md-nav__link">
Ciphers
</a>
</li>
<li class="md-nav__item">
<a href="../../crypto/asymmetric/" title="Asymmetric" class="md-nav__link">
Asymmetric
</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--active md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9" checked>
<label class="md-nav__link" for="nav-9">
Database Kit
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-9">
Database Kit
</label>
<ul class="md-nav__list" data-md-scrollfix>
<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">
Overview
</label>
<a href="./" title="Overview" class="md-nav__link md-nav__link--active">
Overview
</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="#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>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#connections" title="Connections" class="md-nav__link">
Connections
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pools" title="Pools" class="md-nav__link">
Pools
</a>
</li>
<li class="md-nav__item">
<a href="#new" title="New" class="md-nav__link">
New
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#logging" title="Logging" class="md-nav__link">
Logging
</a>
</li>
<li class="md-nav__item">
<a href="#keyed-cache" title="Keyed Cache" class="md-nav__link">
Keyed Cache
</a>
</li>
<li class="md-nav__item">
<a href="#api-docs" title="API Docs" class="md-nav__link">
API Docs
</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-10" type="checkbox" id="nav-10">
<label class="md-nav__link" for="nav-10">
Fluent
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-10">
Fluent
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../fluent/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/models/" title="Models" class="md-nav__link">
Models
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/migrations/" title="Migrations" class="md-nav__link">
Migrations
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/querying/" title="Querying" class="md-nav__link">
Querying
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/query-builder/" title="Query Builder" class="md-nav__link">
Query Builder
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/schema-builder/" title="Schema Builder" class="md-nav__link">
Schema Builder
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/relations/" title="Relations" class="md-nav__link">
Relations
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/pivot/" title="Pivot" class="md-nav__link">
Pivot
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/transaction/" title="Transaction" class="md-nav__link">
Transaction
</a>
</li>
<li class="md-nav__item">
<a href="../../fluent/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-11" type="checkbox" id="nav-11">
<label class="md-nav__link" for="nav-11">
HTTP
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-11">
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/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/message/" title="Message" class="md-nav__link">
Message
</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">
Leaf
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-12">
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-13" type="checkbox" id="nav-13">
<label class="md-nav__link" for="nav-13">
Logging
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-13">
Logging
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../logging/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../logging/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-14" type="checkbox" id="nav-14">
<label class="md-nav__link" for="nav-14">
Multipart
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-14">
Multipart
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../multipart/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../multipart/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-15" type="checkbox" id="nav-15">
<label class="md-nav__link" for="nav-15">
MySQL
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-15">
MySQL
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../mysql/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../mysql/fluent/" title="Fluent MySQL" class="md-nav__link">
Fluent MySQL
</a>
</li>
<li class="md-nav__item">
<a href="../../mysql/core/" title="MySQL Core" class="md-nav__link">
MySQL Core
</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-16" type="checkbox" id="nav-16">
<label class="md-nav__link" for="nav-16">
PostgreSQL
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-16">
PostgreSQL
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../postgresql/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../postgresql/fluent/" title="Fluent PostgreSQL" class="md-nav__link">
Fluent PostgreSQL
</a>
</li>
<li class="md-nav__item">
<a href="../../postgresql/core/" title="PostgreSQL Core" class="md-nav__link">
PostgreSQL Core
</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">
Redis
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-17">
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 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">
Routing
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-18">
Routing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../routing/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/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">
Service
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-19">
Service
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../service/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../service/services/" title="Services" class="md-nav__link">
Services
</a>
</li>
<li class="md-nav__item">
<a href="../../service/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-20" type="checkbox" id="nav-20">
<label class="md-nav__link" for="nav-20">
SQL
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-20">
SQL
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../sql/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../sql/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-21" type="checkbox" id="nav-21">
<label class="md-nav__link" for="nav-21">
SQLite
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-21">
SQLite
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../sqlite/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../sqlite/fluent/" title="Fluent SQLite" class="md-nav__link">
Fluent SQLite
</a>
</li>
<li class="md-nav__item">
<a href="../../sqlite/core/" title="SQLite Core" class="md-nav__link">
SQLite Core
</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-22" type="checkbox" id="nav-22">
<label class="md-nav__link" for="nav-22">
Template Kit
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-22">
Template Kit
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../template-kit/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</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-23" type="checkbox" id="nav-23">
<label class="md-nav__link" for="nav-23">
Testing
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-23">
Testing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../testing/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</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-24" type="checkbox" id="nav-24">
<label class="md-nav__link" for="nav-24">
URL-Encoded Form
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-24">
URL-Encoded Form
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../url-encoded-form/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../url-encoded-form/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-25" type="checkbox" id="nav-25">
<label class="md-nav__link" for="nav-25">
Validation
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-25">
Validation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../validation/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../validation/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-26" type="checkbox" id="nav-26">
<label class="md-nav__link" for="nav-26">
Vapor
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-26">
Vapor
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../vapor/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/client/" title="Client" class="md-nav__link">
Client
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/content/" title="Content" class="md-nav__link">
Content
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/sessions/" title="Sessions" class="md-nav__link">
Sessions
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/websocket/" title="WebSocket" class="md-nav__link">
WebSocket
</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-27" type="checkbox" id="nav-27">
<label class="md-nav__link" for="nav-27">
WebSocket
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-27">
WebSocket
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../websocket/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../websocket/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-28" type="checkbox" id="nav-28">
<label class="md-nav__link" for="nav-28">
Version (3.0)
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-28">
Version (3.0)
</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" class="md-nav__link">
3.0
</a>
</li>
<li class="md-nav__item">
<a href="../../version/upgrading/" title="Upgrading" class="md-nav__link">
Upgrading
</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="#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>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#connections" title="Connections" class="md-nav__link">
Connections
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#pools" title="Pools" class="md-nav__link">
Pools
</a>
</li>
<li class="md-nav__item">
<a href="#new" title="New" class="md-nav__link">
New
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#logging" title="Logging" class="md-nav__link">
Logging
</a>
</li>
<li class="md-nav__item">
<a href="#keyed-cache" title="Keyed Cache" class="md-nav__link">
Keyed Cache
</a>
</li>
<li class="md-nav__item">
<a href="#api-docs" title="API Docs" class="md-nav__link">
API Docs
</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/master/3.0/docs/database-kit/overview.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>
<h1 id="using-database-kit">Using Database Kit<a class="headerlink" href="#using-database-kit" title="Permanent link">&para;</a></h1>
<p>Database Kit is a framework for configuring and working with database connections. It helps you do things like manage and pool connections, create keyed caches, and log queries. </p>
<p>Many of Vapor's packages such as the Fluent drivers, Redis, and Vapor core are built on top of Database Kit. This guide will walk you through some of the common APIs you might encounter when using Database Kit.</p>
<h2 id="config">Config<a class="headerlink" href="#config" title="Permanent link">&para;</a></h2>
<p>Your first interaction with Database Kit will most likely be with the <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Structs/DatabasesConfig.html"><code>DatabasesConfig</code></a> struct. This type helps you configure one or more databases to your application and will ultimately yield a <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Structs/Databases.html"><code>Databases</code></a> struct. This usually takes place in <a href="../../getting-started/structure/#configureswift"><code>configure.swift</code></a>.</p>
<div class="codehilite"><pre><span></span><span class="c1">// Create a SQLite database.</span>
<span class="kd">let</span> <span class="nv">sqliteDB</span> <span class="p">=</span> <span class="n">SQLiteDatabase</span><span class="p">(...)</span>
<span class="c1">// Create a new, empty DatabasesConfig.</span>
<span class="kd">var</span> <span class="nv">dbsConfig</span> <span class="p">=</span> <span class="n">DatabasesConfig</span><span class="p">()</span>
<span class="c1">// Register the SQLite database using &#39;.sqlite&#39; as an identifier.</span>
<span class="n">dbsConfig</span><span class="p">.</span><span class="n">add</span><span class="p">(</span><span class="n">sqliteDB</span><span class="p">,</span> <span class="k">as</span><span class="p">:</span> <span class="p">.</span><span class="n">sqlite</span><span class="p">)</span>
<span class="c1">// Register more DBs here if you want</span>
<span class="c1">// Register the DatabaseConfig to services.</span>
<span class="n">services</span><span class="p">.</span><span class="n">register</span><span class="p">(</span><span class="n">dbsConfig</span><span class="p">)</span>
</pre></div>
<p>Using the <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Structs/DatabasesConfig.html"><code>add(...)</code></a> methods, you can register <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Protocols/Database.html"><code>Database</code></a>s to the config. You can register instances of a database, a database type, or a closure that creates a database. The latter two methods will be resolved when your container boots.</p>
<p>You can also configure options on your databases, such as enabling logging.</p>
<div class="codehilite"><pre><span></span><span class="c1">// Enable logging on the SQLite database</span>
<span class="n">dbsConfig</span><span class="p">.</span><span class="n">enableLogging</span><span class="p">(</span><span class="k">for</span><span class="p">:</span> <span class="p">.</span><span class="n">sqlite</span><span class="p">)</span>
</pre></div>
<p>See the section on <a href="#logging">logging</a> for more information.</p>
<h3 id="identifier">Identifier<a class="headerlink" href="#identifier" title="Permanent link">&para;</a></h3>
<p>Most database integrations will provide a default <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Structs/DatabaseIdentifier.html"><code>DatabaseIdentifier</code></a> to use. However, you can always create your own. This is usually done by creating a static extension.</p>
<div class="codehilite"><pre><span></span><span class="kd">extension</span> <span class="nc">DatabaseIdentifier</span> <span class="p">{</span>
<span class="c1">/// Test database.</span>
<span class="kd">static</span> <span class="kd">var</span> <span class="nv">testing</span><span class="p">:</span> <span class="n">DatabaseIdentifier</span><span class="p">&lt;</span><span class="n">MySQLDatabase</span><span class="p">&gt;</span> <span class="p">{</span>
<span class="k">return</span> <span class="s">&quot;testing&quot;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<p><code>DatabaseIdentifier</code> is <code>ExpressibleByStringLiteral</code> which allows you to create one with just a <code>String</code>.</p>
<h3 id="databases">Databases<a class="headerlink" href="#databases" title="Permanent link">&para;</a></h3>
<p>Once you have registered a <code>DatabasesConfig</code> to your services and booted a container, you can take advantage of the convenience extensions on <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Extensions/Container.html"><code>Container</code></a> to start creating connections.</p>
<div class="codehilite"><pre><span></span><span class="c1">// Creates a new connection to `.sqlite` db</span>
<span class="n">app</span><span class="p">.</span><span class="n">withNewConnection</span><span class="p">(</span><span class="n">to</span><span class="p">:</span> <span class="p">.</span><span class="n">sqlite</span><span class="p">)</span> <span class="p">{</span> <span class="n">conn</span> <span class="k">in</span>
<span class="k">return</span> <span class="n">conn</span><span class="p">.</span><span class="n">query</span><span class="p">(...)</span> <span class="c1">// do some db query</span>
<span class="p">}</span>
</pre></div>
<p>Read more about creating and managing connections in the next section.</p>
<h2 id="connections">Connections<a class="headerlink" href="#connections" title="Permanent link">&para;</a></h2>
<p>Database Kit's main focus is on creating, managing, and pooling connections. Creating new connections takes a non-trivial amount of time for your application and many cloud services limit the total number of connections to a service that can be open. Because of this, it is important for high-concurrency web applications to manage their connections carefully.</p>
<h3 id="pools">Pools<a class="headerlink" href="#pools" title="Permanent link">&para;</a></h3>
<p>A common solution to connection management is the use of connection pools. These pools usually have a set maximum number of connections that are allowed to be open at once. Each time the pool is asked for a connection, it will first check if one is available before creating a new connection. If none are available, it will create a new one. If no connections are available and the pool is already at its maximum, the request for a new connection will <em>wait</em> for a connection to be returned. </p>
<p>The easiest way to request and release a pooled connection is the method <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Extensions/Container.html#/s:11DatabaseKit20withPooledConnectionXeXeF"><code>withPooledConnection(...)</code></a>. </p>
<div class="codehilite"><pre><span></span><span class="c1">// Requests a pooled connection to `.psql` db</span>
<span class="n">req</span><span class="p">.</span><span class="n">withPooledConnection</span><span class="p">(</span><span class="n">to</span><span class="p">:</span> <span class="p">.</span><span class="n">psql</span><span class="p">)</span> <span class="p">{</span> <span class="n">conn</span> <span class="k">in</span>
<span class="k">return</span> <span class="n">conn</span><span class="p">.</span><span class="n">query</span><span class="p">(...)</span> <span class="c1">// do some db query</span>
<span class="p">}</span>
</pre></div>
<p>This method will requested a pooled connection to the identified database and call the provided closure when the connection is available. When the <code>Future</code> returned by the closure has completed, the connection will automatically be returned to the pool.</p>
<p>If you need access to a connection outside of a closure, you can use the related request / release methods instead.</p>
<div class="codehilite"><pre><span></span><span class="c1">// Request a connection from the pool and wait for it to be ready.</span>
<span class="kd">let</span> <span class="nv">conn</span> <span class="p">=</span> <span class="k">try</span> <span class="n">app</span><span class="p">.</span><span class="n">requestPooledConnection</span><span class="p">(</span><span class="n">to</span><span class="p">:</span> <span class="p">.</span><span class="n">psql</span><span class="p">).</span><span class="n">wait</span><span class="p">()</span>
<span class="c1">// Ensure the connection is released when we exit this scope.</span>
<span class="k">defer</span> <span class="p">{</span> <span class="n">app</span><span class="p">.</span><span class="n">releasePooledConnection</span><span class="p">(</span><span class="n">conn</span><span class="p">,</span> <span class="n">to</span><span class="p">:</span> <span class="p">.</span><span class="n">psql</span><span class="p">)</span> <span class="p">}</span>
</pre></div>
<p>You can configure your connection pools using the <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Structs/DatabaseConnectionPoolConfig.html"><code>DatabaseConnectionPoolConfig</code></a> struct. </p>
<div class="codehilite"><pre><span></span><span class="c1">// Create a new, empty pool config.</span>
<span class="kd">var</span> <span class="nv">poolConfig</span> <span class="p">=</span> <span class="n">DatabaseConnectionPoolConfig</span><span class="p">()</span>
<span class="c1">// Set max connections per pool to 8.</span>
<span class="n">poolConfig</span><span class="p">.</span><span class="n">maxConnections</span> <span class="p">=</span> <span class="mi">8</span>
<span class="c1">// Register the pool config.</span>
<span class="n">services</span><span class="p">.</span><span class="n">register</span><span class="p">(</span><span class="n">poolConfig</span><span class="p">)</span>
</pre></div>
<p>To prevent race conditions, pools are never shared between event loops. There is usually one pool per database per event loop. This means that the amount of connections your application can potentially open to a given database is equal to <code>numThreads * maxConns</code>.</p>
<h3 id="new">New<a class="headerlink" href="#new" title="Permanent link">&para;</a></h3>
<p>You can always create a new connection to your databases if you need to. This will not affect your pooled connections. Creating new connections is especially useful during testing and app boot. But try not to do it in route closures since heavy traffic to your app could end up creating a lot of connections!</p>
<p>Similar to pooled connections, opening and closing new connections can be done using <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Extensions/Container.html#/s:11DatabaseKit17withNewConnectionXeXeF"><code>withNewConnection(...)</code></a>. </p>
<div class="codehilite"><pre><span></span><span class="c1">// Creates a new connection to `.sqlite` db</span>
<span class="n">app</span><span class="p">.</span><span class="n">withNewConnection</span><span class="p">(</span><span class="n">to</span><span class="p">:</span> <span class="p">.</span><span class="n">sqlite</span><span class="p">)</span> <span class="p">{</span> <span class="n">conn</span> <span class="k">in</span>
<span class="k">return</span> <span class="n">conn</span><span class="p">.</span><span class="n">query</span><span class="p">(...)</span> <span class="c1">// do some db query</span>
<span class="p">}</span>
</pre></div>
<p>This method will create a new connection, calling the supplied closure when the connection is open. When the <code>Future</code> returned in the closure completes, the connection will be closed automatically.</p>
<p>You can also simply open a new connection with <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Extensions/Container.html#/s:11DatabaseKit13newConnectionXeXeF"><code>newConnection(...)</code></a>.</p>
<div class="codehilite"><pre><span></span><span class="c1">// Creates a new connection to `.sqlite` db</span>
<span class="kd">let</span> <span class="nv">conn</span> <span class="p">=</span> <span class="k">try</span> <span class="n">app</span><span class="p">.</span><span class="n">newConnection</span><span class="p">(</span><span class="n">to</span><span class="p">:</span> <span class="p">.</span><span class="n">sqlite</span><span class="p">).</span><span class="n">wait</span><span class="p">()</span>
<span class="c1">// Ensure the connection is closed when we exit this scope.</span>
<span class="k">defer</span> <span class="p">{</span> <span class="n">conn</span><span class="p">.</span><span class="n">close</span><span class="p">()</span> <span class="p">}</span>
</pre></div>
<h2 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">&para;</a></h2>
<p>Databases can opt into supporting query logging via the <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Protocols/LogSupporting.html"><code>LogSupporting</code></a> protocol. Databases that conform to this protocol can have loggers <a href="#config">configured</a> via <code>DatabasesConfig</code>.</p>
<div class="codehilite"><pre><span></span><span class="c1">// Enable logging on the SQLite database</span>
<span class="n">dbsConfig</span><span class="p">.</span><span class="n">enableLogging</span><span class="p">(</span><span class="k">for</span><span class="p">:</span> <span class="p">.</span><span class="n">sqlite</span><span class="p">)</span>
</pre></div>
<p>By default, a simple print logger will be used, but you can pass a custom <code>DatabaseLogHandler</code>.</p>
<div class="codehilite"><pre><span></span><span class="c1">// Create a custom log handler.</span>
<span class="kd">let</span> <span class="nv">myLogger</span><span class="p">:</span> <span class="n">DatabaseLogHandler</span> <span class="p">=</span> <span class="p">...</span>
<span class="c1">// Enable logging on SQLite w/ custom logger.</span>
<span class="n">dbsConfig</span><span class="p">.</span><span class="n">enableLogging</span><span class="p">(</span><span class="k">for</span><span class="p">:</span> <span class="p">.</span><span class="n">sqlite</span><span class="p">,</span> <span class="n">logger</span><span class="p">:</span> <span class="n">myLogger</span><span class="p">)</span>
</pre></div>
<p>Log handlers will receive an instance of <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Structs/DatabaseLog.html"><code>DatabaseLog</code></a> for each logged query. This contains information such as the query, parameterized values, database id, and time.</p>
<h2 id="keyed-cache">Keyed Cache<a class="headerlink" href="#keyed-cache" title="Permanent link">&para;</a></h2>
<p>Databases can opt into supporting keyed-caching via the <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Protocols/KeyedCacheSupporting.html"><code>KeyedCacheSupporting</code></a> protocol. Databases that conform to this protocol can be used to create instances of <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Classes/DatabaseKeyedCache.html"><code>DatabaseKeyedCache</code></a>.</p>
<p>Keyed caches are capable of getting, setting, and removing <code>Codable</code> values at keys. They are sometimes called "key value stores".</p>
<p>To create a keyed cache, you can use the extensions on <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Extensions/Container.html#/s:11DatabaseKit10keyedCacheXeXeF"><code>Container</code></a>.</p>
<div class="codehilite"><pre><span></span><span class="c1">// Creates a DatabaseKeyedCache with .redis connection pool</span>
<span class="kd">let</span> <span class="nv">cache</span> <span class="p">=</span> <span class="k">try</span> <span class="n">app</span><span class="p">.</span><span class="n">keyedCache</span><span class="p">(</span><span class="k">for</span><span class="p">:</span> <span class="p">.</span><span class="n">redis</span><span class="p">)</span>
<span class="c1">// Sets &quot;hello&quot; = &quot;world&quot;</span>
<span class="k">try</span> <span class="n">cache</span><span class="p">.</span><span class="kr">set</span><span class="p">(</span><span class="s">&quot;hello&quot;</span><span class="p">,</span> <span class="n">to</span><span class="p">:</span> <span class="s">&quot;world&quot;</span><span class="p">).</span><span class="n">wait</span><span class="p">()</span>
<span class="c1">// Gets &quot;hello&quot;</span>
<span class="kd">let</span> <span class="nv">world</span> <span class="p">=</span> <span class="k">try</span> <span class="n">cache</span><span class="p">.</span><span class="kr">get</span><span class="p">(</span><span class="s">&quot;hello&quot;</span><span class="p">,</span> <span class="k">as</span><span class="p">:</span> <span class="nb">String</span><span class="p">.</span><span class="kc">self</span><span class="p">).</span><span class="n">wait</span><span class="p">()</span>
<span class="bp">print</span><span class="p">(</span><span class="n">world</span><span class="p">)</span> <span class="c1">// &quot;world&quot;</span>
<span class="c1">// Removes &quot;hello&quot;</span>
<span class="k">try</span> <span class="n">cache</span><span class="p">.</span><span class="n">remove</span><span class="p">(</span><span class="s">&quot;hello&quot;</span><span class="p">).</span><span class="n">wait</span><span class="p">()</span>
</pre></div>
<p>See the <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/Protocols/KeyedCache.html"><code>KeyedCache</code></a> protocol for more information.</p>
<h2 id="api-docs">API Docs<a class="headerlink" href="#api-docs" title="Permanent link">&para;</a></h2>
<p>Check out the <a href="https://api.vapor.codes/database-kit/latest/DatabaseKit/index.html">API docs</a> for more in-depth information about DatabaseKit's APIs.</p>
</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="../../fluent/getting-started/" title="Getting Started" 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>
Getting Started
</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; 2018 Qutheory, LLC
</div>
powered by
<a href="http://www.mkdocs.org">MkDocs</a>
and
<a href="https://squidfunk.github.io/mkdocs-material/">
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.8eb9be28.js"></script>
<script>app.initialize({version:"0.17.3",url:{base:"../.."}})</script>
<script>!function(e,a,t,n,o,c,i){e.GoogleAnalyticsObject=o,e.ga=e.ga||function(){(e.ga.q=e.ga.q||[]).push(arguments)},e.ga.l=1*new Date,c=a.createElement(t),i=a.getElementsByTagName(t)[0],c.async=1,c.src="https://www.google-analytics.com/analytics.js",i.parentNode.insertBefore(c,i)}(window,document,"script",0,"ga"),ga("create","UA-76177358-4","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");if(Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var a=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",a,e.href)})}),document.forms.search){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>
Reference in New Issue View Git Blame Copy Permalink