vmanot/swiftdb

A modern database abstraction layer + runtime, batteries included [WIP].

SwiftDB [WIP]

Important

This package is under development and is being currently rewritten to fully leverage Swift 5.9.

A modern, type-safe database abstraction layer. SwiftDB aims to be an opinionated DBAL for relational and document-oriented databases.

Get Started

Define an Entity:

struct Foo: Entity, Identifiable {
    @Attribute var bar: String = "Untitled"
    
    var id: some Hashable {
        bar
    }
}

Define a Schema:

struct MySchema: Schema {
    var entities: Entities {
        Foo.self
    }
}

Create a ContentView for your application:

struct ContentView: View {
    @StateObject var container = PersistentContainer(MySchema())
    
    var body: some View {
        Text("Hello World")
    }
}

Create a list view:

struct ListView: View {
    @EnvironmentObject var container: PersistentContainer
    
    @QueryModels<Foo>() var models
    
    var body: some View {
        NavigationView {
            List(models) { foo in
                NavigationLink(destination: EditView(foo: foo)) {
                    Text(foo.bar)
                }
                .contextMenu {
                    Button {
                        container.delete(foo)
                    } label: {
                        Text("Delete")
                    }
                }
            }
            .navigationBarItems(
                trailing: Button {
                    container.create(Foo.self)
                } label: {
                    Image(systemName: .plusCircleFill)
                        .imageScale(.large)
                }
            )
            .navigationBarTitle("A List of Foo")
        }
    }
    
    struct EditView: View {
        @EnvironmentObject var container: PersistentContainer
        
        let foo: Foo
        
        var body: some View {
            VStack {
                Form {
                    TextField("Enter a value", text: foo.$bar) {
                        container.save()
                    }
                }
            }
            .navigationBarTitle("Edit Foo")
        }
    }
}

Add it to our ContentView:

struct ContentView: View {
    @StateObject var container = PersistentContainer(MySchema())
    
    var body: some View {
        ListView()
            .databaseContainer(container)
    }
}

That's it.

swiftdb's Issues

Update for app delegate adaptor

If you use UIApplicationDelegateAdaptor then you don't need to wrap a NSPersistentContainer in an ObservableObject and you can save on applicationDidEnterBackground and in an App struct you can set delegate.persistentContainer.viewContext on the Environment. You could subclass NSPersistentContainer/NSPersistentCloudKitContainer (which is what it is designed for) and that would still allow loading other stores for additional model configurations, which is essential for CloudKit containers.

License information

Hi Vatsal,

Apologies if this information is available elsewhere and I have overlooked it. What is the license you make this source available under if any?

Dose SwiftDB depends on CoreData?

Dose SwiftDB depends on CoreData? if yes, can we also extend it to support CloudKit?

Usage example

Are there any examples anywhere on how to actually use this? I tried making a new coredata app in Xcode and following the README but am getting errors in multiple places.

This line:
.databaseContainer(container)
Says databaseContainer is not an options for ListView

"PersistentContainer" cannot be found

"Entities" cannot be found

RawRepresentable conditional conformance to NSPrimitiveAttributeCoder isn't actually there.

SwiftDB/Sources/Intermodular/Helpers/CoreData/NSPrimitiveAttributeCoder.swift

Line 73 in 87174a7

extension RawRepresentable where RawValue: NSPrimitiveAttributeCoder {

You did all the preparation for it, but you forgot that actual ": NSPrimitiveAttributeCoder" part.

Segmentation fault: 11 on archive

I just cannot catch a fucking break.

NSPersistentCloudKitContainer Support

It would be great if there was an option to use NSPersistentCloudKitContainer instead of NSPersistentContainer. It would allow for easier CloudKit support.