Home | History | Annotate | Line # | Download | only in man
      1 .Dd April 29, 2026
      2 .Dt SQLITE3SESSION_CHANGESET_SIZE 3
      3 .Os
      4 .Sh NAME
      5 .Nm sqlite3session_changeset_size
      6 .Nd return an upper-limit for the size of the changeset
      7 .Sh SYNOPSIS
      8 .In sqlite3.h
      9 .Ft sqlite3_int64
     10 .Fo sqlite3session_changeset_size
     11 .Fa "sqlite3_session *pSession"
     12 .Fc
     13 .Sh DESCRIPTION
     14 By default, this function always returns 0.
     15 For it to return a useful result, the sqlite3_session object must have
     16 been configured to enable this API using sqlite3session_object_config()
     17 with the SQLITE_SESSION_OBJCONFIG_SIZE verb.
     18 .Pp
     19 When enabled, this function returns an upper limit, in bytes, for the
     20 size of the changeset that might be produced if sqlite3session_changeset()
     21 were called.
     22 The final changeset size might be equal to or smaller than the size
     23 in bytes returned by this function.
     24 .Sh IMPLEMENTATION NOTES
     25 These declarations were extracted from the
     26 interface documentation at line 11860.
     27 .Bd -literal
     28 SQLITE_API sqlite3_int64 sqlite3session_changeset_size(sqlite3_session *pSession);
     29 .Ed
     30