Method Subscribe

core/subs.go:93–128

Subscribe function is called on the GraphJin struct to subscribe to query. Any database changes that apply to the query are streamed back in realtime. In developer mode all named queries are saved into the queries folder and in production mode only queries from these saved queries can be used.

(
	c context.Context,
	query string,
	vars json.RawMessage,
	rc *RequestConfig,
)

// In developer mode all named queries are saved into the queries folder and in production mode only
// queries from these saved queries can be used.
func (g *GraphJin) Subscribe(
	c context.Context,
	query string,
	vars json.RawMessage,
	rc *RequestConfig,
) (m *Member, err error) {
	// get the name, query vars
	h, err := graph.FastParse(query)
	if err != nil {
		return
	}

	gj, err := g.getEngine()
	if err != nil {
		return
	}

	// create the request object
	r := gj.newGraphqlReq(rc, "subscription", h.Name, nil, vars)

	// if production security enabled then get query and metadata
	// from allow list
	if gj.prodSec {
		var item allow.Item
		item, err = gj.allowList.GetByName(h.Name, true)
		if err != nil {
			return
		}
		r.Set(item)
	} else {
		r.query = []byte(query)
	}

	m, err = gj.subscribe(c, r)
	return
}

// SubscribeByName is similar to the Subscribe function except that queries saved
// in the queries folder can directly be used by their filename.