diff options
Diffstat (limited to 'static/netbsd/man3/sqlite3session_create.3')
| -rw-r--r-- | static/netbsd/man3/sqlite3session_create.3 | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3session_create.3 b/static/netbsd/man3/sqlite3session_create.3 new file mode 100644 index 00000000..b310c67b --- /dev/null +++ b/static/netbsd/man3/sqlite3session_create.3 @@ -0,0 +1,60 @@ +.Dd January 24, 2024 +.Dt SQLITE3SESSION_CREATE 3 +.Os +.Sh NAME +.Nm sqlite3session_create +.Nd create a new session object +.Sh SYNOPSIS +.In sqlite3.h +.Ft int +.Fo sqlite3session_create +.Fa "sqlite3 *db" +.Fa "const char *zDb" +.Fa "sqlite3_session **ppSession" +.Fc +.Sh DESCRIPTION +Create a new session object attached to database handle db. +If successful, a pointer to the new object is written to *ppSession +and SQLITE_OK is returned. +If an error occurs, *ppSession is set to NULL and an SQLite error code +(e.g. SQLITE_NOMEM) is returned. +.Pp +It is possible to create multiple session objects attached to a single +database handle. +.Pp +Session objects created using this function should be deleted using +the +.Fn sqlite3session_delete +function before the database handle that they are attached to is itself +closed. +If the database handle is closed before the session object is deleted, +then the results of calling any session module function, including +.Fn sqlite3session_delete +on the session object are undefined. +.Pp +Because the session module uses the +.Fn sqlite3_preupdate_hook +API, it is not possible for an application to register a pre-update +hook on a database handle that has one or more session objects attached. +Nor is it possible to create a session object attached to a database +handle for which a pre-update hook is already defined. +The results of attempting either of these things are undefined. +.Pp +The session object will be used to create changesets for tables in +database zDb, where zDb is either "main", or "temp", or the name of +an attached database. +It is not an error if database zDb is not attached to the database +when the session object is created. +.Sh IMPLEMENTATION NOTES +These declarations were extracted from the +interface documentation at line 10953. +.Bd -literal +SQLITE_API int sqlite3session_create( + sqlite3 *db, /* Database handle */ + const char *zDb, /* Name of db (e.g. "main") */ + sqlite3_session **ppSession /* OUT: New session object */ +); +.Ed +.Sh SEE ALSO +.Xr sqlite3_preupdate_hook 3 , +.Xr sqlite3session_delete 3 |
