Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Generation

Functions related to text generation.


generate

Generates an SQL statement from a natural language query.

Parameters

user_query
  • Description: Natural language query
  • Type: TEXT
  • Optional: false
engine
  • Description: Engine to generate query with. If NULL, defaults to value set via set_default_engine.
  • Type: TEXT
  • Optional: true
  • Default: NULL

Example

-- Without default engine
SELECT sqlgen.generate('Get top 10 customers by monthly spend');

-- With default engine
SELECT sqlgen.generate('Get top 10 customers by monthly spend', 'my_engine');

explain_query

Explains what a query does and how it works in natural language.

Parameters

user_query
  • Description: SQL query
  • Type: TEXT
  • Optional: false
engine
  • Description: Engine to generate query with. If NULL, defaults to value set via set_default_engine.
  • Type: TEXT
  • Optional: true
  • Default: NULL

Example

-- Without default engine
SELECT sqlgen.explain_query('SELECT name, price FROM inventory');

-- Without default engine
SELECT sqlgen.explain_query('SELECT name, price FROM inventory', 'my_engine');