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

2065 lines
51 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="shortcut icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-0.16.2, mkdocs-material-1.1.1">
<title>Query - Vapor Docs</title>
<script src="../../assets/javascripts/modernizr-56ade86843.js"></script>
<link rel="stylesheet" href="../../assets/stylesheets/application-e5b48ab351.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto Slab:300,400,400i,700|Source+Code+Pro">
<style>body,input{font-family:"Roboto Slab","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Source Code Pro","Courier New",Courier,monospace}</style>
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="../../stylesheets/extra.css">
</head>
<body>
<svg class="md-svg">
<defs>
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
</defs>
</svg>
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="search">
<label class="md-overlay" data-md-component="overlay" for="drawer"></label>
<header class="md-header">
<nav class="md-header-nav md-grid">
<div class="md-flex">
<div class="md-flex__cell md-flex__cell--shrink">
<a href="../.." title="Vapor Docs" class="md-logo md-header-nav__button">
<img src="../../images/droplet-white.svg" width="24" height="24">
</a>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
</div>
<div class="md-flex__cell md-flex__cell--stretch">
<span class="md-flex__ellipsis md-header-nav__title">
<span class="md-header-nav__parent">
Fluent
</span>
Query
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
<div class="md-search" data-md-component="search">
<div class="md-search__overlay"></div>
<div class="md-search__inner">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" placeholder="Search" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
<label class="md-icon md-search__icon" for="search"></label>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="result"></div>
</div>
</div>
</div>
</div>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<div class="md-header-nav__source">
<a href="https://github.com/vapor/documentation" title="Go to repository" class="md-source" data-md-source="github">
<div class="md-source__icon">
<svg viewBox="0 0 24 24" width="24" height="24">
<use xlink:href="#github" width="24" height="24"></use>
</svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container">
<main class="md-main">
<div class="md-main__inner md-grid" data-md-component="container">
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" data-md-level="0">
<label class="md-nav__title md-nav__title--site" for="drawer">
<i class="md-logo md-nav__button">
<img src="../../images/droplet-white.svg">
</i>
Vapor Docs
</label>
<div class="md-nav__source">
<a href="https://github.com/vapor/documentation" title="Go to repository" class="md-source" data-md-source="github">
<div class="md-source__icon">
<svg viewBox="0 0 24 24" width="24" height="24">
<use xlink:href="#github" width="24" height="24"></use>
</svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." title="Overview" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
<label class="md-nav__link" for="nav-2">
Getting started
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-2">
Getting started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../getting-started/install-on-macos/" title="Install: macOS" class="md-nav__link">
Install: macOS
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/install-on-ubuntu/" title="Install: Ubuntu" class="md-nav__link">
Install: Ubuntu
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/toolbox/" title="Toolbox" class="md-nav__link">
Toolbox
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/hello-world/" title="Hello, World" class="md-nav__link">
Hello, World
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/manual/" title="Manual" class="md-nav__link">
Manual
</a>
</li>
<li class="md-nav__item">
<a href="../../getting-started/xcode/" title="Xcode" class="md-nav__link">
Xcode
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
<label class="md-nav__link" for="nav-3">
Vapor
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-3">
Vapor
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../vapor/folder-structure/" title="Folder Structure" class="md-nav__link">
Folder Structure
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/droplet/" title="Droplet" class="md-nav__link">
Droplet
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/views/" title="Views" class="md-nav__link">
Views
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/controllers/" title="Controllers" class="md-nav__link">
Controllers
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/hash/" title="Hash" class="md-nav__link">
Hash
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/log/" title="Log" class="md-nav__link">
Log
</a>
</li>
<li class="md-nav__item">
<a href="../../vapor/commands/" title="Commands" class="md-nav__link">
Commands
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
<label class="md-nav__link" for="nav-4">
Settings
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-4">
Settings
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../settings/config/" title="Config" class="md-nav__link">
Config
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
<label class="md-nav__link" for="nav-5">
JSON
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-5">
JSON
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../json/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../json/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
<label class="md-nav__link" for="nav-6">
Routing
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-6">
Routing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../routing/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/parameters/" title="Parameters" class="md-nav__link">
Parameters
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/group/" title="Group" class="md-nav__link">
Group
</a>
</li>
<li class="md-nav__item">
<a href="../../routing/collection/" title="Collection" class="md-nav__link">
Collection
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7" checked>
<label class="md-nav__link" for="nav-7">
Fluent
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-7">
Fluent
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../model/" title="Model" class="md-nav__link">
Model
</a>
</li>
<li class="md-nav__item">
<a href="../database/" title="Database" class="md-nav__link">
Database
</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">
Query
</label>
<a href="./" title="Query" class="md-nav__link md-nav__link--active">
Query
</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="#make" title="Make" class="md-nav__link">
Make
</a>
</li>
<li class="md-nav__item">
<a href="#fetch" title="Fetch" class="md-nav__link">
Fetch
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#all" title="All" class="md-nav__link">
All
</a>
</li>
<li class="md-nav__item">
<a href="#first" title="First" class="md-nav__link">
First
</a>
</li>
<li class="md-nav__item">
<a href="#chunk" title="Chunk" class="md-nav__link">
Chunk
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#filter" title="Filter" class="md-nav__link">
Filter
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#compare" title="Compare" class="md-nav__link">
Compare
</a>
</li>
<li class="md-nav__item">
<a href="#subset" title="Subset" class="md-nav__link">
Subset
</a>
</li>
<li class="md-nav__item">
<a href="#group" title="Group" class="md-nav__link">
Group
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#complex-example" title="Complex Example" class="md-nav__link">
Complex Example
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#raw" title="Raw" class="md-nav__link">
Raw
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#distinct" title="Distinct" class="md-nav__link">
Distinct
</a>
</li>
<li class="md-nav__item">
<a href="#limit-offset" title="Limit / Offset" class="md-nav__link">
Limit / Offset
</a>
</li>
<li class="md-nav__item">
<a href="#sort" title="Sort" class="md-nav__link">
Sort
</a>
</li>
<li class="md-nav__item">
<a href="#raw_1" title="Raw" class="md-nav__link">
Raw
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../relations/" title="Relations" class="md-nav__link">
Relations
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
<label class="md-nav__link" for="nav-8">
Cache
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-8">
Cache
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../cache/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../cache/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
<label class="md-nav__link" for="nav-9">
MySQL
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-9">
MySQL
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../mysql/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../mysql/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../mysql/driver/" title="Driver" class="md-nav__link">
Driver
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
<label class="md-nav__link" for="nav-10">
Redis
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-10">
Redis
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../redis/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../redis/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11">
<label class="md-nav__link" for="nav-11">
Auth
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-11">
Auth
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../auth/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/getting-started/" title="Getting Started" class="md-nav__link">
Getting Started
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/helper/" title="Helper" class="md-nav__link">
Helper
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/password/" title="Password" class="md-nav__link">
Password
</a>
</li>
<li class="md-nav__item">
<a href="../../auth/persist/" title="Persist" class="md-nav__link">
Persist
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-12" type="checkbox" id="nav-12">
<label class="md-nav__link" for="nav-12">
Sessions
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-12">
Sessions
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../sessions/sessions/" title="Sessions" class="md-nav__link">
Sessions
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-13" type="checkbox" id="nav-13">
<label class="md-nav__link" for="nav-13">
HTTP
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-13">
HTTP
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../http/request/" title="Request" class="md-nav__link">
Request
</a>
</li>
<li class="md-nav__item">
<a href="../../http/response/" title="Response" class="md-nav__link">
Response
</a>
</li>
<li class="md-nav__item">
<a href="../../http/middleware/" title="Middleware" class="md-nav__link">
Middleware
</a>
</li>
<li class="md-nav__item">
<a href="../../http/body/" title="Body" class="md-nav__link">
Body
</a>
</li>
<li class="md-nav__item">
<a href="../../http/response-representable/" title="ResponseRepresentable" class="md-nav__link">
ResponseRepresentable
</a>
</li>
<li class="md-nav__item">
<a href="../../http/responder/" title="Responder" class="md-nav__link">
Responder
</a>
</li>
<li class="md-nav__item">
<a href="../../http/client/" title="Client" class="md-nav__link">
Client
</a>
</li>
<li class="md-nav__item">
<a href="../../http/server/" title="Server" class="md-nav__link">
Server
</a>
</li>
<li class="md-nav__item">
<a href="../../http/cors/" title="CORS" class="md-nav__link">
CORS
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-14" type="checkbox" id="nav-14">
<label class="md-nav__link" for="nav-14">
Leaf
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-14">
Leaf
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../leaf/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../leaf/provider/" title="Provider" class="md-nav__link">
Provider
</a>
</li>
<li class="md-nav__item">
<a href="../../leaf/leaf/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../validation/overview/" title="Validation" class="md-nav__link">
Validation
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-16" type="checkbox" id="nav-16">
<label class="md-nav__link" for="nav-16">
Node
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-16">
Node
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../node/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../node/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-17" type="checkbox" id="nav-17">
<label class="md-nav__link" for="nav-17">
Core
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-17">
Core
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../core/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../core/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-18" type="checkbox" id="nav-18">
<label class="md-nav__link" for="nav-18">
Bits
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-18">
Bits
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../bits/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../bits/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-19" type="checkbox" id="nav-19">
<label class="md-nav__link" for="nav-19">
Debugging
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-19">
Debugging
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../debugging/package/" title="Package" class="md-nav__link">
Package
</a>
</li>
<li class="md-nav__item">
<a href="../../debugging/overview/" title="Overview" class="md-nav__link">
Overview
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-20" type="checkbox" id="nav-20">
<label class="md-nav__link" for="nav-20">
Advanced
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-20">
Advanced
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../advanced/modules/" title="Modules" class="md-nav__link">
Modules
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-21" type="checkbox" id="nav-21">
<label class="md-nav__link" for="nav-21">
Version (2.0)
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-21">
Version (2.0)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../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/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="#make" title="Make" class="md-nav__link">
Make
</a>
</li>
<li class="md-nav__item">
<a href="#fetch" title="Fetch" class="md-nav__link">
Fetch
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#all" title="All" class="md-nav__link">
All
</a>
</li>
<li class="md-nav__item">
<a href="#first" title="First" class="md-nav__link">
First
</a>
</li>
<li class="md-nav__item">
<a href="#chunk" title="Chunk" class="md-nav__link">
Chunk
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#filter" title="Filter" class="md-nav__link">
Filter
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#compare" title="Compare" class="md-nav__link">
Compare
</a>
</li>
<li class="md-nav__item">
<a href="#subset" title="Subset" class="md-nav__link">
Subset
</a>
</li>
<li class="md-nav__item">
<a href="#group" title="Group" class="md-nav__link">
Group
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#complex-example" title="Complex Example" class="md-nav__link">
Complex Example
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#raw" title="Raw" class="md-nav__link">
Raw
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#distinct" title="Distinct" class="md-nav__link">
Distinct
</a>
</li>
<li class="md-nav__item">
<a href="#limit-offset" title="Limit / Offset" class="md-nav__link">
Limit / Offset
</a>
</li>
<li class="md-nav__item">
<a href="#sort" title="Sort" class="md-nav__link">
Sort
</a>
</li>
<li class="md-nav__item">
<a href="#raw_1" title="Raw" class="md-nav__link">
Raw
</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/2.0/docs/fluent/query.md" title="Edit this page" class="md-icon md-content__edit">edit</a>
<h1 id="query">Query<a class="headerlink" href="#query" title="Permanent link">&para;</a></h1>
<p>Fluent's query builder provides a simple interface for creating complex database queries. The <code>Query</code> class itself (raw queries excluded) is the sole method by which Fluent communicates with your database.</p>
<h2 id="make">Make<a class="headerlink" href="#make" title="Permanent link">&para;</a></h2>
<p>You can create a new query builder from any model class.</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">query</span> <span class="p">=</span> <span class="k">try</span> <span class="n">Post</span><span class="p">.</span><span class="n">makeQuery</span><span class="p">()</span>
</pre></div>
<p>You can also create queries from an instance. This is especially useful if you need to use a special
database connection (like for <a href="../database/#Transactions">transactions</a>) to save or update a model.</p>
<div class="codehilite"><pre><span></span><span class="k">guard</span> <span class="kd">let</span> <span class="nv">post</span> <span class="p">=</span> <span class="k">try</span> <span class="n">Post</span><span class="p">.</span><span class="bp">find</span><span class="p">(</span><span class="mi">42</span><span class="p">)</span> <span class="k">else</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="n">post</span><span class="p">.</span><span class="n">content</span> <span class="p">=</span> <span class="s">&quot;Updated&quot;</span>
<span class="kd">let</span> <span class="nv">query</span> <span class="p">=</span> <span class="k">try</span> <span class="n">post</span><span class="p">.</span><span class="n">makeQuery</span><span class="p">(</span><span class="n">conn</span><span class="p">).</span><span class="n">save</span><span class="p">()</span>
</pre></div>
<h2 id="fetch">Fetch<a class="headerlink" href="#fetch" title="Permanent link">&para;</a></h2>
<p>You have multiple options for fetching the results of a query.</p>
<h3 id="all">All<a class="headerlink" href="#all" title="Permanent link">&para;</a></h3>
<p>The simplest option, <code>.all()</code> returns all rows relevant to the query.</p>
<div class="codehilite"><pre><span></span>let users = try User.makeQuery().filter(...).all()
</pre></div>
<h3 id="first">First<a class="headerlink" href="#first" title="Permanent link">&para;</a></h3>
<p>You can take only the first row as well with <code>.first()</code>. </p>
<div class="codehilite"><pre><span></span>let user = try User.makeQuery().filter(...).first()
</pre></div>
<p>Fluent will automatically limit the results to <code>1</code> to increase
the performance of the query.</p>
<h3 id="chunk">Chunk<a class="headerlink" href="#chunk" title="Permanent link">&para;</a></h3>
<p>If you want to fetch a large amount of models from the database, using <code>.chunk()</code> can help reduce the
amount of memory required for the query by fetching chunks of data at a time.</p>
<div class="codehilite"><pre><span></span>User.makeQuery().filter(...).chunk(32) { users in
print(users)
}
</pre></div>
<h2 id="filter">Filter<a class="headerlink" href="#filter" title="Permanent link">&para;</a></h2>
<p>Filters allow you to choose exactly what subset of data you want to modify or fetch. There are three different
types of filters.</p>
<h3 id="compare">Compare<a class="headerlink" href="#compare" title="Permanent link">&para;</a></h3>
<p>Compare filters perform a comparison between a field on your model in the database and a supplied value.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">query</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;age&quot;</span><span class="p">,</span> <span class="p">.</span><span class="n">greaterThanOrEquals</span><span class="p">,</span> <span class="mi">21</span><span class="p">)</span>
</pre></div>
<p>You can also use operators.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">query</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;age&quot;</span> <span class="o">&gt;=</span> <span class="mi">21</span><span class="p">)</span>
</pre></div>
<table>
<thead>
<tr>
<th>Case</th>
<th>Operator</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>.equals</td>
<td>==</td>
<td>Equals</td>
</tr>
<tr>
<td>.greaterThan</td>
<td>&gt;</td>
<td>Greater Than</td>
</tr>
<tr>
<td>.lessThan</td>
<td>&lt;</td>
<td>Less Than</td>
</tr>
<tr>
<td>.greaterThanOrEquals</td>
<td>&gt;=</td>
<td>Greater Than Or Equals</td>
</tr>
<tr>
<td>.lessThanOrEquals</td>
<td>&lt;=</td>
<td>Less Than Or Equals</td>
</tr>
<tr>
<td>.notEquals</td>
<td>!=</td>
<td>Not Equals</td>
</tr>
<tr>
<td>.hasSuffix</td>
<td></td>
<td>Has Suffix</td>
</tr>
<tr>
<td>.hasPrefix</td>
<td></td>
<td>Has Prefix</td>
</tr>
<tr>
<td>.contains</td>
<td></td>
<td>Contains</td>
</tr>
<tr>
<td>.custom(String)</td>
<td></td>
<td>Custom</td>
</tr>
</tbody>
</table>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>You can omit the comparison type for <code>.equals</code>, e.g., <code>query.filter("age", 23)</code></p>
</div>
<h3 id="subset">Subset<a class="headerlink" href="#subset" title="Permanent link">&para;</a></h3>
<p>You can also filter by fields being in a set of data.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">query</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;favoriteColor&quot;</span><span class="p">,</span> <span class="k">in</span><span class="p">:</span> <span class="p">[</span><span class="s">&quot;pink&quot;</span><span class="p">,</span> <span class="s">&quot;blue&quot;</span><span class="p">])</span>
</pre></div>
<p>Or the opposite.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">query</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;favoriteColor&quot;</span><span class="p">,</span> <span class="n">notIn</span><span class="p">:</span> <span class="p">[</span><span class="s">&quot;brown&quot;</span><span class="p">,</span> <span class="s">&quot;black&quot;</span><span class="p">])</span>
</pre></div>
<h3 id="group">Group<a class="headerlink" href="#group" title="Permanent link">&para;</a></h3>
<p>By default, all query filters are joined by AND logic. You can create groups of filters within
your query that are joined with AND or OR logic.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">query</span><span class="p">.</span><span class="n">or</span> <span class="p">{</span> <span class="n">orGroup</span> <span class="k">in</span>
<span class="k">try</span> <span class="n">orGroup</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;age&quot;</span><span class="p">,</span> <span class="p">.</span><span class="n">greaterThan</span><span class="p">,</span> <span class="mi">75</span><span class="p">)</span>
<span class="k">try</span> <span class="n">orGroup</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;age&quot;</span><span class="p">,</span> <span class="p">.</span><span class="n">lessThan</span><span class="p">,</span> <span class="mi">18</span><span class="p">)</span>
<span class="p">}</span>
</pre></div>
<p>This will result in SQL similar to the following:</p>
<div class="codehilite"><pre><span></span><span class="k">SELECT</span> <span class="o">*</span> <span class="k">FROM</span> <span class="o">`</span><span class="n">users</span><span class="o">`</span> <span class="k">WHERE</span> <span class="p">(</span><span class="o">`</span><span class="n">age</span><span class="o">`</span> <span class="o">&gt;</span> <span class="mi">75</span> <span class="k">OR</span> <span class="o">`</span><span class="n">age</span><span class="o">`</span> <span class="o">&lt;</span> <span class="mi">18</span><span class="p">);</span>
</pre></div>
<p><code>.and()</code> is also available in case you need to switch back to joining filters with AND nested inside of an OR.</p>
<h4 id="complex-example">Complex Example<a class="headerlink" href="#complex-example" title="Permanent link">&para;</a></h4>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">users</span> <span class="p">=</span> <span class="k">try</span> <span class="n">User</span>
<span class="p">.</span><span class="n">makeQuery</span><span class="p">()</span>
<span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;planetOfOrigin&quot;</span><span class="p">,</span> <span class="p">.</span><span class="n">greaterThan</span><span class="p">,</span> <span class="s">&quot;Earth&quot;</span><span class="p">)</span>
<span class="p">.</span><span class="n">or</span> <span class="p">{</span> <span class="n">orGroup</span> <span class="k">in</span>
<span class="n">orGroup</span><span class="p">.</span><span class="n">and</span> <span class="p">{</span> <span class="n">andGroup</span> <span class="k">in</span>
<span class="n">andGroup</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;name&quot;</span><span class="p">,</span> <span class="s">&quot;Rick&quot;</span><span class="p">)</span>
<span class="n">andGroup</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;favoriteFood&quot;</span><span class="p">,</span> <span class="s">&quot;Beer&quot;</span><span class="p">)</span>
<span class="p">}</span>
<span class="n">orGroup</span><span class="p">.</span><span class="n">and</span> <span class="p">{</span> <span class="n">andGroup</span> <span class="k">in</span>
<span class="n">andGroup</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;name&quot;</span><span class="p">,</span> <span class="s">&quot;Morty&quot;</span><span class="p">)</span>
<span class="n">andGroup</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="s">&quot;favoriteFood&quot;</span><span class="p">,</span> <span class="s">&quot;Eyeholes&quot;</span><span class="p">)</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">.</span><span class="n">all</span><span class="p">()</span>
</pre></div>
<p>This will result in SQL similar to the following:</p>
<div class="codehilite"><pre><span></span><span class="n">SELECT</span> <span class="o">*</span> <span class="n">FROM</span> <span class="p">`</span><span class="n">users</span><span class="p">`</span>
<span class="n">WHERE</span> <span class="p">`</span><span class="n">planetOfOrigin</span><span class="p">`</span> <span class="p">=</span> <span class="err">&#39;</span><span class="n">Earth</span><span class="err">&#39;</span> <span class="n">AND</span> <span class="p">(</span>
<span class="p">(`</span><span class="n">name</span><span class="p">`</span> <span class="p">=</span> <span class="err">&#39;</span><span class="n">Rick</span><span class="err">&#39;</span> <span class="n">AND</span> <span class="p">`</span><span class="n">favoriteFood</span><span class="p">`</span> <span class="p">=</span> <span class="err">&#39;</span><span class="n">Beer</span><span class="err">&#39;</span><span class="p">)</span>
<span class="n">OR</span> <span class="p">(`</span><span class="n">name</span><span class="p">`</span> <span class="p">=</span> <span class="err">&#39;</span><span class="n">Morty</span><span class="err">&#39;</span> <span class="n">AND</span> <span class="p">`</span><span class="n">favoriteFood</span><span class="p">`</span> <span class="p">=</span> <span class="err">&#39;</span><span class="n">Eyeholes</span><span class="err">&#39;</span><span class="p">)</span>
<span class="p">)</span>
</pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Keep in mind that the AND/OR logic for a group applies only to the filters added <em>within</em> the group. All filters outside of a filter group will be joined by AND.</p>
</div>
<h3 id="raw">Raw<a class="headerlink" href="#raw" title="Permanent link">&para;</a></h3>
<p>Raw filters can be used to filter by values that should not be parameterized.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">query</span><span class="p">.</span><span class="bp">filter</span><span class="p">(</span><span class="n">raw</span><span class="p">:</span> <span class="s">&quot;date &gt;= CURRENT_TIMESTAMP&quot;</span><span class="p">)</span>
</pre></div>
<h2 id="distinct">Distinct<a class="headerlink" href="#distinct" title="Permanent link">&para;</a></h2>
<p>To select only distinct models from the database, add <code>.distinct()</code> to your query.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">query</span><span class="p">.</span><span class="n">distinct</span><span class="p">()</span>
</pre></div>
<h2 id="limit-offset">Limit / Offset<a class="headerlink" href="#limit-offset" title="Permanent link">&para;</a></h2>
<p>To limit or offset your query, use the <code>.limit()</code> method.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">query</span><span class="p">.</span><span class="n">limit</span><span class="p">(</span><span class="mi">20</span><span class="p">,</span> <span class="n">offset</span><span class="p">:</span> <span class="mi">5</span><span class="p">)</span>
</pre></div>
<h2 id="sort">Sort<a class="headerlink" href="#sort" title="Permanent link">&para;</a></h2>
<p>To sort the results of your query, use the <code>.sort()</code> method</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">query</span><span class="p">.</span><span class="bp">sort</span><span class="p">(</span><span class="s">&quot;age&quot;</span><span class="p">,</span> <span class="p">.</span><span class="n">descending</span><span class="p">)</span>
</pre></div>
<h2 id="raw_1">Raw<a class="headerlink" href="#raw_1" title="Permanent link">&para;</a></h2>
<p>Should you need to perform a query that the query builder does not support, you can use the raw query.</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">drop</span><span class="p">.</span><span class="n">database</span><span class="p">?.</span><span class="n">raw</span><span class="p">(</span><span class="s">&quot;SELECT @@version&quot;</span><span class="p">)</span>
</pre></div>
<p>You can also use the database of a given model.</p>
<div class="codehilite"><pre><span></span>User.database?.raw(&quot;SELECT * FROM `users`&quot;)
</pre></div>
<p>Besides providing a more expressive interface for querying your database, the query builder also takes measures to increase security by automatically sanitizing input. Because of this, try to use the query class wherever you can over performing raw queries.</p>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-nav">
<nav class="md-footer-nav__inner md-grid">
<a href="../database/" title="Database" 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>
Database
</span>
</div>
</a>
<a href="../relations/" title="Relations" 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>
Relations
</span>
</div>
<div class="md-flex__cell md-flex__cell--shrink">
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
</div>
</a>
</nav>
</div>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-footer-copyright">
<div class="md-footer-copyright__highlight">
Copyright &copy; 2017 Qutheory, LLC
</div>
powered by
<a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
and
<a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
Material for MkDocs</a>
</div>
<div class="md-footer-social">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<a href="https://twitter.com/@codevapor" class="md-footer-social__link fa fa-twitter"></a>
<a href="http://vapor.team/" class="md-footer-social__link fa fa-slack"></a>
</div>
</div>
</div>
</footer>
</div>
<script src="../../assets/javascripts/application-f6cd941c96.js"></script>
<script>app.initialize({url:{base:"../.."}})</script>
<script>!function(e,t,n,a,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(n),i=t.getElementsByTagName(n)[0],c.async=1,c.src=a,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","UA-76177358-4","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})}),document.forms.search.query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink