gristlabs_grist-core/app/plugin
Alex Hall 1864b7ba5d (core) Add BulkAddOrUpdateRecord action for efficiency
Summary:
This diff adds a new `BulkAddOrUpdateRecord` user action which is what is sounds like:

- A bulk version of the existing `AddOrUpdateRecord` action.
- Much more efficient for operating on many records than applying many individual actions.
- Column values are specified as maps from `colId` to arrays of values as usual.
- Produces bulk versions of `AddRecord` and `UpdateRecord` actions instead of many individual actions.

Examples of users wanting to use something like `AddOrUpdateRecord` with large numbers of records:

- https://grist.slack.com/archives/C0234CPPXPA/p1651789710290879
- https://grist.slack.com/archives/C0234CPPXPA/p1660743493480119
- https://grist.slack.com/archives/C0234CPPXPA/p1660333148491559
- https://grist.slack.com/archives/C0234CPPXPA/p1663069291726159

I tested what made many `AddOrUpdateRecord` actions slow in the first place. It was almost entirely due to producing many individual `AddRecord` user actions. About half of that time was for processing the resulting `AddRecord` doc actions. Lookups and updates were not a problem. With these changes, the slowness is gone.

The Python user action implementation is more complex but there are no surprises. The JS API now groups `records` based on the keys of `require` and `fields` so that `BulkAddOrUpdateRecord` can be applied to each group.

Test Plan: Update and extend Python and DocApi tests.

Reviewers: jarek, paulfitz

Reviewed By: jarek, paulfitz

Subscribers: jarek

Differential Revision: https://phab.getgrist.com/D3642
2022-09-28 17:58:33 +02:00
..
CustomSectionAPI-ti.ts (core) Run and test imports only in Python 3, upgrade openpyxl, fix weird date handling 2022-09-02 16:27:34 +02:00
CustomSectionAPI.ts add a description property to column mapping for custom widgets (#255) 2022-08-26 08:25:34 -04:00
DocApiTypes-ti.ts (core) add grist.selectedTable.create/update/destroy/upsert to custom widget api 2022-03-15 11:11:58 -04:00
DocApiTypes.ts (core) flesh out getAccessToken API documentation 2022-07-28 08:50:12 -04:00
FileParserAPI-ti.ts (core) Adding schema validation for records endpoint 2021-10-18 21:40:50 +02:00
FileParserAPI.ts (core) move home server into core 2020-07-21 20:39:10 -04:00
grist-plugin-api.ts (core) flesh out getAccessToken API documentation 2022-07-28 08:50:12 -04:00
GristAPI-ti.ts (core) add an access token mechanism to help with attachments in custom widgets 2022-07-19 11:55:18 -04:00
GristAPI.ts (core) flesh out getAccessToken API documentation 2022-07-28 08:50:12 -04:00
GristData-ti.ts (core) Update Plugin API documentation 2022-05-24 17:27:34 -07:00
GristData.ts (core) flesh out getAccessToken API documentation 2022-07-28 08:50:12 -04:00
GristTable-ti.ts (core) add grist.onRecord and grist.onRecords event handlers 2020-08-13 14:34:23 -04:00
GristTable.ts (core) Update Plugin API documentation 2022-05-24 17:27:34 -07:00
gutil.ts (core) add grist.selectedTable.create/update/destroy/upsert to custom widget api 2022-03-15 11:11:58 -04:00
ImportSourceAPI-ti.ts (core) move home server into core 2020-07-21 20:39:10 -04:00
ImportSourceAPI.ts (core) move home server into core 2020-07-21 20:39:10 -04:00
InternalImportSourceAPI-ti.ts (core) Adding schema validation for records endpoint 2021-10-18 21:40:50 +02:00
InternalImportSourceAPI.ts (core) move home server into core 2020-07-21 20:39:10 -04:00
objtypes.ts (core) Use GristObjCode in CellValue 2021-10-11 14:11:32 +02:00
PluginManifest-ti.ts (core) Adding import from google drive to the home screen 2021-08-05 20:46:11 +02:00
PluginManifest.ts (core) Adding import from google drive to the home screen 2021-08-05 20:46:11 +02:00
README.md (core) configure typedoc for generating plugin api documentation 2022-04-04 18:11:33 -04:00
RenderOptions-ti.ts (core) Adding schema validation for records endpoint 2021-10-18 21:40:50 +02:00
RenderOptions.ts (core) configure typedoc for generating plugin api documentation 2022-04-04 18:11:33 -04:00
StorageAPI-ti.ts (core) Adding schema validation for records endpoint 2021-10-18 21:40:50 +02:00
StorageAPI.ts (core) move home server into core 2020-07-21 20:39:10 -04:00
TableOperations.ts (core) Update Plugin API documentation 2022-05-24 17:27:34 -07:00
TableOperationsImpl.ts (core) Add BulkAddOrUpdateRecord action for efficiency 2022-09-28 17:58:33 +02:00
tsconfig.json (core) move home server into core 2020-07-21 20:39:10 -04:00
TypeCheckers.ts (core) Speed up and upgrade build. 2022-06-27 16:10:10 -04:00
WidgetAPI-ti.ts (core) Widget options api 2022-01-13 11:10:17 +01:00
WidgetAPI.ts (core) Widget options api 2022-01-13 11:10:17 +01:00

Methods here are available for use in Grist custom widgets.