Documentation Source Text

         <b>win2</b> AS (PARTITION BY y ORDER BY x)
  ORDER BY x;
</codeblock>

<p>The WINDOW clause, when one is present, comes after any HAVING clause and
before any ORDER BY.

<h1>Aggregate Window Functions</h1>

<p> The examples in this section all assume that the database is populated as
follows:

<codeblock>
  CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
  INSERT INTO t1 VALUES   (1, 'A', 'one'  ),
................................................................................
  <i>--   one   | 7 | G | A.C.D.F.G   </i>
  <i>-- </i>
  SELECT c, a, b, group_concat(b, '.') FILTER (WHERE c!='two') OVER (
    ORDER BY a
  ) AS group_concat
  FROM t1 ORDER BY a;
</codeblock>
<h2 tags="user-defined window functions">User-Defined Aggregate Window Functions</h2>

<p>TODO: Link to C API docs (sqlite3_create_window_function()).

<h1>Built-in Window Functions</h1>

<p> As well as aggregate window functions, SQLite features a set of built-in
window functions based on 
<a href=https://www.postgresql.org/docs/10/static/functions-window.html>
those supported by PostgreSQL</a>.
................................................................................
         lag(b) OVER win            AS lag,
         first_value(b) OVER win    AS first_value,
         last_value(b) OVER win     AS last_value,
         nth_value(b, 3) OVER win   AS nth_value_3
  FROM t1
  WINDOW win AS (ORDER BY b ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)
</codeblock>

         <b>win2</b> AS (PARTITION BY y ORDER BY x)
  ORDER BY x;
</codeblock>

<p>The WINDOW clause, when one is present, comes after any HAVING clause and
before any ORDER BY.

<h1 tags="aggregate window functions">Aggregate Window Functions</h1>

<p> The examples in this section all assume that the database is populated as
follows:

<codeblock>
  CREATE TABLE t1(a INTEGER PRIMARY KEY, b, c);
  INSERT INTO t1 VALUES   (1, 'A', 'one'  ),
................................................................................
  <i>--   one   | 7 | G | A.C.D.F.G   </i>
  <i>-- </i>
  SELECT c, a, b, group_concat(b, '.') FILTER (WHERE c!='two') OVER (
    ORDER BY a
  ) AS group_concat
  FROM t1 ORDER BY a;
</codeblock>




<h1>Built-in Window Functions</h1>

<p> As well as aggregate window functions, SQLite features a set of built-in
window functions based on 
<a href=https://www.postgresql.org/docs/10/static/functions-window.html>
those supported by PostgreSQL</a>.
................................................................................
         lag(b) OVER win            AS lag,
         first_value(b) OVER win    AS first_value,
         last_value(b) OVER win     AS last_value,
         nth_value(b, 3) OVER win   AS nth_value_3
  FROM t1
  WINDOW win AS (ORDER BY b ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)
</codeblock>

<h1 tags="user-defined window functions">User-Defined Aggregate Window Functions</h1>

<p> User-defined aggregate window functions may be created using the
[sqlite3_create_window_function]() API. Implementing an aggregate window
function is very similar to an ordinary aggregate function. Any user-defined
aggregate window function may also be used as an ordinary aggregate. To 
implement a user-defined aggregate window function the application must
supply four callback functions:

<table striped=1>
<tr><th>Callback <th>Description
<tr><td>xStep <td>
      This method is required by both window aggregate and legacy aggregate
      function implementations. It is invoked to add a row to the current
      window. The function arguments, if any, corresponding to the row being
      added are passed to the implementation of xStep.

<tr><td>xFinal <td>
      This method is required by both window aggregate and legacy aggregate
      function implementations. It is invoked to return the current value
      of the aggregate (determined by the contents of the current window),
      and to free any resources allocated by earlier calls to xStep.

<tr><td>xValue <td>
      This method is only required window aggregate functions, not legacy
      aggregate function implementations. It is invoked to return the current
      value of the aggregate. Unlike xFinal, the implementation should not
      delete any context.

