Skip to content

Commit 750b53c

Browse files
committed
Update associated generated files
1 parent 7569f31 commit 750b53c

2 files changed

Lines changed: 43 additions & 8 deletions

File tree

src/apsw.docstrings

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,25 +1054,39 @@
10541054

10551055

10561056
#define ChangesetBuilder_add_delete_DOC "ChangesetBuilder.add_delete(table: str, indirect: bool, row: SQLiteValues) -> None\n\n" \
1057-
"Adds an ``delete`` change row.\n" \
1057+
"Adds an ``delete`` change row. You must have called :meth:`schema` first so\n" \
1058+
" the table can be verified.\n" \
10581059
"\n" \
10591060
".. seealso::\n" \
10601061
"\n" \
10611062
" * :meth:`add_insert`\n" \
10621063
" * :meth:`add_update`\n" \
10631064
"\n" \
10641065
"\n" \
1065-
" Calls: `sqlite3changegroup_change_begin <https://sqlite.org/session/sqlite3changegroup_change_begin.html>`__\n"
1066+
" Calls: `sqlite3changegroup_change_begin <https://sqlite.org/session/sqlite3changegroup_change_begin.html>`__\n" \
1067+
" Calls: `sqlite3changegroup_change_finish <https://sqlite.org/session/sqlite3changegroup_change_finish.html>`__\n"
1068+
1069+
#define ChangesetBuilder_add_delete_KWNAMES "table", "indirect", "row"
1070+
#define ChangesetBuilder_add_delete_USAGE "ChangesetBuilder.add_delete(table: str, indirect: bool, row: SQLiteValues) -> None"
1071+
1072+
#define ChangesetBuilder_add_delete_CHECK do { \
1073+
assert(__builtin_types_compatible_p(typeof(table), const char *)); \
1074+
assert(__builtin_types_compatible_p(typeof(indirect), int)); \
1075+
assert(__builtin_types_compatible_p(typeof(row), PyObject *)); \
1076+
} while(0)
1077+
10661078

10671079
#define ChangesetBuilder_add_insert_DOC "ChangesetBuilder.add_insert(table: str, indirect: bool, row: SQLiteValues) -> None\n\n" \
1068-
"Adds an ``insert`` change row.\n" \
1080+
"Adds an ``insert`` change row. You must have called :meth:`schema` first so\n" \
1081+
"the table can be verified.\n" \
10691082
"\n" \
10701083
".. seealso::\n" \
10711084
"\n" \
10721085
" * :meth:`add_delete`\n" \
10731086
" * :meth:`add_update`\n" \
10741087
"\n" \
1075-
"Calls: `sqlite3changegroup_change_begin <https://sqlite.org/session/sqlite3changegroup_change_begin.html>`__\n"
1088+
"Calls: `sqlite3changegroup_change_begin <https://sqlite.org/session/sqlite3changegroup_change_begin.html>`__\n" \
1089+
"Calls: `sqlite3changegroup_change_finish <https://sqlite.org/session/sqlite3changegroup_change_finish.html>`__\n"
10761090

10771091
#define ChangesetBuilder_add_insert_KWNAMES "table", "indirect", "row"
10781092
#define ChangesetBuilder_add_insert_USAGE "ChangesetBuilder.add_insert(table: str, indirect: bool, row: SQLiteValues) -> None"
@@ -1085,18 +1099,38 @@
10851099

10861100

10871101
#define ChangesetBuilder_add_update_DOC "ChangesetBuilder.add_update(table: str, indirect: bool, old: SQLiteValues, new: SQLiteValues) -> None\n\n" \
1088-
"Adds an ``update`` change giving old and new rows.\n" \
1102+
"Adds an ``update`` change giving old and new rows. You must have called :meth:`schema` first so\n" \
1103+
"the table can be verified.\n" \
1104+
"\n" \
1105+
"See `sqlite3changegroup_change_finish <https://sqlite.org/session/sqlite3changegroup_change_finish.html>`__\n" \
1106+
"for details on which columns of old and new you must provide values for. Where no value should be\n" \
1107+
"provided, use :attr:`apsw.no_change`.\n" \
10891108
"\n" \
10901109
".. seealso::\n" \
10911110
"\n" \
10921111
" * :meth:`add_insert`\n" \
10931112
" * :meth:`add_delete`\n" \
10941113
"\n" \
1095-
"Calls: `sqlite3changegroup_change_begin <https://sqlite.org/session/sqlite3changegroup_change_begin.html>`__\n"
1114+
"Calls: `sqlite3changegroup_change_begin <https://sqlite.org/session/sqlite3changegroup_change_begin.html>`__\n" \
1115+
"Calls: `sqlite3changegroup_change_finish <https://sqlite.org/session/sqlite3changegroup_change_finish.html>`__\n"
1116+
1117+
#define ChangesetBuilder_add_update_KWNAMES "table", "indirect", "old", "new"
1118+
#define ChangesetBuilder_add_update_USAGE "ChangesetBuilder.add_update(table: str, indirect: bool, old: SQLiteValues, new: SQLiteValues) -> None"
1119+
1120+
#define ChangesetBuilder_add_update_CHECK do { \
1121+
assert(__builtin_types_compatible_p(typeof(table), const char *)); \
1122+
assert(__builtin_types_compatible_p(typeof(indirect), int)); \
1123+
assert(__builtin_types_compatible_p(typeof(old), PyObject *)); \
1124+
assert(__builtin_types_compatible_p(typeof(new), PyObject *)); \
1125+
} while(0)
1126+
10961127

10971128
#define ChangesetBuilder_class_DOC "This object wraps a `sqlite3_changegroup <https://sqlite.org/session/changegroup.html>`__\n" \
1098-
"letting you concatenate changesets and individual :class:`TableChange` into one larger\n" \
1099-
"changeset.\n"
1129+
"to build a changeset or patchset. The contents can come from:\n" \
1130+
"\n" \
1131+
"* Existing changesets\n" \
1132+
"* Individual :class:`TableChange`\n" \
1133+
"* :meth:`add_insert`, :meth:`add_update`, :meth:`add_delete`\n"
11001134

11011135
#define ChangesetBuilder_close_DOC "ChangesetBuilder.close() -> None\n\n" \
11021136
"Releases the builder\n" \

tools/tocupdate.sql

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ insert into toc values
8181
('sqlite3changegroup_add_change', 'function', 0, 'Add A Single Change To A Changegroup', 'session/sqlite3changegroup_add_change.html'),
8282
('sqlite3changegroup_add_strm', 'function', 0, 'Streaming Versions of API functions.', 'session/sqlite3changegroup_add_strm.html'),
8383
('sqlite3changegroup_change_begin', 'function', 0, 'Begin adding a change to a changegroup', 'session/sqlite3changegroup_change_begin.html'),
84+
('sqlite3changegroup_change_finish', 'function', 0, 'Finish adding one-at-at-time changes to a changegroup', 'session/sqlite3changegroup_change_finish.html'),
8485
('sqlite3changegroup_delete', 'function', 0, 'Delete A Changegroup Object', 'session/sqlite3changegroup_delete.html'),
8586
('sqlite3changegroup_new', 'function', 0, 'Create A New Changegroup Object', 'session/sqlite3changegroup_new.html'),
8687
('sqlite3changegroup_config', 'function', 0, 'Configure a changegroup object', 'session/sqlite3changegroup_config.html'),

0 commit comments

Comments
 (0)