forked from arsmn/fastgql
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request 99designs#734 from DBL-Lee/master
Automatic Persisted Queries
- Loading branch information
Showing
3 changed files
with
225 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
title: "Automatic persisted queries" | ||
description: | ||
linkTitle: "APQ" | ||
menu: { main: { parent: 'reference' } } | ||
--- | ||
|
||
When you work with GraphQL by default your queries are transferred with every request. That can waste significant | ||
bandwidth. To avoid that you can use Automatic Persisted Queries (APQ). | ||
|
||
With APQ you send only query hash to the server. If hash is not found on a server then client makes a second request | ||
to register query hash with original query on a server. | ||
|
||
## Usage | ||
|
||
In order to enable Automatic Persisted Queries you need to change your client. For more information see | ||
[Automatic Persisted Queries Link](https://github.com/apollographql/apollo-link-persisted-queries) documentation. | ||
|
||
For the server you need to implement `PersistedQueryCache` interface and pass instance to | ||
`handler.EnablePersistedQueryCache` option. | ||
|
||
See example using [go-redis](github.com/go-redis/redis) package below: | ||
```go | ||
import ( | ||
"context" | ||
"time" | ||
|
||
"github.com/go-redis/redis" | ||
"github.com/pkg/errors" | ||
) | ||
|
||
type Cache struct { | ||
client redis.UniversalClient | ||
ttl time.Duration | ||
} | ||
|
||
const apqPrefix = "apq:" | ||
|
||
func NewCache(redisAddress string, password string, ttl time.Duration) (*Cache, error) { | ||
client := redis.NewClient(&redis.Options{ | ||
Addr: redisAddress, | ||
}) | ||
|
||
err := client.Ping().Err() | ||
if err != nil { | ||
return nil, errors.WithStack(err) | ||
} | ||
|
||
return &Cache{client: client, ttl: ttl}, nil | ||
} | ||
|
||
func (c *Cache) Add(ctx context.Context, hash string, query string) { | ||
c.client.Set(apqPrefix + hash, query, c.ttl) | ||
} | ||
|
||
func (c *Cache) Get(ctx context.Context, hash string) (string, bool) { | ||
s, err := c.client.Get(apqPrefix + hash).Result() | ||
if err != nil { | ||
return "", false | ||
} | ||
return s, true | ||
} | ||
|
||
func main() { | ||
cache, err := NewCache(cfg.RedisAddress, 24*time.Hour) | ||
if err != nil { | ||
log.Fatalf("cannot create APQ redis cache: %v", err) | ||
} | ||
|
||
c := Config{ Resolvers: &resolvers{} } | ||
gqlHandler := handler.GraphQL( | ||
blog.NewExecutableSchema(c), | ||
handler.EnablePersistedQueryCache(cache), | ||
) | ||
http.Handle("/query", gqlHandler) | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters