PraxQL

In this section

• PraxQL OverviewPraxQL is Praxsuite's JSON-based declarative query language. It is what you use to read and write data through the API Gateway. Instead of configuring one REST endpoint…
• QueriesA query body reads data from one primary table, with optional filtering, sorting, pagination and nested relations.
• OperatorsOperators appear in where conditions, and in having for aggregation queries. Every condition has the form:
• RelationsInstead of making several API calls to fetch related data, PraxQL lets you express relations inline in select. The engine resolves them in batches, so there is no N+1…
• AggregationsPraxQL supports GROUP BY, HAVING and aggregate functions in the same query body. There is no separate endpoint and no serverless function to write.
• MutationsMutations write data through the same /query endpoint as reads. You send a mutation key instead of a query key.
• Schema IntrospectionThe /schema endpoint tells you which tables and columns your API key can see. It is where a refs dictionary comes from, and the only reliable way to learn the column…
• Security ModelEvery request passes through six independent layers before any data comes back. They are worth understanding as a set, because each one fails differently and the…
• The PlaygroundThe Playground is a query console built into the portal. You write a PraxQL body, press Execute, and see the rows come back — without writing a line of client code,…