OHMySQL
β β Every star is appreciated! β β
The library supports Objective-C and Swift, iOS and macOS. You can connect to your remote MySQL database using OHMySQL API. It allows you doing queries in easy and object-oriented way. Common queries such as SELECT, INSERT, DELETE, JOIN are wrapped by Objective-C code and you don't need to dive into MySQL C API.
Goal
If you are interested in and want to know how it can be applied in your project too.
Features
- Easy to integrate and use
- Many functionality features
- Requires minimal knowledge in SQL
- Supports iOS and macOS
- Clean code with unit tests
- Complete documentation and support
Requirements
- iOS 8.0+ / macOS 10.9+
- Xcode 8.1+
How To Get Started
- To test locally you can install MySQL or MAMP local server.
- Try to use OHMySQL API (set up demo project, read documentation).
- When it'll be ready then transfer your local Data Base(s) to remote MySQL server.
Installation
You can use CocoaPods. Add the following line to your Podfile:
pod 'OHMySQL'
If you are using Swift do not forget to add use_frameworks! at the top of Podfile. Add platform, example platform :osx, '10.10'.
Usage
At the first you need to connect to the database.
Objective-C version:
OHMySQLUser *user = [[OHMySQLUser alloc] initWithUserName:@"root"
password:@"root"
serverName:@"localhost"
dbName:@"sample"
port:3306
socket:@"/Applications/MAMP/tmp/mysql/mysql.sock"];
OHMySQLStoreCoordinator *coordinator = [[OHMySQLStoreCoordinator alloc] initWithUser:user];
[coordinator connect];
Swift version:
let user = OHMySQLUser(userName: "root", password: "root", serverName: "localhost", dbName: "ohmysql", port: 3306, socket: "/Applications/MAMP/tmp/mysql/mysql.sock")
let coordinator = OHMySQLStoreCoordinator(user: user!)
coordinator.encoding = .UTF8MB4
coordinator.connect()
To end a connection:
[coordinator disconnect];
coordinator.disconnect()
Query Context
To execute a query you have to create the context:
OHMySQLQueryContext *queryContext = [OHMySQLQueryContext new];
queryContext.storeCoordinator = coordinator;
let context = OHMySQLQueryContext()
context.storeCoordinator = coordinator
You will use this context to execute queries or manipulate the objects.
SELECT
The response contains array of dictionaries (like JSON).
OHMySQLQueryRequest *query = [OHMySQLQueryRequestFactory SELECT:@"tasks" condition:nil];
NSError *error = nil;
NSArray *tasks = [queryContext executeQueryRequestAndFetchResult:query error:&error];
let query = OHMySQLQueryRequestFactory.select("tasks", condition: nil)
let response = try? OHMySQLContainer.shared.mainQueryContext?.executeQueryRequestAndFetchResult(query)
You will get a response like this:
[{ @"id": @1, @"name": @"Task name", @"description": @"Task description", @"status": [NSNull null] }]
INSERT
OHMySQLQueryRequest *query = [OHMySQLQueryRequestFactory INSERT:@"tasks" set:@{ @"name": @"Something", @"desctiption": @"new task" }];
NSError error;
[queryContext executeQueryRequest:query error:&error];
let query = OHMySQLQueryRequestFactory.insert("tasks", set: ["name": "Something", "desctiption": "new task"])
try? mainQueryContext?.execute(query)
UPDATE
OHMySQLQueryRequest *query = [OHMySQLQueryRequestFactory UPDATE:@"tasks" set:@{ @"name": @"Something", @"description": @"new task update" } condition:@"id=5"];
NSError error;
[queryContext executeQueryRequest:query error:&error];
let query = OHMySQLQueryRequestFactory.update("tasks", set: ["name": "Something"], condition: "id=7")
try? mainQueryContext?.execute(query)
DELETE
OHMySQLQueryRequest *query = [OHMySQLQueryRequestFactory DELETE:@"tasks" condition:@"id=10"];
NSError error;
[queryContext executeQueryRequest:query error:&error];
let query = OHMySQLQueryRequestFactory.delete("tasks", condition: "id=10")
try? mainQueryContext?.execute(query)
JOINs
The response contains array of dictionaries (like JSON). You can do 4 types of joins (INNER, RIGHT, LEFT, FULL) using string constants.
OHMySQLQueryRequest *query = [OHMySQLQueryRequestFactory JOINType:OHJoinInner fromTable:@"tasks"
columnNames:@[@"id", @"name", @"description"]
joinOn:@{ @"subtasks":@"tasks.id=subtasks.parentId" }];
NSArray *results = [queryContext executeQueryRequestAndFetchResult:query error:nil];
let query = OHMySQLQueryRequestFactory.joinType(OHJoinInner, fromTable: "tasks", columnNames: ["id", "name", "description"], joinOn: ["subtasks": "tasks.id=subtasks.parentId"])
let result = try? mainQueryContext?.executeQueryRequestAndFetchResult(query)
Object Mapping
You have to implement the protocol OHMappingProtocol for your models. Insertion looks like the following (in this example the NSManagedObject instance). The library has only a primary logic for mapping, so I would recommend you writing a mapping logic by yourself. If you are using Swift you cannot use fundamental number types (Int, Double), only NSNumber (due to run-time).
[queryContext insertObject:task];
BOOL result = [queryContext save:nil];
mainQueryContext?.insertObject(task)
try? mainQueryContext?.save()
You can update/delete the objects easily.
// You don't need to specify primary index here. It'll be update for you.
OHTask *task = [OHTask new];
task.name = @"Code cleanup";
task.taskDescription = @"Delete unused classes and files";
task.status = 0;
[queryContext updateObject:task];
...
task.name = @"Something";
task.status = 1;
[task update];
...
[queryContext deleteObject:task];
BOOL result = [queryContext save:nil];
let task = Task()
task.name = "sample"
mainQueryContext?.updateObject(task)
mainQueryContext?.deleteObject(task)
try? mainQueryContext?.save()
Communication
- If you found a bug, have suggestions or need help, please, open an issue.
- If you want to contribute, submit a pull request.
- If you need help, write me [email protected].
- Make me feel happier ;]
License
OHMySQL is released under the MIT license. See LICENSE for details.
![[Query] Is there a mechanism for connection timeout if the server we are attempting to connect is unavailable?](https://avatars.githubusercontent.com/u/18374601?v=4)
15 Apr 9, 2022
17 Sep 24, 2022
0 Dec 31, 2021
35 Dec 1, 2022
15.7k Jan 1, 2023
9.6k Jan 8, 2023
1.8k Jan 6, 2023
2 Sep 15, 2021
0 Oct 14, 2021
3 Sep 22, 2022
102 Dec 29, 2022
0 Nov 28, 2021
0 Dec 30, 2021
0 Feb 7, 2022
91 Sep 9, 2022
65 Oct 23, 2022
489 Sep 9, 2022
4 Sep 17, 2022
3 Aug 23, 2022