Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jensneuse/goprisma
A Go wrapper for prisma to turn databases into GraphQL APIs using Go.
https://github.com/jensneuse/goprisma
golang golang-library golang-package golang-wrapper graphql prisma prisma-binding prisma-client prisma2 rust rust-lang rustlang
Last synced: about 1 month ago
JSON representation
A Go wrapper for prisma to turn databases into GraphQL APIs using Go.
- Host: GitHub
- URL: https://github.com/jensneuse/goprisma
- Owner: jensneuse
- License: apache-2.0
- Created: 2021-05-31T08:06:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-02T08:21:32.000Z (over 2 years ago)
- Last Synced: 2024-09-29T20:41:36.727Z (about 1 month ago)
- Topics: golang, golang-library, golang-package, golang-wrapper, graphql, prisma, prisma-binding, prisma-client, prisma2, rust, rust-lang, rustlang
- Language: Go
- Homepage:
- Size: 217 MB
- Stars: 72
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GoPrisma - a Go wrapper for the Prisma Engines
## What's this?
Introspect a database and use it as a GraphQL API using Go.
Supported Databases:
- [x] SQLite
- [x] PostgreSQL
- [x] MySQL
- [x] MongoDB
- [x] MS SQL Server
- [ ] CockroachDB
## How to use this in production?
It might be obvious, but I just want to make it clear that you should NOT publicly expose your database with this library.
This is only intended for use cases where the GraphQL API is shielded by some other component.
We're using goprisma internally in WunderGraph which adds such a shielding layer,
with authentication, authorization, role-based access control, caching and more.
Additionally, WunderGraph comes with a TypeScript SDK,
so you can introspect multiple databases as well as GraphQL and REST APIs and join them together.
Check out [WunderGraph if you're interested in a production-grade solution](https://wundergraph.com).
Here's a link to the [docs on all supported DataSources](https://wundergraph.com/docs/overview/datasources/overview).
Otherwise, feel free to use this as a go package in your own projects.
### go get
```shell
go get github.com/jensneuse/goprisma
```
### Introspect a database
```go
prismaSchema := "datasource db {provider = \"postgresql\" url = \"postgresql://admin:admin@localhost:54321/example?schema=public&connection_limit=20&pool_timeout=5\"}"
schema, sdl, err := Introspect(prismaSchema)
```
### Make a Query
```go
query := "{\"query\": \"query Messages {findManymessages(take: 20 orderBy: [{id: desc}]){id message users {id name}}}","variables\": {}}"
engine, err := NewEngine(schema)
if err != nil {
return
}
defer engine.Close()
response := engine.Execute(query)
```
## Why?
GraphQL is a nice abstraction layer on top of other APIs.
Making databases available can be a productivity gainer when no direct database access is required and GraphQL clients already exist in the codebase.
## How does it work
Prisma is a really powerful ORM.
If you look closely, you'll realize that internally,
Prisma 2 is powered by a GraphQL Engine to abstract away the database layer.
The GraphQL Engine is written in Rust.
This library is a CGO wrapper to make the Prisma Rust GraphQL Engine available to write Go programs on top of it.
## Is it fast?
I've measured ~0.3ms latency (Go -> Rust -> Database -> Go) on my laptop using a database in docker.
```
goos: darwin
goarch: amd64
pkg: github.com/jensneuse/goprisma/pkg/prisma
cpu: Intel(R) Core(TM) i9-9980HK CPU @ 2.40GHz
BenchmarkEngine_Execute
BenchmarkEngine_Execute-16 43815 304507 ns/op 144 B/op 3 allocs/op
PASS
```
You can find the benchmark in the prisma package tests and run it yourself.
## What architectures are supported?
- [x] darwin x86_64
- [x] darwin aarch64
- [x] linux x86_64
- [ ] windows x86_64 (needs verification)
Other targets can be added.
## Where is the Rust wrapper?
https://github.com/jensneuse/prisma-engines/tree/goprisma
## Example / How to run the tests?
First, clone the repo.
```shell
cd docker-example
docker-compose up
```
Now you're able to run the tests.
## How can you help?
### Testing
You can help by running the tests and architectures that need verification.
Please report any issues and tell me if it works.
### Automate building the C-Wrapper
You might want to increase the level of trust by adding a github action to automate building the Rust C-Wrapper.
Currently, I'm building it on my MacBook.
Ideally, this github action would fetch the latest stable of prisma-engines, compile the C-Wrapper and updates the lib folder via PR.
A blueprint how to do this can be found here: https://github.com/rogchap/v8go/blob/master/.github/workflows/v8build.yml
If you're interested in adding this, please open a PR.
That said, you can always build the Rust part yourself to increase the level of trust.