Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/novi/mysql-swift
A type safe MySQL client for Swift
https://github.com/novi/mysql-swift
linux mysql mysql-client server-side-swift swift
Last synced: 29 days ago
JSON representation
A type safe MySQL client for Swift
- Host: GitHub
- URL: https://github.com/novi/mysql-swift
- Owner: novi
- License: mit
- Created: 2015-12-17T07:50:09.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-29T14:59:46.000Z (about 1 year ago)
- Last Synced: 2024-11-07T11:25:11.283Z (about 1 month ago)
- Topics: linux, mysql, mysql-client, server-side-swift, swift
- Language: Swift
- Homepage:
- Size: 682 KB
- Stars: 163
- Watchers: 14
- Forks: 40
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- fucking-awesome-swift - MySQL Swift - MySQL client library. (Libs / Data Management)
- awesome-swift - MySQL Swift - MySQL client library. (Libs / Data Management)
- awesome-swift - MySQL Swift - A type safe MySQL client for Swift (Data Management [🔝](#readme))
- awesome-swift - MySQL Swift - MySQL client library. (Libs / Data Management)
README
mysql-swift
===========
**This library is obsolete and not maintained. Use [MySQLNIO](https://github.com/vapor/mysql-nio) instead.**
[](https://circleci.com/gh/novi/mysql-swift)
MySQL client library for Swift.
This is inspired by Node.js' [mysql](https://github.com/mysqljs/mysql).
* Based on libmysqlclient
* Raw SQL query
* Simple query formatting and escaping (same as Node's)
* Mapping queried results to `Codable` structs or classes
_Note:_ No asynchronous I/O support currently. It depends libmysqlclient.
```swift
// Declare a model
struct User: Codable, QueryParameter {
let id: Int
let userName: String
let age: Int?
let status: Status
let createdAt: Date
enum Status: String, Codable {
case created = "created"
case verified = "verified"
}
private enum CodingKeys: String, CodingKey {
case id
case userName = "user_name"
case age
case status = "status"
case createdAt = "created_at"
}
}
// Selecting
let nameParam = "some one"
let ids: [QueryParameter] = [1, 2, 3, 4, 5, 6]
let optionalInt: Int? = nil
let rows: [User] = try conn.query("SELECT id,user_name,status,status,created_at FROM `user` WHERE (age > ? OR age is ?) OR name = ? OR id IN (?)", [50, optionalInt, nameParam, QueryArray(ids)] ])
// Inserting
let age: Int? = 26
let user = User(id: 0, userName: "novi", age: age, status: .created, createdAt: Date())
let status = try conn.query("INSERT INTO `user` SET ?", [user]) as QueryStatus
let newId = status.insertedId
// Updating
let tableName = "user"
let defaultAge = 30
try conn.query("UPDATE ?? SET age = ? WHERE age is NULL;", [tableName, defaultAge])
```
# Requirements
* Swift 5.0 or later
* MariaDB or MySQL Connector/C (libmysqlclient) 2.2.3 or later
## macOS
Install pkg-config `.pc` file in [cmysql](https://github.com/vapor-community/cmysql) or [cmysql-mariadb](https://github.com/novi/cmysql-mariadb/tree/mariadb).
```sh
# cmysql
$ brew tap novi/tap
$ brew install novi/tap/cmysql
# cmysql-mariadb
$ brew tap novi/tap
$ brew install novi/tap/cmysqlmariadb
```
## Ubuntu
* Install `libmariadbclient`
* Follow [Setting up MariaDB Repositories](https://downloads.mariadb.org/mariadb/repositories/#mirror=yamagata-university) and set up your repository.
```sh
$ sudo apt-get install libmariadbclient-dev
```
# Installation
## Swift Package Manager
* Add `mysql-swift` to `Package.swift` of your project.
```swift
// swift-tools-version:5.2
import PackageDescription
let package = Package(
...,
dependencies: [
.package(url: "https://github.com/novi/mysql-swift.git", .upToNextMajor(from: "0.9.0"))
],
targets: [
.target(
name: "YourAppOrLibrary",
dependencies: [
// add a dependency
.product(name: "MySQL", package: "mysql-swift")
]
)
]
)
```
# Usage
## Connection & Querying
1. Create a pool with options (hostname, port, password,...).
2. Use `ConnectionPool.execute()`. It automatically get and release a connection.
```swift
let option = Option(host: "your.mysql.host"...) // Define and create your option type
let pool = ConnectionPool(option: option) // Create a pool with the option
let rows: [User] = try pool.execute { conn in
// The connection `conn` is held in this block
try conn.query("SELECT * FROM users;") // And it returns result to outside execute block
}
```
## Transaction
```swift
let wholeStaus: QueryStatus = try pool.transaction { conn in
let status = try conn.query("INSERT INTO users SET ?;", [user]) as QueryStatus // Create a user
let userId = status.insertedId // the user's id
try conn.query("UPDATE info SET some_value = ? WHERE some_key = 'latest_user_id' ", [userId]) // Store user's id that we have created the above
}
wholeStaus.affectedRows == 1 // true
```
# License
MIT