Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supabase-community/postgrest-go
Isomorphic Go client for PostgREST. (Now Updating)
https://github.com/supabase-community/postgrest-go
database go golang hacktoberfest postgrest rest-api sponsors watch
Last synced: 2 days ago
JSON representation
Isomorphic Go client for PostgREST. (Now Updating)
- Host: GitHub
- URL: https://github.com/supabase-community/postgrest-go
- Owner: supabase-community
- License: apache-2.0
- Created: 2021-05-23T13:36:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-13T18:18:50.000Z (4 months ago)
- Last Synced: 2024-11-01T18:29:45.130Z (8 days ago)
- Topics: database, go, golang, hacktoberfest, postgrest, rest-api, sponsors, watch
- Language: Go
- Homepage: https://supabase.io
- Size: 1.16 MB
- Stars: 177
- Watchers: 6
- Forks: 27
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Postgrest GO
[](https://github.com/supabase-community/postgrest-go/actions/workflows/golangci.yml) [](https://www.codefactor.io/repository/github/supabase-community/postgrest-go/overview/main)
[](https://raw.githack.com/wiki/supabase-community/postgrest-go/coverage.html)
Golang client for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface.
## Documentation
Full documentation can be found [here](https://pkg.go.dev/github.com/supabase-community/postgrest-go).
### Quick start
Install
```bash
go get github.com/supabase-community/postgrest-go
```
Usage
```go
package main
import (
"fmt"
"github.com/supabase-community/postgrest-go"
)
func main() {
client := postgrest.NewClient("http://localhost:3000/rest/v1", "", nil)
if client.ClientError != nil {
panic(client.ClientError)
}
result := client.Rpc("add_them", "", map[string]int{"a": 12, "b": 3})
if client.ClientError != nil {
panic(client.ClientError)
}
fmt.Println(result)
}
```
## Testing
Some tests are implemented to run against mocked Postgrest endpoints. Optionally, tests can be run against an actual Postgrest instance by setting a `POSTGREST_URL` environment variable to the fully-qualified URL to a Postgrest instance, and, optionally, an `API_KEY` environment variable (if, for example, testing against a local Supabase instance).
A [script](test/seed.sql) is included in the test directory that can be used to seed the test database.
To run all tests:
```bash
go test ./...
```
## Package made possible through the efforts of:
Made with [contrib.rocks](https://contrib.rocks).
## License
This repo is licensed under the [Apache License](LICENSE).
## 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.
[](https://github.com/sponsors/supabase)