diff options
Diffstat (limited to 'static/netbsd/man3/sqlite3changeset_op.3')
| -rw-r--r-- | static/netbsd/man3/sqlite3changeset_op.3 | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/static/netbsd/man3/sqlite3changeset_op.3 b/static/netbsd/man3/sqlite3changeset_op.3 new file mode 100644 index 00000000..3a6a2cb9 --- /dev/null +++ b/static/netbsd/man3/sqlite3changeset_op.3 @@ -0,0 +1,70 @@ +.Dd January 24, 2024 +.Dt SQLITE3CHANGESET_OP 3 +.Os +.Sh NAME +.Nm sqlite3changeset_op +.Nd obtain the current operation from a changeset iterator +.Sh SYNOPSIS +.In sqlite3.h +.Ft int +.Fo sqlite3changeset_op +.Fa "sqlite3_changeset_iter *pIter" +.Fa "const char **pzTab" +.Fa "int *pnCol" +.Fa "int *pOp" +.Fa "int *pbIndirect" +.Fc +.Sh DESCRIPTION +The pIter argument passed to this function may either be an iterator +passed to a conflict-handler by +.Fn sqlite3changeset_apply , +or an iterator created by +.Fn sqlite3changeset_start . +In the latter case, the most recent call to +.Fn sqlite3changeset_next +must have returned SQLITE_ROW. +If this is not the case, this function returns SQLITE_MISUSE. +.Pp +Arguments pOp, pnCol and pzTab may not be NULL. +Upon return, three outputs are set through these pointers: +.Pp +*pOp is set to one of SQLITE_INSERT, SQLITE_DELETE +or SQLITE_UPDATE, depending on the type of change that +the iterator currently points to; +.Pp +*pnCol is set to the number of columns in the table affected by the +change; and +.Pp +*pzTab is set to point to a nul-terminated utf-8 encoded string containing +the name of the table affected by the current change. +The buffer remains valid until either sqlite3changeset_next() is called +on the iterator or until the conflict-handler function returns. +.Pp +If pbIndirect is not NULL, then *pbIndirect is set to true (1) if the +change is an indirect change, or false (0) otherwise. +See the documentation for +.Fn sqlite3session_indirect +for a description of direct and indirect changes. +.Pp +If no error occurs, SQLITE_OK is returned. +If an error does occur, an SQLite error code is returned. +The values of the output variables may not be trusted in this case. +.Sh IMPLEMENTATION NOTES +These declarations were extracted from the +interface documentation at line 11527. +.Bd -literal +SQLITE_API int sqlite3changeset_op( + sqlite3_changeset_iter *pIter, /* Iterator object */ + const char **pzTab, /* OUT: Pointer to table name */ + int *pnCol, /* OUT: Number of columns in table */ + int *pOp, /* OUT: SQLITE_INSERT, DELETE or UPDATE */ + int *pbIndirect /* OUT: True for an 'indirect' change */ +); +.Ed +.Sh SEE ALSO +.Xr sqlite3changeset_apply 3 , +.Xr sqlite3changeset_next 3 , +.Xr sqlite3changeset_start 3 , +.Xr sqlite3session_indirect 3 , +.Xr SQLITE_CREATE_INDEX 3 , +.Xr SQLITE_OK 3 |