supabase-swift
Supabase client for swift. Mirrors the design of supabase-js
Installation
Swift Package Manager:
Add the following lines to your Package.swift file:
let package = Package(
...
dependencies: [
...
.package(name: "Supabase", url: "https://github.com/supabase/supabase-swift.git", .branch("master")), // Add the package
],
targets: [
.target(
name: "YourTargetName",
dependencies: ["Supabase"] // Add as a dependency
)
]
)
If you're using Xcode, use this guide to add supabase-swift to your project. Use https://github.com/supabase/supabase-swift.git for the url when Xcode asks.
Usage
For all requests made for supabase, you will need to initialize a SupabaseClient object.
let client = SupabaseClient(supabaseUrl: "{ Supabase URL }", supabaseKey: "{ Supabase anonymous Key }")
This client object will be used for all the following examples.
Database
Query todo table for all completed todos.
struct Todo: Codable {
var id: String = UUID().uuidString
var label: String
var isDone: Bool = false
}
let query = try client.database.from("todos")
.select()
.eq(column: "isDone", value: "true")
query.execute { [weak self] results in
guard let self = self else { return }
switch results {
case let .success(response):
let todos = try? response.decoded(to: [Todo].self)
print(todos)
case let .failure(error):
print(error.localizedDescription)
}
}
Insert a todo into the database.
let todo = Todo(label: "Example todo!")
let jsonData: Data = try JSONEncoder().encode(todo)
let jsonDict: [String: Any] = try JSONSerialization.jsonObject(with: jsonData, options: .allowFragments))
client.database.from("todos")
.insert(values: jsonDict)
.execute { results in
// Handle response
}
For more query examples visit the Javascript docs to learn more. The API design is a near 1:1 match.
Execute an RPC
do {
try client.database.rpc(fn: "testFunction", parameters: nil).execute { result in
// Handle result
}
} catch {
print("Error executing the RPC: \(error)")
}
Realtime
Realtime docs coming soon
Auth
Auth docs coming soon
Storage
Storage docs coming soon
Contributing
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes and merge
Sponsors
We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves. Thanks to these sponsors who are making the OSS ecosystem better for everyone.
![[tvOS] Allow setting auth tokens manually](https://avatars.githubusercontent.com/u/4962933?v=4)
34 Jul 15, 2022
18 Jun 22, 2022
23 Jan 7, 2023
1 Jan 17, 2022
23 Jan 7, 2023
43 Feb 10, 2022
1.1k Jan 9, 2023
1.2k Dec 25, 2022
235 Dec 17, 2022
4 Oct 20, 2022
1.1k Jan 6, 2023
19 Dec 17, 2022
32 Oct 30, 2022
10 Oct 21, 2022
8 Oct 20, 2022
22 Aug 22, 2022
1 Apr 26, 2022
3 Jul 29, 2022
13 Nov 22, 2022