Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plausiblelabs/pldatabase
SQL database access library for iOS and macOS
https://github.com/plausiblelabs/pldatabase
Last synced: 3 months ago
JSON representation
SQL database access library for iOS and macOS
- Host: GitHub
- URL: https://github.com/plausiblelabs/pldatabase
- Owner: plausiblelabs
- License: bsd-3-clause
- Created: 2013-09-15T21:31:59.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2019-10-08T17:57:28.000Z (about 5 years ago)
- Last Synced: 2024-07-20T11:06:12.486Z (4 months ago)
- Language: Objective-C
- Homepage:
- Size: 7.65 MB
- Stars: 17
- Watchers: 9
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PLDatabase
PLDatabase provides an SQL database access library for Objective-C, focused on SQLite as an application database. The library supports both macOS and iOS development.
## Basic Usage
### Creating a Connection
Open a connection to a database file:
```objectivec
PLSqliteDatabase *db = [[PLSqliteDatabase alloc] initWithPath: @"/path/to/database"];
if (![db openAndReturnError: &error]) {
NSLog(@"Could not open database");
}
```
### Update Statements
Update statements can be executed directly via `-[PLDatabase executeUpdateAndReturnError:statement:...]`:
```objectivec
if (![db executeUpdateAndReturnError: &error statement: @"CREATE TABLE example (id INTEGER)"]) {
NSLog(@"Table creation failed");
}
if (![db executeQueryAndReturnError: &error statement: @"INSERT INTO example (id) VALUES (?)", [NSNumber numberWithInteger: 42]]) {
NSLog(@"Data insert failed");
}
```
### Query Statements
Queries can be executed using `-[PLDatabase executeQueryAndReturnError:statement:...]`. To iterate over the returned results, a instance conforming to the `PLResultSet` protocol will be returned:
```objectivec
id results = [db executeQueryAndReturnError: &error statement: @"SELECT id FROM example WHERE id = ?", [NSNumber numberWithInteger: 42]];
PLResultSetStatus rss;
while ((rss = [results nextAndReturnError: &error]) == PLResultSetStatusRow) {
NSLog(@"Value of column id is %d", [results intForColumn: @"id"]);
}
if (rss != PLResultSetStatusDone) {
NSLog(@"Iterating results failed");
}
// Failure to close the result set will not leak memory, but may
// retain database resources until the instance is deallocated.
[results close];
```
### Prepared Statements
Pre-compilation of SQL statements and advanced parameter binding are supported by `PLPreparedStatement`. A prepared statement can be constructed using `-[PLDatabase prepareStatement:error:]`.
```objectivec
id stmt = [db prepareStatement: @"INSERT INTO example (name, color) VALUES (?, ?)" error: &error];
// Bind the parameters
[stmt bindParameters: @["Widget", @"Blue"]];
// Execute the INSERT
if ([stmt executeUpdateAndReturnError: &error] == NO) {
NSLog(@"INSERT failed");
}
```
### Name-based Parameter Binding
Name-based parameter binding is also supported:
```objectivec
// Prepare the statement
id stmt = [db prepareStatement: @"INSERT INTO test (name, color) VALUES (:name, :color)" error: &error];
// Bind the parameters using a dictionary
[stmt bindParameterDictionary: @{ @"name" : @"Widget", @"color" : @"Blue" }];
// Execute the INSERT
if ([stmt executeUpdateAndReturnError: &error] == NO) {
NSLog(@"INSERT failed");
}
```
## Building
To build your own release binary, build the 'Disk Image' target:
```
$ xcodebuild -configuration Release -target 'Disk Image'
```
This will output a new release disk image containing an embeddable macOS framework and a static iOS framework in `build/Release/Plausible Database-{version}.dmg`.
## License
PLDatabase is provided free of charge under the BSD license, and may be freely integrated with any application. See the LICENSE file for the full license.