dsp

README

dgraph-parser

Package in Go for parsing native DGraph schema definitions (so not GraphQL).

usage

import (
    dsp "github.com/emicklei/dgraph-parser"
)

example

data, err := ioutil.ReadFile("dgraph.schema")
if err != nil {
	log.Fatal(err)
}
parser := dsp.NewParser(bytes.NewReader(data))
schema, err := parser.Parse()
if err != nil {
	log.Fatal(err)
}

© 2020, ernestmicklei.com. MIT License. Contributions welcome.

Documentation

Index

• type DirectiveDef
• type Parser
  • func NewParser(r io.Reader) *Parser
  • func (p *Parser) Filename(f string)
  • func (p *Parser) Parse() (*Schema, error)
• type PredicateDef
  • func (pd *PredicateDef) WriteOn(w io.Writer)
• type Schema
  • func (s *Schema) FindPredicate(name string) *PredicateDef
  • func (s *Schema) String() string
• type TypeDef
  • func (td *TypeDef) WriteOn(w io.Writer)

Types

type DirectiveDef

type DirectiveDef struct {
	Name      string
	Arguments []string
}

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

Parser represents a parser.

func NewParser

func NewParser(r io.Reader) *Parser

NewParser returns a new instance of Parser.

func (*Parser) Filename

func (p *Parser) Filename(f string)

Filename is for reporting. Optional.

func (*Parser) Parse

func (p *Parser) Parse() (*Schema, error)

Parse parses a schema definition. May return a parse or scanner error.

type PredicateDef

type PredicateDef struct {
	Name     string
	Typename string
	IsArray  bool

	Directives []*DirectiveDef
	// contains filtered or unexported fields
}

func (*PredicateDef) WriteOn

func (pd *PredicateDef) WriteOn(w io.Writer)

type Schema

type Schema struct {
	Filename   string
	Predicates []*PredicateDef
	Types      []*TypeDef
}

func (*Schema) FindPredicate

func (s *Schema) FindPredicate(name string) *PredicateDef

FindPredicate searches in all predicates and types for a definition. Return nil if not found.

func (*Schema) String

func (s *Schema) String() string

String is for debug

type TypeDef

type TypeDef struct {
	Name       string
	Predicates []*PredicateDef
}

func (*TypeDef) WriteOn

func (td *TypeDef) WriteOn(w io.Writer)