<tr><td>xInverse <td>
      This method is only required window aggregate functions, not legacy
      aggregate function implementations. It is invoked to remove a row
      from the current window. The function arguments, if any, correspond
      to the row being removed.
</table>

<p> The C code below implements a simple window aggregate function named
sumint(). This works in the same way as the built-in sum() function, except
that it throws an exception if passed an argument that is not an integer
value.

<codeblock>
<tcl>

proc C_Code {text} {
  hd_puts "<pre>\n"
  set iLine 0
  foreach zLine [split [string trim $text "\n"] "\n"] {
    regsub {^  } $zLine {} zLine 
    set zSubspec {<i>&</i>}
    regsub {(/\*|\*\*|\*/).*} $zLine $zSubspec zLine 
    if {[regexp {(.*)(sqlite3[a-z0-9_]*)(.*)} $zLine -> one two three]} {
      hd_puts $one
      hd_resolve "\[$two\]"
      hd_puts $three
    } else {
      hd_puts $zLine
    }
    hd_puts "\n"
  }
  hd_puts "</pre>\n"
}

C_Code {
  /*
  ** xStep for sumint().
  **
  ** Add the value of the argument to the aggregate context (an integer).
  */
  static void sumintStep(
    sqlite3_context *ctx, 
    int nArg, 
    sqlite3_value *apArg[]
  ){
    sqlite3_int64 *pInt;
  
    assert( nArg==1 );
    if( sqlite3_value_type(apArg[0])!=SQLITE_INTEGER ){
      sqlite3_result_error(ctx, "invalid argument", -1);
      return;
    }
    pInt = (sqlite3_int64*)sqlite3_aggregate_context(ctx, sizeof(sqlite3_int64));
    if( pInt ){
      *pInt += sqlite3_value_int64(apArg[0]);
    }
  }
  
  /*
  ** xInverse for sumint().
  **
  ** This does the opposite of xStep() - subtracts the value of the argument
  ** from the current context value. The error checking can be omitted from
  ** this function, as it is only ever called after xStep() (so the aggregate
  ** context has already been allocated) and with a value that has already
  ** been passed to xStep() without error (so it must be an integer).
  */
  static void sumintInverse(
    sqlite3_context *ctx, 
    int nArg, 
    sqlite3_value *apArg[]
  ){
    sqlite3_int64 *pInt;
    assert( sqlite3_value_type(apArg[0])==SQLITE_INTEGER );
    pInt = (sqlite3_int64*)sqlite3_aggregate_context(ctx, sizeof(sqlite3_int64));
    *pInt -= sqlite3_value_int64(apArg[0]);
  }
  
  /*
  ** xFinal for sumint().
  **
  ** Return the current value of the aggregate window function. Because
  ** this implementation does not allocate any resources beyond the buffer
  ** returned by sqlite3_aggregate_context, which is automatically freed
  ** by the system, there are no resources to free. And so this method is
  ** identical to xValue().
  */
  static void sumintFinal(sqlite3_context *ctx){
    sqlite3_int64 res = 0;
    sqlite3_int64 *pInt;
    pInt = (sqlite3_int64*)sqlite3_aggregate_context(ctx, 0);
    if( pInt ) res = *pInt;
    sqlite3_result_int64(ctx, res);
  }
  
  /*
  ** xValue for sumint().
  **
  ** Return the current value of the aggregate window function. Because
  */
  static void sumintValue(sqlite3_context *ctx){
    sqlite3_int64 res = 0;
    sqlite3_int64 *pInt;
    pInt = (sqlite3_int64*)sqlite3_aggregate_context(ctx, 0);
    if( pInt ) res = *pInt;
    sqlite3_result_int64(ctx, res);
  }

  /*
  ** Register sumint() window aggregate with database handle db. 
  */
  int register_sumint(sqlite3 *db){
    return sqlite3_create_window_function(db, "sumint", 1, SQLITE_UTF8, 0,
        sumintStep, sumintFinal, sumintValue, sumintInverse, 0
    );
  }
}
</tcl>
</codeblock>