pql

package

v0.3.1 Latest Latest Go to latest Published: Apr 30, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tgruben/pilosa

Links

Open Source Insights

Documentation ¶

Overview ¶

Package pql defines the Pilosa Query Language.

Index ¶

Constants
func CopyArgs(m map[string]interface{}) map[string]interface{}
type Call
type ParseError
- func (e *ParseError) Error() string
type Parser
- func NewParser(r io.Reader) *Parser
- func (p *Parser) Parse() (*Query, error)
type Pos
type Query
- func ParseString(s string) (*Query, error)
- func (q *Query) String() string
type Scanner
- func NewScanner(r io.Reader) *Scanner
- func (s *Scanner) Scan() (tok Token, pos Pos, lit string)
type Token
- func Lookup(ident string) Token
- func (tok Token) String() string

Constants ¶

View Source

const TimeFormat = "2006-01-02T15:04"

TimeFormat is the go-style time format used to parse string dates.

Variables ¶

This section is empty.

Functions ¶

Types ¶

type Call ¶

type Call struct {
	Name     string
	Args     map[string]interface{}
	Children []*Call
}

Call represents a function call in the AST.

func (*Call) Clone ¶

func (c *Call) Clone() *Call

Clone returns a copy of c.

func (*Call) IsInverse ¶

func (c *Call) IsInverse(rowLabel, columnLabel string) bool

IsInverse specifies if the call is for an inverse view. Return defaults to false unless absolutely sure of inversion.

func (*Call) Keys ¶

func (c *Call) Keys() []string

Keys returns a list of argument keys in sorted order.

func (*Call) String ¶

func (c *Call) String() string

String returns the string representation of the call.

func (*Call) SupportsInverse ¶

func (c *Call) SupportsInverse() bool

SupportsInverse indicates that the call may be on an inverse frame.

func (*Call) UintArg ¶

func (c *Call) UintArg(key string) (uint64, bool, error)

UintArg is for reading the value at key from call.Args as a uint64. If the key is not in Call.Args, the value of the returned bool will be false, and the error will be nil. The value is assumed to be a uint64 or an int64 and then cast to a uint64. An error is returned if the value is not an int64 or uint64.

func (*Call) UintSliceArg ¶

func (c *Call) UintSliceArg(key string) ([]uint64, bool, error)

UintSliceArg reads the value at key from call.Args as a slice of uint64. If the key is not in Call.Args, the value of the returned bool will be false, and the error will be nil. If the value is a slice of int64 it will convert it to []uint64. Otherwise, if it is not a []uint64 it will return an error.

type ParseError ¶

type ParseError struct {
	Message string
	Pos     Pos
}

ParseError represents an error that occurred while parsing a PQL query.

func (*ParseError) Error ¶

func (e *ParseError) Error() string

Error returns a string representation of e.

type Parser ¶

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

Parser represents a parser for the PQL language.

func NewParser ¶

func NewParser(r io.Reader) *Parser

NewParser returns a new instance of Parser.

func (*Parser) Parse ¶

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

Parse parses the next node in the query.

type Pos ¶

type Pos struct {
	Line int
	Char int
}

Pos specifies the line and character position of a token. The Char and Line are both zero-based indexes.

type Query ¶

type Query struct {
	Calls []*Call
}

Query represents a PQL query.

func ParseString ¶

func ParseString(s string) (*Query, error)

ParseString parses s into a query.

func (*Query) String ¶

func (q *Query) String() string

String returns a string representation of the query.

type Scanner ¶

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

Scanner represents a PQL lexical scanner.

func NewScanner ¶

func NewScanner(r io.Reader) *Scanner

NewScanner returns a new instance of Scanner.

func (*Scanner) Scan ¶

func (s *Scanner) Scan() (tok Token, pos Pos, lit string)

Scan returns the next token and position from the underlying reader.

type Token ¶

type Token int

Token is a lexical token of the PQL language.

const (
	// Special tokens
	ILLEGAL Token = iota
	EOF
	WS

	IDENT     // main
	STRING    // "foo"
	BADSTRING // bad escape or unclosed string
	INTEGER   // 12345
	FLOAT     // 100.2

	ALL

	EQ     // =
	COMMA  // ,
	LPAREN // (
	RPAREN // )
	LBRACK // (
	RBRACK // )
)

func Lookup ¶

func Lookup(ident string) Token

Lookup returns the token associated with a given string.

func (Token) String ¶

func (tok Token) String() string

String returns the string representation of the token.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL