mirror
/
vapor-docs
mirror of https://github.com/vapor/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Create async getting started doc

This commit is contained in:
Joe Smith 2018-03-27 20:40:55 -07:00
parent fb3dd9e89f
commit d342368441
2 changed files with 22 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
3.0/docs/async/getting-started.md Normal file
View File

@ -0,0 +1,17 @@
# Getting Started with Async
Vapor is powered by Apple's [SwiftNIO](https://github.com/apple/swift-nio), a powerful non-blocking networking framework. If you are using the fully-powered Vapor framework to create a website, then you will likely not need to use this directly. However, if you are using a lower-level library (like a Database framework) then you will need to understand a little about how it works.
## Workers
Vapor's async abstraction is built on a few pieces, including the async [`Worker`](https://github.com/vapor-community/async/blob/1.0.0-rc.1.1/Sources/Async/EventLoop/Worker.swift). This protocol has an `eventLoop`, which fits nicely with SwiftNIO's constructs.
### Example
You need to create a SwiftNIO [`EventGroup`](https://github.com/apple/swift-nio/blob/master/README.md#eventloops-and-eventloopgroups) that can power the connection:
```
let database = MySQLDatabase(config: config)
let worker = MultiThreadedEventLoopGroup(numThreads: System.coreCount)
let futureConnection = database.makeConnection(on: worker)
```

19
3.0/docs/mysql/core.md
View File

@ -32,7 +32,7 @@ let package = Package(
name: "MyApp",
dependencies: [
/// Any other dependencies ...
// 🐬 Non-blocking, event-driven Swift client for MySQL.
.package(url: "https://github.com/vapor/mysql.git", from: "3.0.0-rc"),
],
@ -64,7 +64,7 @@ import MySQL
try services.register(MySQLProvider())
```
Registering the provider will add all of the services required for MySQL to work properly. It also includes a default database config struct that uses typical development environment credentials.
Registering the provider will add all of the services required for MySQL to work properly. It also includes a default database config struct that uses typical development environment credentials.
You can of course override this config struct if you have non-standard credentials.
@ -111,21 +111,15 @@ As the names imply, `withPooledConnection(to:)` utilizes a connection pool. `wi
### Create (manually)
If you are writing a simple tool and would like to use the `MySQL` wrapper, it is also quite simple. You need to create a SwiftNIO [`EventGroup`](https://github.com/apple/swift-nio/blob/master/README.md#eventloops-and-eventloopgroups) that can power the connection:
```
let database = MySQLDatabase(config: config)
let worker = MultiThreadedEventLoopGroup(numThreads: System.coreCount)
let futureConnection = database.makeConnection(on: worker)
```
If you are writing a simple tool and would like to use the `MySQL` wrapper directly, it is also quite simple. You should read up on Vapor's [async `Worker`](../../async/getting-started.md) to power the connection.
### Simply Query
Use `.simpleQuery(_:)` to perform a query on your MySQL database that does not bind any parameters. Some queries you send to MySQL may actually require that you use the `simpleQuery(_:)` method instead of the parameterized method.
Use `.simpleQuery(_:)` to perform a query on your MySQL database that does not bind any parameters. Some queries you send to MySQL may actually require that you use the `simpleQuery(_:)` method instead of the parameterized method.
!!! note
This method sends and receives data as text-encoded, meaning it is not optimal for transmitting things like integers.
```swift
let rows = req.withPooledConnection(to: .mysql) { conn in
return conn.simpleQuery("SELECT * FROM users;")
@ -159,6 +153,3 @@ print(users) // Future<[[MySQLColumn: MySQLData]]>
You can also provide a callback, similar to simple queries, for handling each row individually.