xref: /netbsd-src/external/public-domain/sqlite/man/sqlite3changeset_fk_conflicts.3 (revision b9988867a8ad969c45a52aa7628bc932ec98d46b)
1.Dd January 24, 2024
2.Dt SQLITE3CHANGESET_FK_CONFLICTS 3
3.Os
4.Sh NAME
5.Nm sqlite3changeset_fk_conflicts
6.Nd determine the number of foreign key constraint violations
7.Sh SYNOPSIS
8.In sqlite3.h
9.Ft int
10.Fo sqlite3changeset_fk_conflicts
11.Fa "sqlite3_changeset_iter *pIter"
12.Fa "int *pnOut"
13.Fc
14.Sh DESCRIPTION
15This function may only be called with an iterator passed to an SQLITE_CHANGESET_FOREIGN_KEY
16conflict handler callback.
17In this case it sets the output variable to the total number of known
18foreign key violations in the destination database and returns SQLITE_OK.
19.Pp
20In all other cases this function returns SQLITE_MISUSE.
21.Sh IMPLEMENTATION NOTES
22These declarations were extracted from the
23interface documentation at line 11692.
24.Bd -literal
25SQLITE_API int sqlite3changeset_fk_conflicts(
26  sqlite3_changeset_iter *pIter,  /* Changeset iterator */
27  int *pnOut                      /* OUT: Number of FK violations */
28);
29.Ed
30