Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agarunov/fetchkit
Lightweight Core Data fetch framework
https://github.com/agarunov/fetchkit
coredata ios macos swift swift-framework tvos watchos
Last synced: 22 days ago
JSON representation
Lightweight Core Data fetch framework
- Host: GitHub
- URL: https://github.com/agarunov/fetchkit
- Owner: Agarunov
- License: bsd-2-clause
- Created: 2017-04-22T16:02:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-23T17:06:18.000Z (about 5 years ago)
- Last Synced: 2024-12-01T12:38:58.827Z (22 days ago)
- Topics: coredata, ios, macos, swift, swift-framework, tvos, watchos
- Language: Swift
- Homepage:
- Size: 63.5 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FetchKit
Lightweight Core Data fetch framework.
With FetchKit you can easily fetch data from store without creating `NSFetchRequest`.
## Usage
Example Core Data entity
```swift
@objc(User)
class User: NSManagedObject {
@NSManaged var id: Int64
@NSManaged var firstName: String?
@NSManaged var lastName: String?
@NSManaged var salary: Int64
}
extension User: QueryProtocol { }
```
### Find first
Find first `User`. Sorted by firstName.
```swift
let user = try? User.findFirst()
.sorted(by: \User.firstName)
.execute(in: context)
```
### Find all
Find all `Users` with first name John
```swift
let allJohns = try? User.findAll()
.where(\User.firstName, equals: "John")
.execute(in: context)
```
### Find range
```swift
let ranged = try? User.findRange(2..<5)
.sorted(by: \User.id)
.execute(in: context)
```
### Get count
```swift
let usersCount = try? User.getCount()
.execute(in: context)
```
### Min
Aggregate minimimum value of entity property
```swift
let minId = try? User.getMin(keyPath: \User.id)
.execute(in: context)
```
### Max
Aggregate maximum value of entity property
```swift
let maxId = try? User.getMax(keyPath: \User.id)
.execute(in: context)
```
### Delete
Delete all `Users` with first name John and returns count
```swift
let deleteCount = try? User.deleteAll()
.where(\User.firstName, equals: "John")
.execute(in: context)
```
### Get Distinct
Fetch dictionaries (instead of managed objects) with specified properties and aggregation functions.
Result can be grouped by properties (SQL GROUP BY)
```swift
let result = try User.getDistinct()
.propertiesToFetch([\User.firstName])
.aggregate(keyPath: \User.salary, function: "sum:", saveAs: "totalSalary")
.group(by: \User.firstName)
.execute(in: context)
```
### Fetched results controller
Return `NSFetchedResultsContoller` and perform fetch
```swift
let userFetchedResults = try? User.fetchResults()
.group(by: \User.firstName)
.sorted(by: \User.firstName)
.sorted(by: \User.lastName)
.execute(in: context)
```
## Requirements
- iOS 8.0+ / macOS 10.9+ / tvOS 9.0+ / watchOS 2.0+
- Xcode 11.0+
- Swift 5.1+
## Installation
### CocoaPods
To integrate FetchKit into your Xcode project using CocoaPods, specify it in your `Podfile`:
```ruby
pod 'FetchKit'
```
## License
FetchKit is released under the BSD license. See [LICENSE](LICENSE).