https://github.com/vapor-community/postgresql
Robust PostgreSQL interface for Swift
https://github.com/vapor-community/postgresql
postgres swift vapor
Last synced: 5 months ago
JSON representation
Robust PostgreSQL interface for Swift
- Host: GitHub
- URL: https://github.com/vapor-community/postgresql
- Owner: vapor-community
- License: mit
- Archived: true
- Created: 2016-07-13T20:17:43.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-05-18T15:19:18.000Z (over 5 years ago)
- Last Synced: 2025-03-23T00:45:35.884Z (7 months ago)
- Topics: postgres, swift, vapor
- Language: Swift
- Size: 183 KB
- Stars: 131
- Watchers: 17
- Forks: 33
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://swift.org)
[](https://circleci.com/gh/vapor-community/postgresql)
[](https://travis-ci.org/vapor-community/postgresql)
[](https://codecov.io/gh/vapor-community/postgresql)
[](LICENSE)
# PostgreSQL for Swift
## Prerequisites
The PostgreSQL C driver must be installed in order to use this package.
Follow the [README of the cpostgresql repo](https://github.com/vapor-community/cpostgresql/blob/master/README.md) to get started.
## Using PostgreSQL
This section outlines how to import the PostgreSQL package both with or without a Vapor project.
### With Vapor
The easiest way to use PostgreSQL with Vapor is to include the PostgreSQL provider.
```swift
import PackageDescription
let package = Package(
name: "Project",
dependencies: [
.Package(url: "https://github.com/vapor/vapor.git", majorVersion: 2),
.Package(url: "https://github.com/vapor-community/postgresql-provider.git", majorVersion: 2)
],
exclude: [ ... ]
)
```
The PostgreSQL provider package adds PostgreSQL to your project and adds some additional, Vapor-specific conveniences like `drop.postgresql()`.
Using `import PostgreSQLProvider` will import both Fluent and Fluent's Vapor-specific APIs.
### With Fluent
Fluent is a powerful, pure-Swift ORM that can be used with any Server-Side Swift framework. The PostgreSQL driver allows you to use a PostgreSQL database to power your models and queries.
```swift
import PackageDescription
let package = Package(
name: "Project",
dependencies: [
...
.Package(url: "https://github.com/vapor/fluent.git", majorVersion: 2),
.Package(url: "https://github.com/vapor-community/postgresql-driver.git", majorVersion: 2)
],
exclude: [ ... ]
)
```
Use `import PostgreSQLDriver` to access the `PostgreSQLDriver` class which you can use to initialize a Fluent `Database`.
### Just PostgreSQL
At the core of the PostgreSQL provider and PostgreSQL driver is a Swift wrapper around the C PostgreSQL client. This package can be used by itself to send raw, parameterized queries to your PostgreSQL database.
```swift
import PackageDescription
let package = Package(
name: "Project",
dependencies: [
...
.Package(url: "https://github.com/vapor/postgresql.git", majorVersion: 2)
],
exclude: [ ... ]
)
```
Use `import PostgreSQL` to access the `PostgreSQL.Database` class.
# Examples
## Connecting to the Database
```swift
import PostgreSQL
let postgreSQL = PostgreSQL.Database(
hostname: "localhost",
database: "test",
user: "root",
password: ""
)
```
## Select
```swift
let version = try postgreSQL.execute("SELECT version()")
```
## Prepared Statement
The second parameter to `execute()` is an array of `PostgreSQL.Value`s.
```swift
let results = try postgreSQL.execute("SELECT * FROM users WHERE age >= $1", [.int(21)])
```
## Listen and Notify
```swift
try postgreSQL.listen(to: "test_channel") { notification in
print(notification.channel)
print(notification.payload)
}
// Allow set up time for LISTEN
sleep(1)
try postgreSQL.notify(channel: "test_channel", payload: "test_payload")
```
## Connection
Each call to `execute()` creates a new connection to the PostgreSQL database. This ensures thread safety since a single connection cannot be used on more than one thread.
If you would like to re-use a connection between calls to execute, create a reusable connection and pass it as the third parameter to `execute()`.
```swift
let connection = try postgreSQL.makeConnection()
let result = try postgreSQL.execute("SELECT * FROM users WHERE age >= $1", [.int(21)]), connection)
```
## Contributors
Maintained by [Steven Roebert](https://github.com/sroebert), [Nate Bird](https://twitter.com/natesbird), [Prince Ugwuh](https://twitter.com/Prince2k3), and other members of the Vapor community.