README
¶
Super Graph - Fetch data with GraphQL
Super Graph gives you a high performance GraphQL API without you having to write any code. GraphQL is automagically compiled into an efficient SQL query. Use it either as a library or a standalone service.
Using it as a service
go get github.com/dosco/super-graph
super-graph new <app_name>
cd <app_name>
docker-compose run api db:setup
docker-compose up
Using it in your own code
go get github.com/dosco/super-graph/core
package main
import (
"context"
"database/sql"
"fmt"
"log"
"github.com/dosco/super-graph/core"
_ "github.com/jackc/pgx/v4/stdlib"
)
func main() {
db, err := sql.Open("pgx", "postgres://postgres:@localhost:5432/example_db")
if err != nil {
log.Fatal(err)
}
sg, err := core.NewSuperGraph(nil, db)
if err != nil {
log.Fatal(err)
}
query := `
query {
posts {
id
title
}
}`
ctx := context.Background()
ctx = context.WithValue(ctx, core.UserIDKey, 1)
res, err := sg.GraphQL(ctx, query, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(string(res.Data))
}
About Super Graph
After working on several products through my career I found that we spend way too much time on building API backends. Most APIs also need constant updating, and this costs time and money.
It's always the same thing, figure out what the UI needs then build an endpoint for it. Most API code involves struggling with an ORM to query a database and mangle the data into a shape that the UI expects to see.
I didn't want to write this code anymore, I wanted the computer to do it. Enter GraphQL, to me it sounded great, but it still required me to write all the same database query code.
Having worked with compilers before I saw this as a compiler problem. Why not build a compiler that converts GraphQL to highly efficient SQL.
This compiler is what sits at the heart of Super Graph, with layers of useful functionality around it like authentication, remote joins, rails integration, database migrations, and everything else needed for you to build production-ready apps with it.
Features
- Complex nested queries and mutations
- Realtime updates with subscriptions
- Build infinite scroll, feeds, nested comments, etc
- Auto learns database tables and relationships
- Role and Attribute-based access control
- Opaque cursor-based efficient pagination
- Full-text search and aggregations
- JWT tokens supported (Auth0, etc)
- Join database queries with remote REST APIs
- Also works with existing Ruby-On-Rails apps
- Rails authentication supported (Redis, Memcache, Cookie)
- A simple config file
- High performance Go codebase
- Tiny docker image and low memory requirements
- Fuzz tested for security
- Database migrations tool
- Database seeding tool
- Works with Postgres and Yugabyte DB
- OpenCensus Support: Zipkin, Prometheus, X-Ray, Stackdriver
- API Rate Limiting
- Highly scalable and fast
Documentation
Reach out
We're happy to help you leverage Super Graph reach out if you have questions
Production use
The popular 42papers.com site for discovering trending papers in AI and Computer Science uses Super Graph for it's entire backend.
License
Copyright (c) 2019-present Vikram Rangnekar
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package core provides the primary API to include and use Super Graph with your own code.
|
Package core provides the primary API to include and use Super Graph with your own code. |
|
internal/crypto
Provides symmetric authenticated encryption using 256-bit AES-GCM with a random nonce.
|
Provides symmetric authenticated encryption using 256-bit AES-GCM with a random nonce. |
|
internal
|
|
|
serv
Package reload offers lightweight automatic reloading of running processes.
|
Package reload offers lightweight automatic reloading of running processes. |
|
Package jsn provides fast and no-allocation functions to extract values and modify JSON data
|
Package jsn provides fast and no-allocation functions to extract values and modify JSON data |