Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

@construct

@construct: Subject | Subject[]

Specifies a Subject for the requested data, using variables to place-hold data matched by the @where clause.

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=construct&type=Code

Optional @context

@context: Context

A JSON-LD Context for the query. In an API, this will frequently be implicit. For example, using json-rql as the body of a POST to http://example.com/my-api/v1/person/query might have the implicit context of a Person (possibly found at http://example.com/my-api/v1/person).

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=context&type=Code

Optional @groupBy

@groupBy: Expression | Expression[]

Specifies an expression or an array of expressions to group the result by.

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=groupBy&type=Code

Optional @having

@having: Expression

Optional @limit

@limit: undefined | number

Integer page size limit for results

Optional @offset

@offset: undefined | number

Integer offset for results

Optional @orderBy

@orderBy: Expression | Expression[]

Specifies an expression or array of expressions to order the results by.

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=orderBy&type=Code

Optional @values

Specifies a Variable Expression or array of Variable Expressions that define [inline allowable value combinations]

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=values&type=Code

Optional @where

@where: Pattern[] | Pattern

specifies a pattern to match, or an array of patterns to match. Each can be a Subject, a Group, or another Query (a sub-query).

see

examples https://github.com/gsvarovsky/json-rql/search?l=JSON&q=where&type=Code

Legend

  • Property

Generated using TypeDoc. Delivered by Vercel. json-rql - v0.6.0 Source code licensed MIT. Privacy policy