Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(dgraph): Add suport for RDF query. #6038

Merged
merged 16 commits into from
Aug 7, 2020
2 changes: 2 additions & 0 deletions edgraph/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -1074,6 +1074,8 @@ func processQuery(ctx context.Context, qc *queryContext) (*api.Response, error)
respMap["types"] = formatTypes(er.Types)
}
resp.Json, err = json.Marshal(respMap)
} else if qc.req.RdfFormat {
resp.Rdf, err = query.ToRDF(qc.latency, er.Subgraphs)
} else {
resp.Json, err = query.ToJson(qc.latency, er.Subgraphs)
}
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ require (
github.com/blevesearch/snowballstem v0.0.0-20180110192139-26b06a2c243d // indirect
github.com/codahale/hdrhistogram v0.0.0-20161010025455-3a0bb77429bd
github.com/dgraph-io/badger/v2 v2.0.1-rc1.0.20200718033852-37ee16d8ad1c
github.com/dgraph-io/dgo/v200 v200.0.0-20200401175452-e463f9234453
github.com/dgraph-io/dgo/v200 v200.0.0-20200720091212-f41d047addd1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove these changes from the merge, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

github.com/dgraph-io/graphql-transport-ws v0.0.0-20200715131837-c0460019ead2
github.com/dgraph-io/ristretto v0.0.3-0.20200630154024-f66de99634de
github.com/dgrijalva/jwt-go v3.2.0+incompatible
Expand Down
2 changes: 2 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ github.com/dgraph-io/badger/v2 v2.0.1-rc1.0.20200718033852-37ee16d8ad1c h1:LoEZf
github.com/dgraph-io/badger/v2 v2.0.1-rc1.0.20200718033852-37ee16d8ad1c/go.mod h1:26P/7fbL4kUZVEVKLAKXkBXKOydDmM2p1e+NhhnBCAE=
github.com/dgraph-io/dgo/v200 v200.0.0-20200401175452-e463f9234453 h1:DTgOrw91nMIukDm/WEvdobPLl0LgeDd/JE66+24jBks=
github.com/dgraph-io/dgo/v200 v200.0.0-20200401175452-e463f9234453/go.mod h1:Co+FwJrnndSrPORO8Gdn20dR7FPTfmXr0W/su0Ve/Ig=
github.com/dgraph-io/dgo/v200 v200.0.0-20200720091212-f41d047addd1 h1:bB3SjXpTJ7YcYheynrAlc5K0nlmNgygsj8WHlhRncig=
github.com/dgraph-io/dgo/v200 v200.0.0-20200720091212-f41d047addd1/go.mod h1:Co+FwJrnndSrPORO8Gdn20dR7FPTfmXr0W/su0Ve/Ig=
github.com/dgraph-io/graphql-transport-ws v0.0.0-20200715131837-c0460019ead2 h1:NSl3XXyON9bgmBJSAvr5FPrgILAovtoTs7FwdtaZZq0=
github.com/dgraph-io/graphql-transport-ws v0.0.0-20200715131837-c0460019ead2/go.mod h1:7z3c/5w0sMYYZF5bHsrh8IH4fKwG5O5Y70cPH1ZLLRQ=
github.com/dgraph-io/ristretto v0.0.3-0.20200630154024-f66de99634de h1:t0UHb5vdojIDUqktM6+xJAfScFBsVpXZmqC9dsgJmeA=
Expand Down
14 changes: 14 additions & 0 deletions query/common_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,20 @@ func processQuery(ctx context.Context, t *testing.T, query string) (string, erro
return string(jsonResponse), err
}

func processQueryRDF(ctx context.Context, t *testing.T, query string) (string, error) {
txn := client.NewTxn()
defer txn.Discard(ctx)

res, err := txn.Do(ctx, &api.Request{
Query: query,
RdfFormat: true,
})
if err != nil {
return "", err
}
return string(res.Rdf), err
}

func processQueryNoErr(t *testing.T, query string) string {
res, err := processQuery(context.Background(), t, query)
require.NoError(t, err)
Expand Down
213 changes: 213 additions & 0 deletions query/outputrdf.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
/*
* Copyright 2017-2020 Dgraph Labs, Inc. and Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package query

import (
"bytes"
"fmt"
"strconv"

"github.com/dgraph-io/dgraph/algo"
"github.com/dgraph-io/dgraph/protos/pb"
"github.com/dgraph-io/dgraph/types"
"github.com/dgraph-io/dgraph/x"
"github.com/pkg/errors"
)

// rdfBuilder is used to generate RDF from subgraph.
type rdfBuilder struct {
buf *bytes.Buffer
}

// ToRDF converts the given subgraph list into rdf format.
func ToRDF(l *Latency, sgl []*SubGraph) ([]byte, error) {
b := &rdfBuilder{
buf: &bytes.Buffer{},
}
for _, sg := range sgl {
if err := validateSubGraphForRDF(sg); err != nil {
return nil, err
}
// Skip parent graph. we don't want parent values.
for _, child := range sg.Children {
if err := b.castToRDF(child); err != nil {
return nil, err
}
}
}
return b.buf.Bytes(), nil
}

// castToRDF converts the given subgraph to RDF and appends to the
// output string.
func (b *rdfBuilder) castToRDF(sg *SubGraph) error {
if err := validateSubGraphForRDF(sg); err != nil {
return err
}
if sg.SrcUIDs != nil {
// Get RDF for the given subgraph.
if err := b.rdfForSubgraph(sg); err != nil {
return err
}
}
// Recursively cnvert RDF for the children graph.
for _, child := range sg.Children {
if err := b.castToRDF(child); err != nil {
return err
}
}
return nil
}

// rdfForSubgraph generates RDF and appends to the output parameter.
func (b *rdfBuilder) rdfForSubgraph(sg *SubGraph) error {
for i, uid := range sg.SrcUIDs.Uids {
if sg.Params.IgnoreResult {
// Skip ignored values.
continue
}
if sg.IsInternal() {
if sg.Params.Expand != "" {
continue
}
// Check if we have val for the given uid. If you got uid then populate
// the rdf.
val, ok := sg.Params.UidToVal[uid]
if !ok && val.Value == nil {
continue
}
outputval, err := valToBytes(val)
if err != nil {
return err
}
b.writeRDF(uid, []byte(sg.aggWithVarFieldName()), outputval)
continue
}
switch {
case len(sg.counts) > 0:
// Add count rdf.
b.rdfForCount(uid, sg.counts[i], sg)
case i < len(sg.uidMatrix) && len(sg.uidMatrix[i].Uids) != 0:
// Add posting list relation.
b.rdfForUIDList(uid, sg.uidMatrix[i], sg)
case i < len(sg.valueMatrix):
b.rdfForValueList(uid, sg.valueMatrix[i], sg.fieldName())
}
}
return nil
}

func (b *rdfBuilder) writeRDF(subject uint64, predicate []byte, object []byte) {
// add subject
b.writeTriple([]byte(fmt.Sprintf("%#x", subject)))
x.Check(b.buf.WriteByte(' '))
// add predicate
b.writeTriple(predicate)
x.Check(b.buf.WriteByte(' '))
// add object
x.Check2(b.buf.Write(object))
x.Check(b.buf.WriteByte(' '))
x.Check(b.buf.WriteByte('.'))
x.Check(b.buf.WriteByte('\n'))
}

func (b *rdfBuilder) writeTriple(val []byte) {
x.Check(b.buf.WriteByte('<'))
x.Check2(b.buf.Write(val))
x.Check(b.buf.WriteByte('>'))
}

// rdfForCount returns rdf for count fucntion.
func (b *rdfBuilder) rdfForCount(subject uint64, count uint32, sg *SubGraph) {
fieldName := sg.Params.Alias
if fieldName == "" {
fieldName = fmt.Sprintf("count(%s)", sg.Attr)
}
b.writeRDF(subject, []byte(fieldName), []byte(strconv.FormatUint(uint64(count), 10)))
}

// rdfForUIDList returns rdf for uid list.
func (b *rdfBuilder) rdfForUIDList(subject uint64, list *pb.List, sg *SubGraph) {
for _, destUID := range list.Uids {
if algo.IndexOf(sg.DestUIDs, destUID) < 0 {
// This uid is filtered.
continue
}
// Build object.
b.writeRDF(
subject,
[]byte(sg.fieldName()),
buildTriple([]byte(fmt.Sprintf("%#x", destUID))))
}
}

// rdfForValueList returns rdf for the value list.
func (b *rdfBuilder) rdfForValueList(subject uint64, valueList *pb.ValueList, attr string) {
if attr == "uid" {
b.writeRDF(subject,
[]byte(attr),
buildTriple([]byte(fmt.Sprintf("%#x", subject))))
return
}
for _, destValue := range valueList.Values {
val, err := convertWithBestEffort(destValue, attr)
if err != nil {
continue
}
outputval, err := valToBytes(val)
if err != nil {
continue
}
switch val.Tid {
case types.UidID:
b.writeRDF(subject, []byte(attr), buildTriple(outputval))
default:
b.writeRDF(subject, []byte(attr), outputval)
}
}
}

func buildTriple(val []byte) []byte {
buf := make([]byte, 0, 2+len(val))
buf = append(buf, '<')
buf = append(buf, val...)
buf = append(buf, '>')
return buf
}

func validateSubGraphForRDF(sg *SubGraph) error {
if sg.IsGroupBy() {
return errors.New("groupby is not supported in rdf output format")
}
uidCount := sg.Attr == "uid" && sg.Params.DoCount && sg.IsInternal()
if uidCount {
return errors.New("uid count is not supported in the rdf output format")
}
if sg.Params.Normalize {
return errors.New("normalize directive is not supported in the rdf output format")
}
if sg.Params.IgnoreReflex {
return errors.New("ignorereflex directive is not supported in the rdf output format")
}
if sg.SrcFunc != nil && sg.SrcFunc.Name == "checkpwd" {
return errors.New("chkpwd function is not supported in the rdf output format")
}
if sg.Params.Facet != nil && !sg.Params.ExpandAll {
return errors.New("facets are not supported in the rdf output format")
}
return nil
}
Loading