@saltcorn/server 1.5.0-beta.12 → 1.5.0-beta.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/_saltcorn_admin-models.models_snapshot.Snapshot.html +2 -2
- package/docs/classes/_saltcorn_common-code.relations_relation.Relation.html +3 -3
- package/docs/classes/_saltcorn_common-code.relations_relations_finder.RelationsFinder.html +5 -5
- package/docs/classes/_saltcorn_data.diagram_cy_raster.CytoscapeRaster.html +4 -4
- package/docs/classes/_saltcorn_data.diagram_nodes_dummy_node.DummyNode.html +4 -4
- package/docs/classes/_saltcorn_data.diagram_nodes_node.Node.html +4 -4
- package/docs/classes/_saltcorn_data.diagram_nodes_page_node.PageNode.html +4 -4
- package/docs/classes/_saltcorn_data.diagram_nodes_table_node.TableNode.html +4 -4
- package/docs/classes/_saltcorn_data.diagram_nodes_trigger_node.TriggerNode.html +4 -4
- package/docs/classes/_saltcorn_data.diagram_nodes_view_node.ViewNode.html +4 -4
- package/docs/classes/_saltcorn_data.mobile-mocks_node_async_hooks.AsyncLocalStorage.html +2 -2
- package/docs/classes/_saltcorn_data.models_crash.Crash.html +2 -2
- package/docs/classes/_saltcorn_data.models_eventlog.EventLog.html +2 -2
- package/docs/classes/_saltcorn_data.models_field.Field.html +9 -9
- package/docs/classes/_saltcorn_data.models_fieldrepeat.FieldRepeat.html +2 -2
- package/docs/classes/_saltcorn_data.models_file.File.html +27 -21
- package/docs/classes/_saltcorn_data.models_form.Form.html +2 -2
- package/docs/classes/_saltcorn_data.models_internal_mail_queue.MailQueue.html +4 -4
- package/docs/classes/_saltcorn_data.models_internal_push_message_helper.PushMessageHelper.html +21 -11
- package/docs/classes/_saltcorn_data.models_library.Library.html +2 -2
- package/docs/classes/_saltcorn_data.models_model.Model.html +2 -2
- package/docs/classes/_saltcorn_data.models_model_instance.ModelInstance.html +2 -2
- package/docs/classes/_saltcorn_data.models_notification.Notification.html +2 -2
- package/docs/classes/_saltcorn_data.models_page.Page.html +11 -11
- package/docs/classes/_saltcorn_data.models_page_group.PageGroup.html +16 -16
- package/docs/classes/_saltcorn_data.models_page_group_member.PageGroupMember.html +8 -8
- package/docs/classes/_saltcorn_data.models_plugin.Plugin.html +9 -9
- package/docs/classes/_saltcorn_data.models_role.Role.html +2 -2
- package/docs/classes/_saltcorn_data.models_table.Table.html +65 -65
- package/docs/classes/_saltcorn_data.models_table_constraints.TableConstraint.html +2 -2
- package/docs/classes/_saltcorn_data.models_tag.Tag.html +2 -2
- package/docs/classes/_saltcorn_data.models_tag_entry.TagEntry.html +2 -2
- package/docs/classes/_saltcorn_data.models_trigger.Trigger.html +19 -19
- package/docs/classes/_saltcorn_data.models_user.User.html +32 -32
- package/docs/classes/_saltcorn_data.models_view.View.html +15 -15
- package/docs/classes/_saltcorn_data.models_workflow.Workflow.html +2 -2
- package/docs/classes/_saltcorn_data.models_workflow_run.WorkflowRun.html +2 -2
- package/docs/classes/_saltcorn_data.models_workflow_step.WorkflowStep.html +2 -2
- package/docs/classes/_saltcorn_data.models_workflow_trace.MetaData.html +2 -2
- package/docs/classes/_saltcorn_data.models_workflow_trace.WorkflowTrace.html +2 -2
- package/docs/classes/_saltcorn_mobile-builder.mobile-builder.MobileBuilder.html +4 -2
- package/docs/classes/_saltcorn_mobile-builder.utils_capacitor-helper.CapacitorHelper.html +2 -2
- package/docs/enums/_saltcorn_common-code.relations_relation_types.RelationType.html +2 -2
- package/docs/enums/_saltcorn_common-code.relations_relation_types.ViewDisplayType.html +2 -2
- package/docs/functions/_saltcorn_admin-models.models_config-check.runConfigurationCheck.html +1 -1
- package/docs/functions/_saltcorn_common-code.relations_relation_helpers.buildRelationPath.html +1 -1
- package/docs/functions/_saltcorn_common-code.relations_relation_helpers.buildTableCaches.html +1 -1
- package/docs/functions/_saltcorn_common-code.relations_relation_helpers.parseLegacyRelation.html +1 -1
- package/docs/functions/_saltcorn_common-code.relations_relation_helpers.parseRelationPath.html +1 -1
- package/docs/functions/_saltcorn_common-code.tests_test_data.fixturesData.html +1 -1
- package/docs/functions/_saltcorn_common-code.tests_test_data.withAnotherUserField.html +1 -1
- package/docs/functions/_saltcorn_common-code.tests_test_data.withKeyFromLayerThree.html +1 -1
- package/docs/functions/_saltcorn_common-code.tests_test_data.withKeyFromLayerTwo.html +1 -1
- package/docs/functions/_saltcorn_common-code.tests_test_data.withMultipleInbounds.html +1 -1
- package/docs/functions/_saltcorn_common-code.tests_test_data.withSecondTopicField.html +1 -1
- package/docs/functions/_saltcorn_common-code.tests_test_data.withSimplePostTopicrelation.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_fieldviews.radio_select.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_fieldviews.search_or_create.configFields.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_fieldviews.search_or_create.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_fieldviews.select.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_fieldviews.select_from_table.fill_options.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_fieldviews.select_from_table.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.contract.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.fieldviews.TrueFalse.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.fieldviews.checkboxes.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.fieldviews.edit.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.fieldviews.show.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.fieldviews.tristate.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.listAs.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.read.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.readFromDB.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.readFromFormRecord.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.bool.validate.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.color.contract.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.color.fieldviews.edit.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.color.fieldviews.show.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.color.read.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.color.validate.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.contract.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.equals.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.fieldviews.edit.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.fieldviews.editDay.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.fieldviews.format.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.fieldviews.relative.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.fieldviews.show.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.fieldviews.showDay.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.fieldviews.yearsAgo.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.presets.Now.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.read.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.date.validate.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.float.contract.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.float.equals.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.float.fieldviews.edit.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.float.fieldviews.show.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.float.read.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.float.validate.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.int.contract.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.int.read.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.int.validate.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.int.validate_attributes.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.attributes.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.contract.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.fieldviews.as_header.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.fieldviews.as_link.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.fieldviews.as_text.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.fieldviews.edit.configFields.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.fieldviews.edit.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.fieldviews.img_from_url.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.fieldviews.password.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.fieldviews.radio_group.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.fieldviews.textarea.run.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.presets.IP.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.presets.SessionID.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.read.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.validate.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_types.string.validate_attributes.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.action_link.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.action_url.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.fill_presets.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.getForm.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.get_view_link_query.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.get_viewable_fields.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.get_viewable_fields_from_layout.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.make_link.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.objToQueryString.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.parse_view_select.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.splitUniques.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.standardBlockDispatch.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.standardLayoutRowVisitor.html +1 -1
- package/docs/functions/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.view_linker.html +1 -1
- package/docs/functions/_saltcorn_data.db_connect_mobile.getConnectObject.html +1 -1
- package/docs/functions/_saltcorn_data.db_reset_schema.reset.html +1 -1
- package/docs/functions/_saltcorn_data.diagram_cy_generate_utils.generateCyCode.html +1 -1
- package/docs/functions/_saltcorn_data.diagram_cy_generate_utils.genereateCyCfg.html +1 -1
- package/docs/functions/_saltcorn_data.diagram_node_extract_utils.buildObjectTrees.html +1 -1
- package/docs/functions/_saltcorn_data.diagram_node_extract_utils.extractFromColumns.html +1 -1
- package/docs/functions/_saltcorn_data.diagram_node_extract_utils.extractFromLayout.html +1 -1
- package/docs/functions/_saltcorn_data.diagram_node_extract_utils.extractViewToCreate.html +1 -1
- package/docs/functions/_saltcorn_data.migrate.create_blank_migration.html +1 -1
- package/docs/functions/_saltcorn_data.migrate.getMigrationsInDB.html +1 -1
- package/docs/functions/_saltcorn_data.migrate.migrate.html +1 -1
- package/docs/functions/_saltcorn_data.migrations_202102091312.js.html +1 -1
- package/docs/functions/_saltcorn_data.migrations_202210051058.js.html +1 -1
- package/docs/functions/_saltcorn_data.migrations_202210101540.js.html +1 -1
- package/docs/functions/_saltcorn_data.migrations_202304281224.js.html +1 -1
- package/docs/functions/_saltcorn_data.migrations_202307211459.js.html +1 -1
- package/docs/functions/_saltcorn_data.migrations_202502131103.js.html +1 -1
- package/docs/functions/_saltcorn_data.migrations_202508011455.js.html +1 -1
- package/docs/functions/_saltcorn_data.migrations_202510152058.js.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_child_process.execSync.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_fs.createReadStream.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_fs.readdirSync.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_fs.writeFileSync.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_fs_promises.mkdir.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_fs_promises.readFile.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_fs_promises.stat.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_fs_promises.unlink.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_fs_promises.writeFile.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_latest-version.latestVersion.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_v8.deserialize.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_node_v8.serialize.html +1 -1
- package/docs/functions/_saltcorn_data.mobile-mocks_npm_env-paths.envPaths.html +1 -1
- package/docs/functions/_saltcorn_data.model-helper.get_predictor.html +1 -1
- package/docs/functions/_saltcorn_data.model-helper.run_jupyter_model.html +1 -1
- package/docs/functions/_saltcorn_data.model-helper.shorten_trackback.html +1 -1
- package/docs/functions/_saltcorn_data.model-helper.write_csv.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_async_json_stream.async_json_stream.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_query.aggregation_query_fields.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_query.getAggAndField.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_query.joinfield_renamer.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_query.process_aggregations.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.buildKeyFromRelative.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.copyObject.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.deleteObject.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.downloadBuffer.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.getPublicFileUrl.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.getResolvedBucket.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.getS3Client.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.getServeUrl.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.getSignedFileUrl.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.headObject.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.isS3Enabled.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.listS3Folder.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.publicUrlToRelativePath.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.relativeKeyToPath.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.setObjectMetadata.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_s3_helpers.uploadBuffer.html +1 -0
- package/docs/functions/_saltcorn_data.models_internal_table_helper.boolExamples.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_table_helper.colorExamples.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_table_helper.floatExamples.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_table_helper.get_formula_examples.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_table_helper.intExamples.html +1 -1
- package/docs/functions/_saltcorn_data.models_internal_table_helper.stringExamples.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.build_schema_data.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.calcfldViewConfig.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.calcfldViewOptions.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.calcrelViewOptions.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.displayType.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.field_picker_fields.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.generate_joined_query.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.getActionConfigFields.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.get_child_views.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.get_inbound_relation_opts.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.get_inbound_self_relation_opts.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.get_link_view_opts.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.get_many_to_many_relation_opts.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.get_parent_views.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.initial_config_all_fields.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.json_list_to_external_table.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.link_view.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.pathToState.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.picked_fields_to_query.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.readState.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.readStateStrict.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.runCollabEvents.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.run_action_column.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.stateFieldsToQuery.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.stateFieldsToWhere.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.stateToQueryString.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-helper.strictParseInt.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-testing.auto_test_plugin.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-testing.check_view_columns.html +1 -1
- package/docs/functions/_saltcorn_data.plugin-testing.generate_attributes.html +1 -1
- package/docs/functions/_saltcorn_data.standard-menu.create_standard_menu.html +1 -1
- package/docs/functions/_saltcorn_data.tests_assertions.assertIsErrorMsg.html +1 -1
- package/docs/functions/_saltcorn_data.tests_assertions.assertIsErrorsMsg.html +1 -1
- package/docs/functions/_saltcorn_data.tests_assertions.assertIsRow.html +1 -1
- package/docs/functions/_saltcorn_data.tests_assertions.assertIsSet.html +1 -1
- package/docs/functions/_saltcorn_data.tests_assertions.assertIsType.html +1 -1
- package/docs/functions/_saltcorn_data.tests_assertions.assertsIsSuccessMessage.html +1 -1
- package/docs/functions/_saltcorn_data.tests_assertions.assertsObjectIsUser.html +1 -1
- package/docs/functions/_saltcorn_data.tests_common_helpers.createAnotherUserField.html +1 -1
- package/docs/functions/_saltcorn_data.tests_common_helpers.createKeyFromLevelTwo.html +1 -1
- package/docs/functions/_saltcorn_data.tests_common_helpers.createLevelThreeInbound.html +1 -1
- package/docs/functions/_saltcorn_data.tests_common_helpers.createMultipleInbounds.html +1 -1
- package/docs/functions/_saltcorn_data.tests_common_helpers.createSecondTopicField.html +1 -1
- package/docs/functions/_saltcorn_data.tests_common_helpers.prepareEmployeeDepartment.html +1 -1
- package/docs/functions/_saltcorn_data.tests_common_helpers.prepareSimpleTopicPostRelation.html +1 -1
- package/docs/functions/_saltcorn_data.tests_remote_query_helper.deleteViewFromServer.html +1 -1
- package/docs/functions/_saltcorn_data.tests_remote_query_helper.prepareQueryEnviroment.html +1 -1
- package/docs/functions/_saltcorn_data.tests_remote_query_helper.sendViewToServer.html +1 -1
- package/docs/functions/_saltcorn_data.translate.hasLLM.html +1 -1
- package/docs/functions/_saltcorn_data.translate.translate.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.ftsFieldsSqlExpr.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.mkSelectOptions.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.mkWhere.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.orderByIsObject.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.orderByIsOperator.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.prefixFieldsInWhere.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.sqlBinOp.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.sqlFun.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.sqlsanitize.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.sqlsanitizeAllowDots.html +1 -1
- package/docs/functions/_saltcorn_db-common.internal.subSelectWhere.html +1 -1
- package/docs/functions/_saltcorn_db-common.multi-tenant.enable_multi_tenant.html +1 -1
- package/docs/functions/_saltcorn_db-common.multi-tenant.getRequestContext.html +1 -1
- package/docs/functions/_saltcorn_db-common.multi-tenant.getTenantSchema.html +1 -1
- package/docs/functions/_saltcorn_db-common.multi-tenant.init.html +1 -1
- package/docs/functions/_saltcorn_db-common.multi-tenant.is_it_multi_tenant.html +1 -1
- package/docs/functions/_saltcorn_db-common.multi-tenant.runWithTenant.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.buildInsertBulkSql.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.buildInsertSql.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.commitAndBeginNewTransaction.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.doCount.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.doDeleteWhere.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.doListScTables.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.doListTables.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.doListUserDefinedTables.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.do_add_index.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.do_drop_index.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.mkVal.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.openOrUseTransaction.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.reprAsJson.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.slugify.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.tryCatchInTransaction.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.whenTransactionisFree.html +1 -1
- package/docs/functions/_saltcorn_db-common.sqlite-commons.withTransaction.html +1 -1
- package/docs/functions/_saltcorn_markup.mktag.mkTag.html +1 -1
- package/docs/functions/_saltcorn_markup.tabs.tabs.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.androidFeatures.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.androidPermissions.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.buildTablesFile.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.copyPrepopulatedDb.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.copyServerFiles.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.copyShareExtFiles.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.copySiteLogo.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.copyTranslationFiles.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.createSqliteDb.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.decodeProvisioningProfile.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.extractDomain.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.generateAndroidVersionCode.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.hasAuthMethod.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.modifyAndroidManifest.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.modifyConfigXml.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.modifyGradleConfig.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.modifyInfoPlist.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.modifyXcodeProjectFile.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.prepAppIcon.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.prepareAppIcon.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.prepareBuildDir.html +2 -2
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.prepareExportOptionsPlist.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.prepareSplashIcon.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.prepareSplashPage.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.writeCapacitorConfig.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.writeCfgFile.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.writeDataExtractionRules.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.writeNetworkSecurityConfig.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.writePodfile.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_common-build-utils.writePrivacyInfo.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_package-bundle-utils.bundleMobileAppCode.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_package-bundle-utils.bundlePackagesAndPlugins.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_package-bundle-utils.copyMobileAppDirs.html +1 -1
- package/docs/functions/_saltcorn_mobile-builder.utils_package-bundle-utils.copyOptionalSource.html +1 -0
- package/docs/functions/_saltcorn_mobile-builder.utils_package-bundle-utils.copyPluginMobileAppDirs.html +4 -0
- package/docs/functions/_saltcorn_mobile-builder.utils_package-bundle-utils.copyPublicDirs.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.add_index.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.add_unique_constraint.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.count.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.deleteWhere.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.drop_index.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.drop_reset_schema.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.drop_unique_constraint.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.init.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.insert.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.insertRows.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.listScTables.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.listTables.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.listUserDefinedTables.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.query.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.select.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.selectMaybeOne.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.selectOne.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.setConnectionObject.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.tableExists.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.time.html +1 -1
- package/docs/functions/_saltcorn_sqlite-mobile.sqlite_capacitor.update.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.add_index.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.add_unique_constraint.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.begin.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.changeConnection.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.close.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.commit.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.count.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.deleteWhere.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.dropTable.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.dropTables.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.drop_index.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.drop_reset_schema.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.drop_unique_constraint.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.getVersion.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.get_db_filepath.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.get_sql_logging.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.init.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.insert.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.listScTables.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.listTables.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.listUserDefinedTables.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.query.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.rollback.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.select.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.selectMaybeOne.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.selectOne.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.set_sql_logging.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.sql_log.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.update.html +1 -1
- package/docs/functions/_saltcorn_sqlite.sqlite.updateWhere.html +1 -1
- package/docs/functions/_saltcorn_types.base_types.instanceOWithHtmlFile.html +1 -1
- package/docs/functions/_saltcorn_types.common_types.instanceOfErrorMsg.html +1 -1
- package/docs/functions/_saltcorn_types.common_types.instanceOfSuccessMsg.html +1 -1
- package/docs/functions/_saltcorn_types.common_types.instanceOfType.html +1 -1
- package/docs/functions/_saltcorn_types.model-abstracts_abstract_field.instanceOfField.html +1 -1
- package/docs/functions/_saltcorn_types.model-abstracts_abstract_page.instanceOfPage.html +1 -1
- package/docs/functions/_saltcorn_types.model-abstracts_abstract_view.instanceOfView.html +1 -1
- package/docs/hierarchy.html +1 -1
- package/docs/interfaces/_saltcorn_db-common.dbtypes.UserLike.html +2 -2
- package/docs/interfaces/_saltcorn_markup.types.TagExports.html +2 -2
- package/docs/interfaces/_saltcorn_mobile-builder.utils_common-build-utils.ScCapacitorConfig.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_field.AbstractField.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_field.AbstractFieldRepeat.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_form.AbstractForm.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_page.AbstractPage.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_page_group.AbstractPageGroup.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_page_group_member.AbstractPageGroupMember.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_role.AbstractRole.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_tag.AbstractTag.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_tag_entry.AbstractTagEntry.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_trigger.AbstractTrigger.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_view.AbstractView.html +2 -2
- package/docs/interfaces/_saltcorn_types.model-abstracts_abstract_workflow.AbstractWorkflow.html +2 -2
- package/docs/modules/_saltcorn_data.html +1 -1
- package/docs/modules/_saltcorn_data.mobile-mocks_npm_dockerode.html +1 -0
- package/docs/modules/_saltcorn_data.models_internal_s3_helpers-1.html +1 -0
- package/docs/modules/_saltcorn_data.models_internal_s3_helpers.html +1 -0
- package/docs/modules/_saltcorn_mobile-builder.utils_package-bundle-utils.html +1 -1
- package/docs/types/_saltcorn_data.diagram_node_extract_utils.ExtractOpts.html +2 -2
- package/docs/types/_saltcorn_data.diagram_node_extract_utils.ExtractResult.html +2 -2
- package/docs/types/_saltcorn_data.diagram_nodes_node.NodeType.html +1 -1
- package/docs/types/_saltcorn_data.models_config.ConfigTypes.html +1 -1
- package/docs/types/_saltcorn_data.models_config.SingleConfig.html +1 -1
- package/docs/types/_saltcorn_data.models_eventlog.EventLogCfg.html +2 -2
- package/docs/types/_saltcorn_data.models_file.FileCfg.html +2 -2
- package/docs/types/_saltcorn_data.models_form.AdditionalButton.html +1 -1
- package/docs/types/_saltcorn_data.models_form.FormCfg.html +2 -2
- package/docs/types/_saltcorn_data.models_internal_push_message_helper.FcmSubscription.html +3 -2
- package/docs/types/_saltcorn_data.models_internal_push_message_helper.Subscription.html +1 -1
- package/docs/types/_saltcorn_data.models_internal_push_message_helper.WebPushSubscription.html +2 -2
- package/docs/types/_saltcorn_data.models_internal_s3_helpers.S3HeadResult.html +1 -0
- package/docs/types/_saltcorn_data.models_internal_s3_helpers.S3ListResult.html +5 -0
- package/docs/types/_saltcorn_data.models_page_group.ScreenInfoParams.html +2 -2
- package/docs/types/_saltcorn_data.models_table.ChildRelations.html +2 -2
- package/docs/types/_saltcorn_data.models_table.ParentRelations.html +2 -2
- package/docs/types/_saltcorn_data.models_table.RelationData.html +2 -2
- package/docs/types/_saltcorn_data.models_tag_entry.TagEntryCfg.html +1 -1
- package/docs/types/_saltcorn_data.models_view.FindViewsPred.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.AggregationOptions.html +2 -2
- package/docs/types/_saltcorn_db-common.dbtypes.CoordOpts.html +2 -2
- package/docs/types/_saltcorn_db-common.dbtypes.DatabaseClient.html +2 -2
- package/docs/types/_saltcorn_db-common.dbtypes.JoinField.html +2 -2
- package/docs/types/_saltcorn_db-common.dbtypes.JoinFields.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.JoinOptions.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.JsonPath.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.JsonPathElem.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.Operator.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.PartialSome.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.Row.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.SelectOptions.html +2 -2
- package/docs/types/_saltcorn_db-common.dbtypes.StrongRow.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.SubselectOptions.html +2 -2
- package/docs/types/_saltcorn_db-common.dbtypes.Value.html +1 -1
- package/docs/types/_saltcorn_db-common.dbtypes.Where.html +2 -2
- package/docs/types/_saltcorn_db-common.sqlite-commons.SqlAndValues.html +2 -2
- package/docs/types/_saltcorn_db-common.types.DbExportsType.html +2 -2
- package/docs/types/_saltcorn_db-common.types.GenObj.html +1 -1
- package/docs/types/_saltcorn_markup.emergency_layout.WrapParams.html +2 -2
- package/docs/types/_saltcorn_markup.helpers.CheckBoxGroupOpts.html +2 -2
- package/docs/types/_saltcorn_markup.helpers.PaginationOpts.html +2 -2
- package/docs/types/_saltcorn_markup.helpers.RadioGroupOpts.html +2 -2
- package/docs/types/_saltcorn_markup.helpers.SearchBarOpts.html +2 -2
- package/docs/types/_saltcorn_markup.layout.RenderOpts-1.html +2 -2
- package/docs/types/_saltcorn_markup.layout.RenderOpts.html +2 -2
- package/docs/types/_saltcorn_markup.mjml-layout.RenderOpts.html +2 -2
- package/docs/types/_saltcorn_markup.table.HeadersParams.html +2 -2
- package/docs/types/_saltcorn_markup.table.OptsParams.html +2 -2
- package/docs/types/_saltcorn_markup.types.AttributeVal.html +1 -1
- package/docs/types/_saltcorn_markup.types.Attributes.html +2 -2
- package/docs/types/_saltcorn_markup.types.ClassVal.html +1 -1
- package/docs/types/_saltcorn_markup.types.Element.html +1 -1
- package/docs/types/_saltcorn_markup.types.Falsy.html +1 -1
- package/docs/types/_saltcorn_markup.types.StyleVal.html +1 -1
- package/docs/types/_saltcorn_markup.types.TagFunction.html +1 -1
- package/docs/types/_saltcorn_mobile-builder.mobile-builder.IosCfg.html +2 -2
- package/docs/types/_saltcorn_mobile-builder.utils_capacitor-helper.CapacitorCfg.html +2 -2
- package/docs/types/_saltcorn_types.base_types.Action.html +3 -3
- package/docs/types/_saltcorn_types.base_types.AuthenticationMethod.html +2 -2
- package/docs/types/_saltcorn_types.base_types.CalcJoinfield.html +2 -2
- package/docs/types/_saltcorn_types.base_types.CapacitorPlugin.html +2 -2
- package/docs/types/_saltcorn_types.base_types.CodePagePack.html +2 -2
- package/docs/types/_saltcorn_types.base_types.Column.html +2 -2
- package/docs/types/_saltcorn_types.base_types.ConnectObjType.html +2 -2
- package/docs/types/_saltcorn_types.base_types.ConnectedObjects.html +2 -2
- package/docs/types/_saltcorn_types.base_types.CopilotSkill.html +2 -2
- package/docs/types/_saltcorn_types.base_types.ErrorObj.html +2 -2
- package/docs/types/_saltcorn_types.base_types.FieldLike.html +1 -1
- package/docs/types/_saltcorn_types.base_types.FieldView.html +1 -1
- package/docs/types/_saltcorn_types.base_types.Header.html +2 -2
- package/docs/types/_saltcorn_types.base_types.JoinFieldOption.html +2 -2
- package/docs/types/_saltcorn_types.base_types.Layout.html +1 -1
- package/docs/types/_saltcorn_types.base_types.MobileConfig.html +5 -2
- package/docs/types/_saltcorn_types.base_types.ModelPattern.html +6 -6
- package/docs/types/_saltcorn_types.base_types.Pack.html +2 -2
- package/docs/types/_saltcorn_types.base_types.Plugin.html +1 -1
- package/docs/types/_saltcorn_types.base_types.PluginFunction.html +2 -2
- package/docs/types/_saltcorn_types.base_types.PluginLayout.html +2 -2
- package/docs/types/_saltcorn_types.base_types.PluginRoute.html +2 -2
- package/docs/types/_saltcorn_types.base_types.PluginSourceType.html +1 -1
- package/docs/types/_saltcorn_types.base_types.PluginType.html +2 -2
- package/docs/types/_saltcorn_types.base_types.PluginWrap.html +1 -1
- package/docs/types/_saltcorn_types.base_types.PluginWrapArg.html +2 -2
- package/docs/types/_saltcorn_types.base_types.RelationOption.html +2 -2
- package/docs/types/_saltcorn_types.base_types.Req.html +2 -2
- package/docs/types/_saltcorn_types.base_types.Res.html +2 -2
- package/docs/types/_saltcorn_types.base_types.ResultType.html +2 -2
- package/docs/types/_saltcorn_types.base_types.RouteAction.html +1 -1
- package/docs/types/_saltcorn_types.base_types.RunExtra.html +1 -1
- package/docs/types/_saltcorn_types.base_types.SlugStepType.html +2 -2
- package/docs/types/_saltcorn_types.base_types.StepResType.html +1 -1
- package/docs/types/_saltcorn_types.base_types.SubField.html +2 -2
- package/docs/types/_saltcorn_types.base_types.TableProvider.html +2 -2
- package/docs/types/_saltcorn_types.base_types.TableQuery.html +2 -2
- package/docs/types/_saltcorn_types.base_types.Tablely.html +1 -1
- package/docs/types/_saltcorn_types.base_types.ViewTemplate.html +2 -2
- package/docs/types/_saltcorn_types.common_types.ErrorMessage.html +2 -2
- package/docs/types/_saltcorn_types.common_types.GenObj.html +1 -1
- package/docs/types/_saltcorn_types.common_types.ReqRes.html +2 -2
- package/docs/types/_saltcorn_types.common_types.ResultMessage.html +1 -1
- package/docs/types/_saltcorn_types.common_types.SuccessMessage.html +2 -2
- package/docs/types/_saltcorn_types.common_types.Type.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_event_log.EventLogPack.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_field.FieldCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_field.InputType.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_form.AdditionalButton.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_library.LibraryCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_library.LibraryPack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_model.ModelCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_model.ModelPack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_model_instance.ModelInstanceCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_model_instance.ModelInstancePack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_page.PageCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_page.PagePack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_page_group.PageGroupCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_page_group.PageGroupPack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_page_group_member.PageGroupMemberCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_page_group_member.PageGroupMemberPack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_plugin.PluginCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_plugin.PluginPack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_role.RoleCfg.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_role.RolePack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_table.TableCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_table.TablePack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_tag.TagPack.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_tag_entry.TagEntryPack.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_trigger.TriggerCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_trigger.TriggerPack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_view.ViewCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_view.ViewPack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_workflow.ConfigWorkflowStep.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_workflow.RunResult.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_workflow_run.WorkflowRunCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_workflow_step.WorkflowStepCfg.html +2 -2
- package/docs/types/_saltcorn_types.model-abstracts_abstract_workflow_step.WorkflowStepPack.html +1 -1
- package/docs/types/_saltcorn_types.model-abstracts_abstract_workflow_trace.WorkflowTraceCfg.html +2 -2
- package/docs/variables/_saltcorn_admin-models..backup.create_backup.html +1 -1
- package/docs/variables/_saltcorn_admin-models..backup.create_csv_from_rows.html +1 -1
- package/docs/variables/_saltcorn_admin-models..backup.restore.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.add_to_menu.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.can_install_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.fetch_available_packs.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.fetch_pack_by_name.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.install_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.library_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.model_instance_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.model_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.page_group_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.page_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.plugin_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.role_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.table_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.trigger_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.uninstall_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..pack.view_pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models..tenant.copy_tenant_template.html +1 -1
- package/docs/variables/_saltcorn_admin-models..tenant.create_tenant.html +1 -1
- package/docs/variables/_saltcorn_admin-models..tenant.deleteTenant.html +1 -1
- package/docs/variables/_saltcorn_admin-models..tenant.domain_sanitize.html +1 -1
- package/docs/variables/_saltcorn_admin-models..tenant.eachTenant.html +1 -1
- package/docs/variables/_saltcorn_admin-models..tenant.getAllTenantRows.html +1 -1
- package/docs/variables/_saltcorn_admin-models..tenant.getAllTenants.html +1 -1
- package/docs/variables/_saltcorn_admin-models..tenant.insertTenant.html +1 -1
- package/docs/variables/_saltcorn_admin-models..tenant.switchToTenant.html +1 -1
- package/docs/variables/_saltcorn_admin-models.models_backup.backup.html +1 -1
- package/docs/variables/_saltcorn_admin-models.pack.pack.html +1 -1
- package/docs/variables/_saltcorn_admin-models.tenant.tenant.html +1 -1
- package/docs/variables/_saltcorn_common-code.tests_expected_relations.expectedFive.html +1 -1
- package/docs/variables/_saltcorn_common-code.tests_expected_relations.expectedFour.html +1 -1
- package/docs/variables/_saltcorn_common-code.tests_expected_relations.expectedOne.html +1 -1
- package/docs/variables/_saltcorn_common-code.tests_expected_relations.expectedSix.html +1 -1
- package/docs/variables/_saltcorn_common-code.tests_expected_relations.expectedThree.html +1 -1
- package/docs/variables/_saltcorn_common-code.tests_expected_relations.expectedTwo.html +1 -1
- package/docs/variables/_saltcorn_data..migrations.html +1 -1
- package/docs/variables/_saltcorn_data..plugin_helper.run_action_column.html +1 -1
- package/docs/variables/_saltcorn_data..utils.NotAuthorized.html +1 -1
- package/docs/variables/_saltcorn_data..utils.isPushEnabled.html +1 -1
- package/docs/variables/_saltcorn_data..utils.sleep.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_actions.actions.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.radio_select.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.radio_select.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.radio_select.type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.search_join_field.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.search_or_create.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.search_or_create.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.search_or_create.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.search_or_create.type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select.type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select_by_code.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select_by_view.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select_from_table.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select_from_table.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select_from_table.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select_from_table.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.select_from_table.type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fieldviews.two_level_select.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_fileview.fileview.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_index.index.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.attributes.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.TrueFalse.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.TrueFalse.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.checkboxes.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.checkboxes.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.edit.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.edit.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.edit.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.show.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.show.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.show_with_html.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.switch.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.tristate.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.tristate.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.fieldviews.tristate.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.js_type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.bool.sql_name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.attributes.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.fieldviews.edit.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.fieldviews.edit.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.fieldviews.edit.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.fieldviews.show.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.fieldviews.show.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.fieldviews.show_with_html.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.js_type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.color.sql_name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.attributes.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.edit.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.edit.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.edit.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.edit.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.editDay.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.editDay.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.editDay.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.editDay.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.format.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.format.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.format.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.relative.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.relative.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.show.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.show.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.showDay.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.showDay.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.show_with_html.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.yearsAgo.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.fieldviews.yearsAgo.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.js_type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.date.sql_name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.attributes.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.distance_operators.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.above_input.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.below_input.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.edit.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.edit.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.edit.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.edit.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.heat_cell.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.number_slider.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.progress_bar.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.range_interval.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.show.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.show.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.show_with_html.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.fieldviews.to_locale_string.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.js_type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.float.sql_name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.int.attributes.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.int.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.int.distance_operators.near.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.int.fieldviews.html +2 -2
- package/docs/variables/_saltcorn_data.base-plugin_types.int.js_type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.int.name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.int.primaryKey.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.int.sql_name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.as_header.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.as_header.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.as_link.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.as_link.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.as_link.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.as_text.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.as_text.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.checkbox_group.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.code.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.code_editor.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.edit.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.edit.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.edit.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.ellipsize.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.fill_formula_btn.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.img_from_url.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.img_from_url.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.make_unique.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.monospace_block.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.password.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.password.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.password.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.password.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.preFormatted.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.radio_group.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.radio_group.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.radio_group.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.select_by_code.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.show_with_html.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.textarea.blockDisplay.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.textarea.configFields.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.textarea.description.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.fieldviews.textarea.isEdit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.js_type.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_types.string.sql_name.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_viewtemplates_edit.edit.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_viewtemplates_feed.feed.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_viewtemplates_filter.filter.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_viewtemplates_list.list.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_viewtemplates_listshowlist.listshowlist.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_viewtemplates_room.room-1.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_viewtemplates_room.room.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_viewtemplates_show.show.html +1 -1
- package/docs/variables/_saltcorn_data.base-plugin_viewtemplates_viewable_fields.edit_build_in_actions.html +1 -1
- package/docs/variables/_saltcorn_data.contract.fieldlike.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_column.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_header.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_pack.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_plugin.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_plugin_layout.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_plugin_type.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_plugin_wrap.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_plugin_wrap_arg.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_table_query.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_tablely.html +1 -1
- package/docs/variables/_saltcorn_data.contract.is_viewtemplate.html +1 -1
- package/docs/variables/_saltcorn_data.db_connect.connect.html +1 -1
- package/docs/variables/_saltcorn_data.db_fa5-icons.fa5Icons.html +1 -1
- package/docs/variables/_saltcorn_data.db_fixtures.fixtures.html +1 -1
- package/docs/variables/_saltcorn_data.db_index.dbExports.html +1 -1
- package/docs/variables/_saltcorn_data.db_state.state.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202005141503.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202005241712.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202005251037.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202005282134.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202006022156.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202006051507.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202006240906.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202007091707.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202007202144.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202008031500.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202008051415.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202008121149.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202008121149.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202009112140.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202009112140.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202009181655.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202009221105.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202009231331.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202009301531.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202010231444.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202010251412.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202011021749.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202011051353.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202011111127.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202012011203.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202012100841.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202012281835.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202101061051.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202101141128.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202102091312.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202102101624.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202102172148.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202102261650.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202106102347.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202106112120.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202106120012.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202106120220.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202106121701.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202106121703.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202106121703.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202106251126.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202107281619.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202107302158.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202107302158.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202108022257.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202109201624.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202109301031.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202109301031.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202111290253.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202111290253.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202112282254.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202112282254.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202207022002.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202207252150.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202207252150.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202207261221.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202208101144.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202208101144.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202211040031.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202212112152.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202212112152.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202301130917.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202303201126.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202303201126.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202303221944.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202303221944.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202304281224.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202305031518.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202305031518.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202308211648.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202311011755.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202311011755.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202311231356.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202402071125.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202406260915.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202412051957.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202412051957.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202412111526.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202412111526.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202501081226.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202501081226.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202501201239.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202501262157.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202503071353.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202506050958.sql.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202510110312.sql_pg.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202510110312.sql_sqlite.html +1 -1
- package/docs/variables/_saltcorn_data.migrations_202511081024.sql.html +1 -1
- package/docs/variables/_saltcorn_data.mobile-mocks_saltcorn_html-pdf-node.htmlPdfNode.html +1 -1
- package/docs/variables/_saltcorn_data.models_config.configExports.html +1 -1
- package/docs/variables/_saltcorn_data.models_discovery.discovery.html +1 -1
- package/docs/variables/_saltcorn_data.models_email.email.html +1 -1
- package/docs/variables/_saltcorn_data.models_expression.expression.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.available_languages.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.check_email_mask.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.configTypes.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.deleteConfig.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.getAllConfig.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.getConfig.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.get_base_url.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.get_latest_npm_version.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.remove_from_menu.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.save_menu_items.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.config.setConfig.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.discovery.discover_tables.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.discovery.discoverable_tables.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.discovery.findType.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.discovery.get_existing_views.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.discovery.implement_discovery.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.email.getMailTransport.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.email.send_verification_email.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.email.viewToEmailHtml.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.expression.apply_calculated_fields.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.expression.apply_calculated_fields_stored.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.expression.eval_expression.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.expression.expressionValidator.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.expression.get_async_expression_function.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.expression.get_expression_function.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.expression.jsexprToWhere.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.expression.recalculate_for_stored.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.expression.transform_for_async.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.layout.eachView.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.layout.getStringsForI18n.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.layout.getViews.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.layout.translateLayout.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.layout.traverse.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.layout.traverseSync.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.random.all_views.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.random.fill_table_row.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.random.initial_view.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.random.random_table.html +1 -1
- package/docs/variables/_saltcorn_data.models_index.scheduler.runScheduler.html +1 -1
- package/docs/variables/_saltcorn_data.models_layout.layout.html +1 -1
- package/docs/variables/_saltcorn_data.models_random.random.html +1 -1
- package/docs/variables/_saltcorn_data.models_scheduler.scheduler.html +1 -1
- package/docs/variables/_saltcorn_data.plugin-helper.add_free_variables_to_joinfields.html +1 -1
- package/docs/variables/_saltcorn_data.tests_mocks.mocks.html +1 -1
- package/docs/variables/_saltcorn_data.tests_remote_query_helper.renderEditInEditConfig.html +1 -1
- package/docs/variables/_saltcorn_data.utils.utils.html +3 -3
- package/docs/variables/_saltcorn_data.web-mobile-commons.webMobileCommons.html +1 -1
- package/docs/variables/_saltcorn_db-common.internal.dbCommonModulePath.html +1 -1
- package/docs/variables/_saltcorn_db-common.multi-tenant.tenantNamespace.html +1 -1
- package/docs/variables/_saltcorn_db-common.tenants.tenants.html +1 -1
- package/docs/variables/_saltcorn_markup..export_.html +1 -1
- package/docs/variables/_saltcorn_markup.builder.builder.html +1 -1
- package/docs/variables/_saltcorn_markup.emergency_layout.EmergencyLayoutExports.html +1 -1
- package/docs/variables/_saltcorn_markup.form.form.html +1 -1
- package/docs/variables/_saltcorn_markup.helpers.HelpersExports.html +1 -1
- package/docs/variables/_saltcorn_markup.layout.LayoutExports-1.html +1 -1
- package/docs/variables/_saltcorn_markup.layout.LayoutExports.html +1 -1
- package/docs/variables/_saltcorn_markup.layout_utils.layoutUtils.html +1 -1
- package/docs/variables/_saltcorn_markup.mjml-layout.LayoutExports.html +1 -1
- package/docs/variables/_saltcorn_markup.mjml-tags.tagsExports.html +1 -1
- package/docs/variables/_saltcorn_markup.table.TableExports.html +1 -1
- package/docs/variables/_saltcorn_markup.tags.tagsExports.html +1 -1
- package/docs/variables/_saltcorn_types..generators.generateBool.html +1 -1
- package/docs/variables/_saltcorn_types..generators.generateString.html +1 -1
- package/docs/variables/_saltcorn_types..generators.num_between.html +1 -1
- package/docs/variables/_saltcorn_types..generators.oneOf.html +1 -1
- package/docs/variables/_saltcorn_types.generators.generators.html +1 -1
- package/help/Firebase Configurations.tmd +35 -0
- package/package.json +10 -10
- package/public/saltcorn.js +3 -1
- package/routes/admin.js +441 -241
- package/routes/api.js +15 -7
- package/routes/files.js +104 -36
- package/routes/notifications.js +87 -47
- package/routes/pageedit.js +1 -1
- package/routes/sync.js +79 -1
- package/s3storage.js +29 -45
- package/tests/api.test.js +0 -1
- package/tests/page_group.test.js +0 -1
- package/help/Firebase JSON key.tmd +0 -20
- package/help/Google Services File.tmd +0 -30
|
@@ -54,7 +54,7 @@ failures treated</p>
|
|
|
54
54
|
</ul>
|
|
55
55
|
<h2 id="deleting-rows" class="tsd-anchor-link">Deleting rows<a href="#deleting-rows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Use <a href="#deleterows" class="tsd-kind-method">Table.deleteRows</a> to delete any number (zero, one or many) of rows matching a criterion. It uses
|
|
56
56
|
the same <code>where</code> expression as the functions for querying rows</p>
|
|
57
|
-
</div></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html" class="tsd-signature-type tsd-kind-interface">AbstractTable</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
57
|
+
</div></div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html" class="tsd-signature-type tsd-kind-interface">AbstractTable</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L228">packages/saltcorn-data/models/table.ts:228</a></li><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4424">packages/saltcorn-data/models/table.ts:4424</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
58
58
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#constraints" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>constraints</span></a>
|
|
59
59
|
<a href="#description" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description?</span></a>
|
|
60
60
|
<a href="#external" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>external</span></a>
|
|
@@ -145,59 +145,59 @@ the same <code>where</code> expression as the functions for querying rows</p>
|
|
|
145
145
|
<a href="#findone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>One</span></a>
|
|
146
146
|
<a href="#state_refresh" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>state_<wbr/>refresh</span></a>
|
|
147
147
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructortable"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Table</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">o</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_types.model-abstracts_abstract_table.TableCfg.html" class="tsd-signature-type tsd-kind-type-alias">TableCfg</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Table</a><a href="#constructortable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Table constructor</p>
|
|
148
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">o</span>: <a href="../types/_saltcorn_types.model-abstracts_abstract_table.TableCfg.html" class="tsd-signature-type tsd-kind-type-alias">TableCfg</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Table</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
149
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
150
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
151
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
152
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#fields">fields</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
153
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
154
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
155
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
156
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#min_role_read">min_role_read</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
157
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#min_role_write">min_role_write</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
158
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
159
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#ownership_field_id">ownership_field_id</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
148
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">o</span>: <a href="../types/_saltcorn_types.model-abstracts_abstract_table.TableCfg.html" class="tsd-signature-type tsd-kind-type-alias">TableCfg</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Table</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L278">packages/saltcorn-data/models/table.ts:278</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constraints"><span>constraints</span><a href="#constraints" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">constraints</span><span class="tsd-signature-symbol">:</span> <a href="_saltcorn_data.models_table_constraints.TableConstraint.html" class="tsd-signature-type tsd-kind-class">TableConstraint</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>An array of <a href="_saltcorn_data.models_table_constraints.TableConstraint.html" class="tsd-kind-class">TableConstraint</a>s for this table</p>
|
|
149
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L264">packages/saltcorn-data/models/table.ts:264</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="description"><code class="tsd-tag">Optional</code><span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A description of the purpose of the table</p>
|
|
150
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L258">packages/saltcorn-data/models/table.ts:258</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="external"><span>external</span><a href="#external" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">external</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true this is an external table (not a database table)</p>
|
|
151
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L255">packages/saltcorn-data/models/table.ts:255</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="fields"><span>fields</span><a href="#fields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">:</span> <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>An array of <a href="_saltcorn_data.models_field.Field.html" class="tsd-kind-class">Field</a>s in this table</p>
|
|
152
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#fields">fields</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L261">packages/saltcorn-data/models/table.ts:261</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="has_sync_info"><span>has_<wbr/>sync_<wbr/>info</span><a href="#has_sync_info" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has_sync_info</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether sync info for mobile apps is enabled for this table</p>
|
|
153
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L252">packages/saltcorn-data/models/table.ts:252</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="id"><code class="tsd-tag">Optional</code><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The table ID</p>
|
|
154
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#id">id</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L233">packages/saltcorn-data/models/table.ts:233</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="is_user_group"><span>is_<wbr/>user_<wbr/>group</span><a href="#is_user_group" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is_user_group</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Is this a user group? If yes it will appear as options in the ownership dropdown</p>
|
|
155
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L267">packages/saltcorn-data/models/table.ts:267</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="min_role_read"><span>min_<wbr/>role_<wbr/>read</span><a href="#min_role_read" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">min_role_read</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Minimum role to read</p>
|
|
156
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#min_role_read">min_role_read</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L236">packages/saltcorn-data/models/table.ts:236</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="min_role_write"><span>min_<wbr/>role_<wbr/>write</span><a href="#min_role_write" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">min_role_write</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Minimum role to write</p>
|
|
157
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#min_role_write">min_role_write</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L239">packages/saltcorn-data/models/table.ts:239</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The table name</p>
|
|
158
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L230">packages/saltcorn-data/models/table.ts:230</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="ownership_field_id"><code class="tsd-tag">Optional</code><span>ownership_<wbr/>field_<wbr/>id</span><a href="#ownership_field_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ownership_field_id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-comment tsd-typography"><p>The ID of the ownership field</p>
|
|
159
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#ownership_field_id">ownership_field_id</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L242">packages/saltcorn-data/models/table.ts:242</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="ownership_formula"><code class="tsd-tag">Optional</code><span>ownership_<wbr/>formula</span><a href="#ownership_formula" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ownership_formula</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A formula to denote ownership. This is a JavaScript expression which
|
|
160
160
|
must evaluate to true if the user is the owner</p>
|
|
161
|
-
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#ownership_formula">ownership_formula</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
162
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
163
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
164
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
165
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
166
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
167
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#sql_name">sql_name</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/2356b2705ef931f8dc1387363443314a966e9463/packages/saltcorn-data/models/table.ts#L865">packages/saltcorn-data/models/table.ts:865</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="to_json"><span>to_<wbr/>json</span><a href="#to_json" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="to_jsonto_json"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">to_json</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">external</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">min_role_read</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">min_role_write</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownership_field_id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownership_formula</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">provider_cfg</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">provider_name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">versioned</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">external</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">min_role_read</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">min_role_write</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownership_field_id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownership_formula</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">provider_cfg</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">provider_name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">versioned</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/2356b2705ef931f8dc1387363443314a966e9463/packages/saltcorn-data/models/table.ts#L297">packages/saltcorn-data/models/table.ts:297</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="aggregationquery"><span>aggregation<wbr/>Query</span><a href="#aggregationquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="aggregationquery-1"><span class="tsd-kind-call-signature">aggregationQuery</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">aggregations</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">aggregate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">valueFormula</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">groupBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">></span><a href="#aggregationquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns aggregations for this table, possibly on a subset by where-expression</p>
|
|
168
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">aggregations</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">aggregate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">valueFormula</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">groupBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
161
|
+
</div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#ownership_formula">ownership_formula</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L246">packages/saltcorn-data/models/table.ts:246</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="provider_cfg"><code class="tsd-tag">Optional</code><span>provider_<wbr/>cfg</span><a href="#provider_cfg" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">provider_cfg</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></div><div class="tsd-comment tsd-typography"><p>Configuration for the table provider for this table</p>
|
|
162
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L273">packages/saltcorn-data/models/table.ts:273</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="provider_name"><code class="tsd-tag">Optional</code><span>provider_<wbr/>name</span><a href="#provider_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">provider_name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Name of the table provider for this table (not a database table)</p>
|
|
163
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L270">packages/saltcorn-data/models/table.ts:270</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="versioned"><span>versioned</span><a href="#versioned" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">versioned</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Version history enabled for this table</p>
|
|
164
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L249">packages/saltcorn-data/models/table.ts:249</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Accessors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="composite_pk_names"><span>composite_<wbr/>pk_<wbr/>names</span><a href="#composite_pk_names" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="composite_pk_namescomposite_pk_names"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">composite_pk_names</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1918">packages/saltcorn-data/models/table.ts:1918</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pk_name"><span>pk_<wbr/>name</span><a href="#pk_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="pk_namepk_name"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">pk_name</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get primary key field name</p>
|
|
165
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1928">packages/saltcorn-data/models/table.ts:1928</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pk_type"><span>pk_<wbr/>type</span><a href="#pk_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="pk_typepk_type"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">pk_type</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_types.common_types.Type.html" class="tsd-signature-type tsd-kind-type-alias">Type</a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="../types/_saltcorn_types.common_types.Type.html" class="tsd-signature-type tsd-kind-type-alias">Type</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1936">packages/saltcorn-data/models/table.ts:1936</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="santized_name"><span>santized_<wbr/>name</span><a href="#santized_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="santized_namesantized_name"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">santized_name</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get sanitized name of table</p>
|
|
166
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L670">packages/saltcorn-data/models/table.ts:670</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sql_name"><span>sql_<wbr/>name</span><a href="#sql_name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="sql_namesql_name"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">sql_name</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get Table SQL Name</p>
|
|
167
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#sql_name">sql_name</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L865">packages/saltcorn-data/models/table.ts:865</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="to_json"><span>to_<wbr/>json</span><a href="#to_json" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li><div class="tsd-signature" id="to_jsonto_json"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">to_json</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">external</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">min_role_read</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">min_role_write</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownership_field_id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownership_formula</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">provider_cfg</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">provider_name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">versioned</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">external</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">min_role_read</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">min_role_write</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownership_field_id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">ownership_formula</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">provider_cfg</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">provider_name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">versioned</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L297">packages/saltcorn-data/models/table.ts:297</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="aggregationquery"><span>aggregation<wbr/>Query</span><a href="#aggregationquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="aggregationquery-1"><span class="tsd-kind-call-signature">aggregationQuery</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">aggregations</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">aggregate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">valueFormula</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">groupBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">></span><a href="#aggregationquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns aggregations for this table, possibly on a subset by where-expression</p>
|
|
168
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">aggregations</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">aggregate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">valueFormula</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">groupBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3839">packages/saltcorn-data/models/table.ts:3839</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="check_table_constraints"><span>check_<wbr/>table_<wbr/>constraints</span><a href="#check_table_constraints" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="check_table_constraints-1"><span class="tsd-kind-call-signature">check_table_constraints</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row0</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#check_table_constraints-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check table constraints against a row object. Will return a string With an error message if the
|
|
169
169
|
table constraints are violated, <code>undefined</code> if the row does not violate any constraints</p>
|
|
170
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row0</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
170
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row0</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1956">packages/saltcorn-data/models/table.ts:1956</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="compress_history"><span>compress_<wbr/>history</span><a href="#compress_history" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="compress_history-1"><span class="tsd-kind-call-signature">compress_history</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">delete_unchanged</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">interval_secs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#compress_history-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Compress history by minimal interval and/or deleting unchanged rows. Can be called
|
|
171
171
|
with options object, or just minimal interval for legacy code</p>
|
|
172
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">delete_unchanged</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">interval_secs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
172
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">delete_unchanged</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">interval_secs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2749">packages/saltcorn-data/models/table.ts:2749</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="countrows"><span>count<wbr/>Rows</span><a href="#countrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="countrows-1"><span class="tsd-kind-call-signature">countRows</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><a href="#countrows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Count the number of rows in db table. The argument is a where-expression with conditions the
|
|
173
173
|
counted rows should match. countRows returns the number of matching rows wrapped in a promise.</p>
|
|
174
174
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">where</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">bookTable</span><span class="hl-1"> = </span><span class="hl-0">Table</span><span class="hl-1">.</span><span class="hl-2">findOne</span><span class="hl-1">({</span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">"books"</span><span class="hl-1">})</span><br/><br/><span class="hl-4">// Count the total number of rows in the books table</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">totalNumberOfBooks</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">countRows</span><span class="hl-1">({})</span><br/><br/><span class="hl-4">// Count the number of books where the cover_color field has the value is "Red"</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">numberOfRedBooks</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">countRows</span><span class="hl-1">({</span><span class="hl-0">cover_color:</span><span class="hl-1"> </span><span class="hl-3">"Red"</span><span class="hl-1">})</span><br/><br/><span class="hl-4">// Count number of books with more than 500 pages</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">numberOfLongBooks</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">countRows</span><span class="hl-1">({</span><span class="hl-0">pages:</span><span class="hl-1"> {</span><span class="hl-0">gt:</span><span class="hl-1"> </span><span class="hl-5">500</span><span class="hl-1">}})</span>
|
|
175
175
|
</code><button>Copy</button></pre>
|
|
176
176
|
|
|
177
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
177
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1324">packages/saltcorn-data/models/table.ts:1324</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="delete"><span>delete</span><a href="#delete" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="delete-1"><span class="tsd-kind-call-signature">delete</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">only_forget</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#delete-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Drop current table</p>
|
|
178
178
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">only_forget</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>boolean - if true that only</p>
|
|
179
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
179
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L834">packages/saltcorn-data/models/table.ts:834</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="delete_url"><span>delete_<wbr/>url</span><a href="#delete_url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="delete_url-1"><span class="tsd-kind-call-signature">delete_url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">moreQuery</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#delete_url-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">row</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">moreQuery</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1910">packages/saltcorn-data/models/table.ts:1910</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleterows"><span>delete<wbr/>Rows</span><a href="#deleterows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deleterows-1"><span class="tsd-kind-call-signature">deleteRows</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">where</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noTrigger</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resultCollector</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleterows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete rows from table. The first argument is a where expression indicating the conditions for the rows to be deleted</p>
|
|
180
180
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">where</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></span><div class="tsd-comment tsd-typography"><p>condition</p>
|
|
181
181
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span><div class="tsd-comment tsd-typography"><p>optional user, if null then no authorization will be checked</p>
|
|
182
182
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noTrigger</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">resultCollector</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-4">// delete all books where author = "Friedrich Nietzsche"</span><br/><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">Table</span><span class="hl-1">.</span><span class="hl-2">findOne</span><span class="hl-1">({</span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">"books"</span><span class="hl-1">}).</span><span class="hl-2">deleteRows</span><span class="hl-1">({</span><span class="hl-0">author:</span><span class="hl-1"> </span><span class="hl-3">"Friedrich Nietzsche"</span><span class="hl-1">})</span>
|
|
183
183
|
</code><button>Copy</button></pre>
|
|
184
184
|
|
|
185
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
185
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L993">packages/saltcorn-data/models/table.ts:993</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="distinctvalues"><span>distinct<wbr/>Values</span><a href="#distinctvalues" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="distinctvalues-1"><span class="tsd-kind-call-signature">distinctValues</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldnm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">whereObj</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#distinctvalues-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return distinct Values for column in table
|
|
186
186
|
????</p>
|
|
187
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fieldnm</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">whereObj</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
188
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
189
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_join_aggregations</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_data.models_table.ChildRelations.html" class="tsd-signature-type tsd-kind-type-alias">ChildRelations</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
190
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
191
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_double</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_triple</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.base_types.JoinFieldOption.html" class="tsd-signature-type tsd-kind-type-alias">JoinFieldOption</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
187
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fieldnm</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">whereObj</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1338">packages/saltcorn-data/models/table.ts:1338</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dump_history_to_json"><span>dump_<wbr/>history_<wbr/>to_<wbr/>json</span><a href="#dump_history_to_json" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="dump_history_to_json-1"><span class="tsd-kind-call-signature">dump_history_to_json</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#dump_history_to_json-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3084">packages/saltcorn-data/models/table.ts:3084</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="dump_to_json"><span>dump_<wbr/>to_<wbr/>json</span><a href="#dump_to_json" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="dump_to_json-1"><span class="tsd-kind-call-signature">dump_to_json</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#dump_to_json-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3076">packages/saltcorn-data/models/table.ts:3076</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enable_fkey_constraints"><span>enable_<wbr/>fkey_<wbr/>constraints</span><a href="#enable_fkey_constraints" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="enable_fkey_constraints-1"><span class="tsd-kind-call-signature">enable_fkey_constraints</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#enable_fkey_constraints-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Enable constraints</p>
|
|
188
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2902">packages/saltcorn-data/models/table.ts:2902</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="field_options"><span>field_<wbr/>options</span><a href="#field_options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="field_options-1"><span class="tsd-kind-call-signature">field_options</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">nrecurse</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">fieldWhere</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">f</span><span class="tsd-signature-symbol">:</span> <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">prefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#field_options-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">nrecurse</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li><li><span><span class="tsd-kind-parameter">fieldWhere</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">f</span><span class="tsd-signature-symbol">:</span> <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = ...</span></span></li><li><span><span class="tsd-kind-parameter">prefix</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3767">packages/saltcorn-data/models/table.ts:3767</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get_child_relations"><span>get_<wbr/>child_<wbr/>relations</span><a href="#get_child_relations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get_child_relations-1"><span class="tsd-kind-call-signature">get_child_relations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">allow_join_aggregations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_data.models_table.ChildRelations.html" class="tsd-signature-type tsd-kind-type-alias">ChildRelations</a><span class="tsd-signature-symbol">></span><a href="#get_child_relations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get child relations for table</p>
|
|
189
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_join_aggregations</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_data.models_table.ChildRelations.html" class="tsd-signature-type tsd-kind-type-alias">ChildRelations</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3797">packages/saltcorn-data/models/table.ts:3797</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get_history"><span>get_<wbr/>history</span><a href="#get_history" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get_history-1"><span class="tsd-kind-call-signature">get_history</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#get_history-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get table history data</p>
|
|
190
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2890">packages/saltcorn-data/models/table.ts:2890</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get_join_field_options"><span>get_<wbr/>join_<wbr/>field_<wbr/>options</span><a href="#get_join_field_options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get_join_field_options-1"><span class="tsd-kind-call-signature">get_join_field_options</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">allow_double</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">allow_triple</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.base_types.JoinFieldOption.html" class="tsd-signature-type tsd-kind-type-alias">JoinFieldOption</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#get_join_field_options-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get join-field-options joined from a field in this table</p>
|
|
191
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_double</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_triple</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.base_types.JoinFieldOption.html" class="tsd-signature-type tsd-kind-type-alias">JoinFieldOption</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3570">packages/saltcorn-data/models/table.ts:3570</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get_models"><span>get_<wbr/>models</span><a href="#get_models" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get_models-1"><span class="tsd-kind-call-signature">get_models</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">where</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#get_models-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get Models
|
|
192
192
|
tbd why this function in this file - needs to models</p>
|
|
193
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">where</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
194
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_double</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_triple</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_data.models_table.ParentRelations.html" class="tsd-signature-type tsd-kind-type-alias">ParentRelations</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
195
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">unique</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_data.models_table.RelationData.html" class="tsd-signature-type tsd-kind-type-alias">RelationData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
196
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.base_types.RelationOption.html" class="tsd-signature-type tsd-kind-type-alias">RelationOption</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
197
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
198
|
-
</div><h4 class="tsd-returns-title">Returns <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
193
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">where</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L482">packages/saltcorn-data/models/table.ts:482</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get_parent_relations"><span>get_<wbr/>parent_<wbr/>relations</span><a href="#get_parent_relations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get_parent_relations-1"><span class="tsd-kind-call-signature">get_parent_relations</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">allow_double</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">allow_triple</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_data.models_table.ParentRelations.html" class="tsd-signature-type tsd-kind-type-alias">ParentRelations</a><span class="tsd-signature-symbol">></span><a href="#get_parent_relations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get parent relations for table</p>
|
|
194
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_double</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">allow_triple</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_data.models_table.ParentRelations.html" class="tsd-signature-type tsd-kind-type-alias">ParentRelations</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3687">packages/saltcorn-data/models/table.ts:3687</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get_relation_data"><span>get_<wbr/>relation_<wbr/>data</span><a href="#get_relation_data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get_relation_data-1"><span class="tsd-kind-call-signature">get_relation_data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">unique</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_data.models_table.RelationData.html" class="tsd-signature-type tsd-kind-type-alias">RelationData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#get_relation_data-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get relation-data joined from a field of another table</p>
|
|
195
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">unique</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_data.models_table.RelationData.html" class="tsd-signature-type tsd-kind-type-alias">RelationData</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3665">packages/saltcorn-data/models/table.ts:3665</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="get_relation_options"><span>get_<wbr/>relation_<wbr/>options</span><a href="#get_relation_options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="get_relation_options-1"><span class="tsd-kind-call-signature">get_relation_options</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.base_types.RelationOption.html" class="tsd-signature-type tsd-kind-type-alias">RelationOption</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#get_relation_options-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get relation-options joined from a field of another table</p>
|
|
196
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.base_types.RelationOption.html" class="tsd-signature-type tsd-kind-type-alias">RelationOption</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3646">packages/saltcorn-data/models/table.ts:3646</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getfield"><span>get<wbr/>Field</span><a href="#getfield" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getfield-1"><span class="tsd-kind-call-signature">getField</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#getfield-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a field, possibly by relation</p>
|
|
197
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2511">packages/saltcorn-data/models/table.ts:2511</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getfields"><span>get<wbr/>Fields</span><a href="#getfields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getfields-1"><span class="tsd-kind-call-signature">getFields</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">[]</span><a href="#getfields-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get Fields list for table</p>
|
|
198
|
+
</div><h4 class="tsd-returns-title">Returns <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2495">packages/saltcorn-data/models/table.ts:2495</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getforeignkeys"><span>get<wbr/>Foreign<wbr/>Keys</span><a href="#getforeignkeys" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getforeignkeys-1"><span class="tsd-kind-call-signature">getForeignKeys</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">[]</span><a href="#getforeignkeys-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get foreign keys, without the 'File' type</p>
|
|
199
199
|
</div><h4 class="tsd-returns-title">Returns <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">[]</span></h4><p>array of FK Fields</p>
|
|
200
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/2356b2705ef931f8dc1387363443314a966e9463/packages/saltcorn-data/models/table.ts#L2497">packages/saltcorn-data/models/table.ts:2497</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getforeigntables"><span>get<wbr/>Foreign<wbr/>Tables</span><a href="#getforeigntables" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getforeigntables-1"><span class="tsd-kind-call-signature">getForeignTables</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html" class="tsd-signature-type tsd-kind-interface">AbstractTable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getforeigntables-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html" class="tsd-signature-type tsd-kind-interface">AbstractTable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#getforeigntables">getForeignTables</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/2356b2705ef931f8dc1387363443314a966e9463/packages/saltcorn-data/models/table.ts#L4284">packages/saltcorn-data/models/table.ts:4284</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getformulaexamples"><span>get<wbr/>Formula<wbr/>Examples</span><a href="#getformulaexamples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getformulaexamples-1"><span class="tsd-kind-call-signature">getFormulaExamples</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">typename</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getformulaexamples-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">typename</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/2356b2705ef931f8dc1387363443314a966e9463/packages/saltcorn-data/models/table.ts#L4297">packages/saltcorn-data/models/table.ts:4297</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getjoinedquery"><span>get<wbr/>Joined<wbr/>Query</span><a href="#getjoinedquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getjoinedquery-1"><span class="tsd-kind-call-signature">getJoinedQuery</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">aggregations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="../types/_saltcorn_db-common.dbtypes.AggregationOptions.html" class="tsd-signature-type tsd-kind-type-alias">AggregationOptions</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">joinFields</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.JoinFields.html" class="tsd-signature-type tsd-kind-type-alias">JoinFields</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">starFields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">ignoreExternal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.JoinOptions.html" class="tsd-signature-type tsd-kind-type-alias">JoinOptions</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">notAuthorized</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sql</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">values</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Value.html" class="tsd-signature-type tsd-kind-type-alias">Value</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><a href="#getjoinedquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">aggregations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="../types/_saltcorn_db-common.dbtypes.AggregationOptions.html" class="tsd-signature-type tsd-kind-type-alias">AggregationOptions</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">joinFields</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.JoinFields.html" class="tsd-signature-type tsd-kind-type-alias">JoinFields</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">starFields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">ignoreExternal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.JoinOptions.html" class="tsd-signature-type tsd-kind-type-alias">JoinOptions</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">notAuthorized</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sql</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">values</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Value.html" class="tsd-signature-type tsd-kind-type-alias">Value</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/2356b2705ef931f8dc1387363443314a966e9463/packages/saltcorn-data/models/table.ts#L3905">packages/saltcorn-data/models/table.ts:3905</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getjoinedrow"><span>get<wbr/>Joined<wbr/>Row</span><a href="#getjoinedrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getjoinedrow-1"><span class="tsd-kind-call-signature">getJoinedRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><a href="#getjoinedrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/2356b2705ef931f8dc1387363443314a966e9463/packages/saltcorn-data/models/table.ts#L4122">packages/saltcorn-data/models/table.ts:4122</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getjoinedrows"><span>get<wbr/>Joined<wbr/>Rows</span><a href="#getjoinedrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getjoinedrows-1"><span class="tsd-kind-call-signature">getJoinedRows</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">aggregations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="../types/_saltcorn_db-common.dbtypes.AggregationOptions.html" class="tsd-signature-type tsd-kind-type-alias">AggregationOptions</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">joinFields</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.JoinFields.html" class="tsd-signature-type tsd-kind-type-alias">JoinFields</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">starFields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">ignoreExternal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getjoinedrows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get rows along with joined and aggregated fields. The argument to <code>getJoinedRows</code> is an object
|
|
200
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2503">packages/saltcorn-data/models/table.ts:2503</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getforeigntables"><span>get<wbr/>Foreign<wbr/>Tables</span><a href="#getforeigntables" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getforeigntables-1"><span class="tsd-kind-call-signature">getForeignTables</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html" class="tsd-signature-type tsd-kind-interface">AbstractTable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getforeigntables-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html" class="tsd-signature-type tsd-kind-interface">AbstractTable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#getforeigntables">getForeignTables</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4290">packages/saltcorn-data/models/table.ts:4290</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getformulaexamples"><span>get<wbr/>Formula<wbr/>Examples</span><a href="#getformulaexamples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getformulaexamples-1"><span class="tsd-kind-call-signature">getFormulaExamples</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">typename</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#getformulaexamples-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">typename</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4303">packages/saltcorn-data/models/table.ts:4303</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getjoinedquery"><span>get<wbr/>Joined<wbr/>Query</span><a href="#getjoinedquery" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getjoinedquery-1"><span class="tsd-kind-call-signature">getJoinedQuery</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">aggregations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="../types/_saltcorn_db-common.dbtypes.AggregationOptions.html" class="tsd-signature-type tsd-kind-type-alias">AggregationOptions</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">joinFields</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.JoinFields.html" class="tsd-signature-type tsd-kind-type-alias">JoinFields</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">starFields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">ignoreExternal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.JoinOptions.html" class="tsd-signature-type tsd-kind-type-alias">JoinOptions</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">notAuthorized</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sql</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">values</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Value.html" class="tsd-signature-type tsd-kind-type-alias">Value</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><a href="#getjoinedquery-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">aggregations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="../types/_saltcorn_db-common.dbtypes.AggregationOptions.html" class="tsd-signature-type tsd-kind-type-alias">AggregationOptions</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">joinFields</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.JoinFields.html" class="tsd-signature-type tsd-kind-type-alias">JoinFields</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">starFields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">ignoreExternal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.JoinOptions.html" class="tsd-signature-type tsd-kind-type-alias">JoinOptions</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">notAuthorized</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sql</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">values</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Value.html" class="tsd-signature-type tsd-kind-type-alias">Value</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3911">packages/saltcorn-data/models/table.ts:3911</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getjoinedrow"><span>get<wbr/>Joined<wbr/>Row</span><a href="#getjoinedrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getjoinedrow-1"><span class="tsd-kind-call-signature">getJoinedRow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><a href="#getjoinedrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4128">packages/saltcorn-data/models/table.ts:4128</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getjoinedrows"><span>get<wbr/>Joined<wbr/>Rows</span><a href="#getjoinedrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getjoinedrows-1"><span class="tsd-kind-call-signature">getJoinedRows</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">opts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">aggregations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="../types/_saltcorn_db-common.dbtypes.AggregationOptions.html" class="tsd-signature-type tsd-kind-type-alias">AggregationOptions</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">joinFields</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.JoinFields.html" class="tsd-signature-type tsd-kind-type-alias">JoinFields</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">starFields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">ignoreExternal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getjoinedrows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get rows along with joined and aggregated fields. The argument to <code>getJoinedRows</code> is an object
|
|
201
201
|
with several different possible fields, all of which are optional</p>
|
|
202
202
|
<ul>
|
|
203
203
|
<li><code>where</code>: A Where expression indicating the criterion to match</li>
|
|
@@ -211,7 +211,7 @@ with several different possible fields, all of which are optional</p>
|
|
|
211
211
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">opts</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">aggregations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <a href="../types/_saltcorn_db-common.dbtypes.AggregationOptions.html" class="tsd-signature-type tsd-kind-type-alias">AggregationOptions</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">joinFields</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.JoinFields.html" class="tsd-signature-type tsd-kind-type-alias">JoinFields</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">starFields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">ignoreExternal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">patients</span><span class="hl-1"> = </span><span class="hl-0">Table</span><span class="hl-1">.</span><span class="hl-2">findOne</span><span class="hl-1">({ </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">"patients"</span><span class="hl-1"> });</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">patients_rows</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">patients</span><span class="hl-1">.</span><span class="hl-2">getJoinedRows</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-0">where:</span><span class="hl-1"> { </span><span class="hl-0">age:</span><span class="hl-1"> { </span><span class="hl-0">gt:</span><span class="hl-1"> </span><span class="hl-5">65</span><span class="hl-1"> } },</span><br/><span class="hl-1"> </span><span class="hl-0">orderBy:</span><span class="hl-1"> </span><span class="hl-3">"id"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">aggregations:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">avg_temp:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">table:</span><span class="hl-1"> </span><span class="hl-3">"readings"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">ref:</span><span class="hl-1"> </span><span class="hl-3">"patient_id"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">field:</span><span class="hl-1"> </span><span class="hl-3">"temperature"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">aggregate:</span><span class="hl-1"> </span><span class="hl-3">"avg"</span><span class="hl-1">,</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">joinFields:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">pages:</span><span class="hl-1"> { </span><span class="hl-0">ref:</span><span class="hl-1"> </span><span class="hl-3">"favbook"</span><span class="hl-1">, </span><span class="hl-0">target:</span><span class="hl-1"> </span><span class="hl-3">"pages"</span><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-0">author:</span><span class="hl-1"> { </span><span class="hl-0">ref:</span><span class="hl-1"> </span><span class="hl-3">"favbook"</span><span class="hl-1">, </span><span class="hl-0">target:</span><span class="hl-1"> </span><span class="hl-3">"author"</span><span class="hl-1"> },</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
|
|
212
212
|
</code><button>Copy</button></pre>
|
|
213
213
|
|
|
214
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
214
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4171">packages/saltcorn-data/models/table.ts:4171</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrow"><span>get<wbr/>Row</span><a href="#getrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getrow-1"><span class="tsd-kind-call-signature">getRow</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">selopts</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><a href="#getrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get one row from the table in the database. The matching row will be returned in a promise - use await to read the value.
|
|
215
215
|
If no matching rule can be found, null will be returned. If more than one row matches, the first found row
|
|
216
216
|
will be returned.</p>
|
|
217
217
|
<p>The first argument to get row is a where-expression With the conditions the returned row should match.</p>
|
|
@@ -225,7 +225,7 @@ Where expression that uniquely determines the row to return, if it exisits.</p>
|
|
|
225
225
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">where</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><span class="tsd-kind-parameter">selopts</span>: <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">bookTable</span><span class="hl-1"> = </span><span class="hl-0">Table</span><span class="hl-1">.</span><span class="hl-2">findOne</span><span class="hl-1">({</span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">"books"</span><span class="hl-1">})</span><br/><br/><br/><span class="hl-4">// get the row in the book table with id = 5</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myBook</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">getRow</span><span class="hl-1">({</span><span class="hl-0">id:</span><span class="hl-1"> </span><span class="hl-5">5</span><span class="hl-1">})</span><br/><br/><span class="hl-4">// get the row for the last book published by Leo Tolstoy</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myBook</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">getRow</span><span class="hl-1">({</span><span class="hl-0">author:</span><span class="hl-1"> </span><span class="hl-3">"Leo Tolstoy"</span><span class="hl-1">}, {</span><span class="hl-0">orderBy:</span><span class="hl-1"> </span><span class="hl-3">"published"</span><span class="hl-1">, </span><span class="hl-0">orderDesc:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">})</span>
|
|
226
226
|
</code><button>Copy</button></pre>
|
|
227
227
|
|
|
228
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
228
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1190">packages/saltcorn-data/models/table.ts:1190</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrows"><span>get<wbr/>Rows</span><a href="#getrows" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getrows-1"><span class="tsd-kind-call-signature">getRows</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">selopts</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getrows-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get all matching rows from the table in the database.</p>
|
|
229
229
|
<p>The arguments are the same as for getRow. The first argument is where-expression with the conditions to match,
|
|
230
230
|
and the second argument is an optional object and allows you to set ordering and limit options. Keywords that
|
|
231
231
|
can be used in the second argument are orderBy, orderDesc, limit and offset.</p>
|
|
@@ -234,9 +234,9 @@ can be used in the second argument are orderBy, orderDesc, limit and offset.</p>
|
|
|
234
234
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">where</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><span class="tsd-kind-parameter">selopts</span>: <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">bookTable</span><span class="hl-1"> = </span><span class="hl-0">Table</span><span class="hl-1">.</span><span class="hl-2">findOne</span><span class="hl-1">({</span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">"books"</span><span class="hl-1">})</span><br/><br/><span class="hl-4">// get the rows in the book table with author = "Henrik Pontoppidan"</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myBooks</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">getRows</span><span class="hl-1">({</span><span class="hl-0">author:</span><span class="hl-1"> </span><span class="hl-3">"Henrik Pontoppidan"</span><span class="hl-1">})</span><br/><br/><span class="hl-4">// get the 3 most recent books written by "Henrik Pontoppidan" with more than 500 pages</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">myBooks</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">getRows</span><span class="hl-1">({</span><span class="hl-0">author:</span><span class="hl-1"> </span><span class="hl-3">"Henrik Pontoppidan"</span><span class="hl-1">, </span><span class="hl-0">pages:</span><span class="hl-1"> {</span><span class="hl-0">gt:</span><span class="hl-1"> </span><span class="hl-5">500</span><span class="hl-1">}}, {</span><span class="hl-0">orderBy:</span><span class="hl-1"> </span><span class="hl-3">"published"</span><span class="hl-1">, </span><span class="hl-0">orderDesc:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">})</span>
|
|
235
235
|
</code><button>Copy</button></pre>
|
|
236
236
|
|
|
237
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
238
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">delimiter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">extra_row_values</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">method</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"
|
|
239
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">skip_first_data_row</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
237
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1249">packages/saltcorn-data/models/table.ts:1249</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gettags"><span>get<wbr/>Tags</span><a href="#gettags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gettags-1"><span class="tsd-kind-call-signature">getTags</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_saltcorn_types.model-abstracts_abstract_tag.AbstractTag.html" class="tsd-signature-type tsd-kind-interface">AbstractTag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#gettags-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_saltcorn_types.model-abstracts_abstract_tag.AbstractTag.html" class="tsd-signature-type tsd-kind-interface">AbstractTag</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html">AbstractTable</a>.<a href="../interfaces/_saltcorn_types.model-abstracts_abstract_table.AbstractTable.html#gettags">getTags</a></p><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4282">packages/saltcorn-data/models/table.ts:4282</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="import_csv_file"><span>import_<wbr/>csv_<wbr/>file</span><a href="#import_csv_file" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="import_csv_file-1"><span class="tsd-kind-call-signature">import_csv_file</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">delimiter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">extra_row_values</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">method</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"copy"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"Auto"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row-by-row"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">no_table_write</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">no_transaction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">overwrite_csv_fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">recalc_stored</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">skip_first_data_row</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span><a href="#import_csv_file-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import CSV file to existing table</p>
|
|
238
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">delimiter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">extra_row_values</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">method</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"copy"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"Auto"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"row-by-row"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">no_table_write</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">no_transaction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">overwrite_csv_fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">recalc_stored</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">skip_first_data_row</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3102">packages/saltcorn-data/models/table.ts:3102</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="import_json_file"><span>import_<wbr/>json_<wbr/>file</span><a href="#import_json_file" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="import_json_file-1"><span class="tsd-kind-call-signature">import_json_file</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">skip_first_data_row</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span><a href="#import_json_file-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import JSON table description</p>
|
|
239
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">skip_first_data_row</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3507">packages/saltcorn-data/models/table.ts:3507</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="import_json_history_file"><span>import_<wbr/>json_<wbr/>history_<wbr/>file</span><a href="#import_json_history_file" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="import_json_history_file-1"><span class="tsd-kind-call-signature">import_json_history_file</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#import_json_history_file-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3495">packages/saltcorn-data/models/table.ts:3495</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="insert_history_row"><span>insert_<wbr/>history_<wbr/>row</span><a href="#insert_history_row" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="insert_history_row-1"><span class="tsd-kind-call-signature">insert_history_row</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">v0</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">retry</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#insert_history_row-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">v0</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li><li><span><span class="tsd-kind-parameter">retry</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1748">packages/saltcorn-data/models/table.ts:1748</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="insertrow"><span>insert<wbr/>Row</span><a href="#insertrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="insertrow-1"><span class="tsd-kind-call-signature">insertRow</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">v_in0</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resultCollector</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noTrigger</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">syncTimestamp</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#insertrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Insert row into the table. By passing in the user as
|
|
240
240
|
the second argument, it will check write rights. If a user object is not
|
|
241
241
|
supplied, the insert goes ahead without checking write permissions.</p>
|
|
242
242
|
<p>Returns the primary key value of the inserted row.</p>
|
|
@@ -246,26 +246,26 @@ with a function that can return an error message, use <a href="#tryinsertrow" cl
|
|
|
246
246
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">v_in0</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">resultCollector</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noTrigger</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">syncTimestamp</span>: <span class="tsd-signature-type">Date</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-7">Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">Table</span><span class="hl-1">.</span><span class="hl-2">findOne</span><span class="hl-1">(</span><span class="hl-3">"People"</span><span class="hl-1">).</span><span class="hl-2">insertRow</span><span class="hl-1">({ </span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">"Jim"</span><span class="hl-1">, </span><span class="hl-0">age:</span><span class="hl-1"> </span><span class="hl-5">35</span><span class="hl-1"> })</span>
|
|
247
247
|
</code><button>Copy</button></pre>
|
|
248
248
|
|
|
249
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
249
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2028">packages/saltcorn-data/models/table.ts:2028</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="is_owner"><span>is_<wbr/>owner</span><a href="#is_owner" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="is_owner-1"><span class="tsd-kind-call-signature">is_owner</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">row</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#is_owner-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Check if user is owner of row</p>
|
|
250
250
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></span><div class="tsd-comment tsd-typography"><p>user</p>
|
|
251
251
|
</div></li><li><span><span class="tsd-kind-parameter">row</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span><div class="tsd-comment tsd-typography"><p>table row</p>
|
|
252
|
-
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
253
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
252
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L516">packages/saltcorn-data/models/table.ts:516</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="latestsyncinfo"><span>latest<wbr/>Sync<wbr/>Info</span><a href="#latestsyncinfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="latestsyncinfo-1"><span class="tsd-kind-call-signature">latestSyncInfo</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><a href="#latestsyncinfo-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1770">packages/saltcorn-data/models/table.ts:1770</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="latestsyncinfos"><span>latest<wbr/>Sync<wbr/>Infos</span><a href="#latestsyncinfos" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="latestsyncinfos-1"><span class="tsd-kind-call-signature">latestSyncInfos</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ids</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span><a href="#latestsyncinfos-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">ids</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1775">packages/saltcorn-data/models/table.ts:1775</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="move_include_fts_to_search_context"><span>move_<wbr/>include_<wbr/>fts_<wbr/>to_<wbr/>search_<wbr/>context</span><a href="#move_include_fts_to_search_context" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="move_include_fts_to_search_context-1"><span class="tsd-kind-call-signature">move_include_fts_to_search_context</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#move_include_fts_to_search_context-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4366">packages/saltcorn-data/models/table.ts:4366</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="normalise_error_message"><span>normalise_<wbr/>error_<wbr/>message</span><a href="#normalise_error_message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="normalise_error_message-1"><span class="tsd-kind-call-signature">normalise_error_message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">msg</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><a href="#normalise_error_message-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">msg</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2447">packages/saltcorn-data/models/table.ts:2447</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="owner_fieldname"><span>owner_<wbr/>fieldname</span><a href="#owner_fieldname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="owner_fieldname-1"><span class="tsd-kind-call-signature">owner_fieldname</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><a href="#owner_fieldname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get owner column name</p>
|
|
253
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L504">packages/saltcorn-data/models/table.ts:504</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="owner_fieldname_from_fields"><span>owner_<wbr/>fieldname_<wbr/>from_<wbr/>fields</span><a href="#owner_fieldname_from_fields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="owner_fieldname_from_fields-1"><span class="tsd-kind-call-signature">owner_fieldname_from_fields</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fields</span><span class="tsd-signature-symbol">?:</span> <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><a href="#owner_fieldname_from_fields-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get owner column name</p>
|
|
254
254
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">fields</span>: <a href="_saltcorn_data.models_field.Field.html" class="tsd-signature-type tsd-kind-class">Field</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></span><div class="tsd-comment tsd-typography"><p>fields list</p>
|
|
255
255
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><p>null or owner column name</p>
|
|
256
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
256
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L494">packages/saltcorn-data/models/table.ts:494</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="ownership_formula_where"><span>ownership_<wbr/>formula_<wbr/>where</span><a href="#ownership_formula_where" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="ownership_formula_where-1"><span class="tsd-kind-call-signature">ownership_formula_where</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><a href="#ownership_formula_where-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3883">packages/saltcorn-data/models/table.ts:3883</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="ownership_options"><span>ownership_<wbr/>options</span><a href="#ownership_options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="ownership_options-1"><span class="tsd-kind-call-signature">ownership_options</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#ownership_options-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>get Ownership options
|
|
257
257
|
user interface...</p>
|
|
258
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
259
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
260
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">new_name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
261
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
262
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
263
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><span class="tsd-kind-parameter">field_name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
264
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">v</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">resultCollector</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
265
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">v</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">resultCollector</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">extraArgs</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
266
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
258
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L539">packages/saltcorn-data/models/table.ts:539</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="processselectoptions"><span>process<wbr/>Select<wbr/>Options</span><a href="#processselectoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="processselectoptions-1"><span class="tsd-kind-call-signature">processSelectOptions</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">selopts</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><a href="#processselectoptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">selopts</span>: <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">&</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.ForUserRequest.html" class="tsd-signature-type tsd-kind-interface">ForUserRequest</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1287">packages/saltcorn-data/models/table.ts:1287</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="read_state_strict"><span>read_<wbr/>state_<wbr/>strict</span><a href="#read_state_strict" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="read_state_strict-1"><span class="tsd-kind-call-signature">read_state_strict</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><a href="#read_state_strict-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">state</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L3040">packages/saltcorn-data/models/table.ts:3040</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="redo_row_changes"><span>redo_<wbr/>row_<wbr/>changes</span><a href="#redo_row_changes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="redo_row_changes-1"><span class="tsd-kind-call-signature">redo_row_changes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#redo_row_changes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Redo row changes</p>
|
|
259
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2717">packages/saltcorn-data/models/table.ts:2717</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rename"><span>rename</span><a href="#rename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="rename-1"><span class="tsd-kind-call-signature">rename</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">new_name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#rename-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Rename table</p>
|
|
260
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">new_name</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2812">packages/saltcorn-data/models/table.ts:2812</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="repaircompositeprimary"><span>repair<wbr/>Composite<wbr/>Primary</span><a href="#repaircompositeprimary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="repaircompositeprimary-1"><span class="tsd-kind-call-signature">repairCompositePrimary</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#repaircompositeprimary-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4309">packages/saltcorn-data/models/table.ts:4309</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="resetsequence"><span>reset<wbr/>Sequence</span><a href="#resetsequence" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="resetsequence-1"><span class="tsd-kind-call-signature">resetSequence</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#resetsequence-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reset Sequence</p>
|
|
261
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L872">packages/saltcorn-data/models/table.ts:872</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="restore_row_version"><span>restore_<wbr/>row_<wbr/>version</span><a href="#restore_row_version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="restore_row_version-1"><span class="tsd-kind-call-signature">restore_row_version</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#restore_row_version-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Restore Row Version</p>
|
|
262
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2662">packages/saltcorn-data/models/table.ts:2662</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="slug_options"><span>slug_<wbr/>options</span><a href="#slug_options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="slug_options-1"><span class="tsd-kind-call-signature">slug_options</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">steps</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_types.base_types.SlugStepType.html" class="tsd-signature-type tsd-kind-type-alias">SlugStepType</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#slug_options-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">steps</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_types.base_types.SlugStepType.html" class="tsd-signature-type tsd-kind-type-alias">SlugStepType</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4234">packages/saltcorn-data/models/table.ts:4234</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="to_provided_table"><span>to_<wbr/>provided_<wbr/>table</span><a href="#to_provided_table" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="to_provided_table-1"><span class="tsd-kind-call-signature">to_provided_table</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><a href="#to_provided_table-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L313">packages/saltcorn-data/models/table.ts:313</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="togglebool"><span>toggle<wbr/>Bool</span><a href="#togglebool" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="togglebool-1"><span class="tsd-kind-call-signature">toggleBool</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">field_name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#togglebool-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>????</p>
|
|
263
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><span class="tsd-kind-parameter">field_name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1901">packages/saltcorn-data/models/table.ts:1901</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tryinsertrow"><span>try<wbr/>Insert<wbr/>Row</span><a href="#tryinsertrow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tryinsertrow-1"><span class="tsd-kind-call-signature">tryInsertRow</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resultCollector</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><a href="#tryinsertrow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Try to Insert row</p>
|
|
264
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">v</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">resultCollector</span>: <span class="tsd-signature-type">object</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">error</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">success</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2426">packages/saltcorn-data/models/table.ts:2426</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tryupdaterow"><span>try<wbr/>Update<wbr/>Row</span><a href="#tryupdaterow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="tryupdaterow-1"><span class="tsd-kind-call-signature">tryUpdateRow</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">v</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resultCollector</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">extraArgs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span><a href="#tryupdaterow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Try to Update row</p>
|
|
265
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">v</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">resultCollector</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">extraArgs</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1875">packages/saltcorn-data/models/table.ts:1875</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="undo_row_changes"><span>undo_<wbr/>row_<wbr/>changes</span><a href="#undo_row_changes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="undo_row_changes-1"><span class="tsd-kind-call-signature">undo_row_changes</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#undo_row_changes-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Undo row chnages</p>
|
|
266
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2685">packages/saltcorn-data/models/table.ts:2685</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="update"><span>update</span><a href="#update" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="update-1"><span class="tsd-kind-call-signature">update</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">new_table_rec</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#update-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update Table description in _sc_table
|
|
267
267
|
Also creates / drops history table for table</p>
|
|
268
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">new_table_rec</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
268
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">new_table_rec</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2848">packages/saltcorn-data/models/table.ts:2848</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updaterow"><span>update<wbr/>Row</span><a href="#updaterow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updaterow-1"><span class="tsd-kind-call-signature">updateRow</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">v_in</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">id_in</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_db-common.dbtypes.PrimaryKeyValue.html" class="tsd-signature-type tsd-kind-type-alias">PrimaryKeyValue</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noTrigger</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">additionalTriggerValues</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">autoRecalcIterations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">extraArgs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">noTrigger</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">restore_of_version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">resultCollector</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">syncTimestamp</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resultCollector</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">restore_of_version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">syncTimestamp</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">additionalTriggerValues</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">autoRecalcIterations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">extraArgs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updaterow-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update a single row in the table database.</p>
|
|
269
269
|
<p>The first two arguments are mandatory. The first is an object with the new values to set in the row.
|
|
270
270
|
The second argument is the value of the primary key of the row to update. Typically this is the id
|
|
271
271
|
field of an existing row object</p>
|
|
@@ -274,22 +274,22 @@ field of an existing row object</p>
|
|
|
274
274
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noTrigger</span>: <br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">boolean</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">additionalTriggerValues</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">autoRecalcIterations</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">extraArgs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">noTrigger</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">restore_of_version</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">resultCollector</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">syncTimestamp</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Date</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">resultCollector</span>: <span class="tsd-signature-type">object</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">restore_of_version</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">syncTimestamp</span>: <span class="tsd-signature-type">Date</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">additionalTriggerValues</span>: <a href="../types/_saltcorn_db-common.dbtypes.Row.html" class="tsd-signature-type tsd-kind-type-alias">Row</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">autoRecalcIterations</span>: <span class="tsd-signature-type">number</span></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">extraArgs</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example-8">Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">bookTable</span><span class="hl-1"> = </span><span class="hl-0">Table</span><span class="hl-1">.</span><span class="hl-2">findOne</span><span class="hl-1">({</span><span class="hl-0">name:</span><span class="hl-1"> </span><span class="hl-3">"books"</span><span class="hl-1">})</span><br/><br/><span class="hl-4">// get the row in the book table for Moby Dick</span><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">moby_dick</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">getRow</span><span class="hl-1">({</span><span class="hl-0">title:</span><span class="hl-1"> </span><span class="hl-3">"Moby Dick"</span><span class="hl-1">})</span><br/><br/><span class="hl-4">// Update the read field to true and the rating field to 5</span><br/><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">updateRow</span><span class="hl-1">({</span><span class="hl-0">read:</span><span class="hl-1"> </span><span class="hl-6">true</span><span class="hl-1">, </span><span class="hl-0">rating:</span><span class="hl-1"> </span><span class="hl-5">5</span><span class="hl-1">}, </span><span class="hl-0">moby_dick</span><span class="hl-1">.</span><span class="hl-0">id</span><span class="hl-1">)</span><br/><br/><span class="hl-4">// if you want to update more than one row, you must first retrieve all the rows and</span><br/><span class="hl-4">// then update them individually</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">allBooks</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">getRows</span><span class="hl-1">()</span><br/><span class="hl-8">for</span><span class="hl-1">(</span><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">book</span><span class="hl-1"> </span><span class="hl-6">of</span><span class="hl-1"> </span><span class="hl-0">allBooks</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-0">bookTable</span><span class="hl-1">.</span><span class="hl-2">updateRow</span><span class="hl-1">({</span><span class="hl-0">price:</span><span class="hl-1"> </span><span class="hl-0">book</span><span class="hl-1">.</span><span class="hl-0">price</span><span class="hl-1">*</span><span class="hl-5">0.8</span><span class="hl-1">}, </span><span class="hl-0">book</span><span class="hl-1">.</span><span class="hl-0">id</span><span class="hl-1">)</span><br/><span class="hl-1">}</span>
|
|
275
275
|
</code><button>Copy</button></pre>
|
|
276
276
|
|
|
277
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
278
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">where</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">forRead</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">notAuthorized</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
277
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L1409">packages/saltcorn-data/models/table.ts:1409</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatewherewithownership"><span>update<wbr/>Where<wbr/>With<wbr/>Ownership</span><a href="#updatewherewithownership" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updatewherewithownership-1"><span class="tsd-kind-call-signature">updateWhereWithOwnership</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">where</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">user</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">forRead</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">notAuthorized</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#updatewherewithownership-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>update Where with Ownership</p>
|
|
278
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">where</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">user</span>: <a href="../interfaces/_saltcorn_types.model-abstracts_abstract_user.AbstractUser.html" class="tsd-signature-type tsd-kind-interface">AbstractUser</a></span></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">forRead</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">notAuthorized</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L894">packages/saltcorn-data/models/table.ts:894</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="allslugoptions"><code class="tsd-tag">Static</code><span>all<wbr/>Slug<wbr/>Options</span><a href="#allslugoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="allslugoptions-1"><span class="tsd-kind-call-signature">allSlugOptions</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><br/> <span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">steps</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_types.base_types.SlugStepType.html" class="tsd-signature-type tsd-kind-type-alias">SlugStepType</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">></span><a href="#allslugoptions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">nm</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">steps</span><span class="tsd-signature-symbol">:</span> <a href="../types/_saltcorn_types.base_types.SlugStepType.html" class="tsd-signature-type tsd-kind-type-alias">SlugStepType</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L4266">packages/saltcorn-data/models/table.ts:4266</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="create"><code class="tsd-tag">Static</code><span>create</span><a href="#create" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="create-1"><span class="tsd-kind-call-signature">create</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_types.model-abstracts_abstract_table.TablePack.html" class="tsd-signature-type tsd-kind-type-alias">TablePack</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">></span><a href="#create-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create table</p>
|
|
279
279
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>table name</p>
|
|
280
280
|
</div></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_types.model-abstracts_abstract_table.TablePack.html" class="tsd-signature-type tsd-kind-type-alias">TablePack</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>table fields</p>
|
|
281
281
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>optional id, if set, no '_sc_tables' entry is inserted</p>
|
|
282
282
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">></span></h4><p>table</p>
|
|
283
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
284
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
283
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L713">packages/saltcorn-data/models/table.ts:713</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="create_from_csv"><code class="tsd-tag">Static</code><span>create_<wbr/>from_<wbr/>csv</span><a href="#create_from_csv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="create_from_csv-1"><span class="tsd-kind-call-signature">create_from_csv</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">filePath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span><a href="#create_from_csv-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Table Create from CSV</p>
|
|
284
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">filePath</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/_saltcorn_types.common_types.ResultMessage.html" class="tsd-signature-type tsd-kind-type-alias">ResultMessage</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2913">packages/saltcorn-data/models/table.ts:2913</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createindb"><code class="tsd-tag">Static</code><span>create<wbr/>In<wbr/>Db</span><a href="#createindb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="createindb-1"><span class="tsd-kind-call-signature">createInDb</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">table</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#createindb-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create the table structure
|
|
285
285
|
generates a CREATE TABLE cmd with all field and runs it
|
|
286
286
|
TODO field defaults for pg</p>
|
|
287
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">table</span>: <a href="" class="tsd-signature-type tsd-kind-class">Table</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
287
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">table</span>: <a href="" class="tsd-signature-type tsd-kind-class">Table</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L795">packages/saltcorn-data/models/table.ts:795</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="find"><code class="tsd-tag">Static</code><span>find</span><a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="find-1"><span class="tsd-kind-call-signature">find</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">where</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">selectopts</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Find Tables</p>
|
|
288
288
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">where</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a></span><div class="tsd-comment tsd-typography"><p>where condition</p>
|
|
289
289
|
</div></li><li><span><span class="tsd-kind-parameter">selectopts</span>: <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a><span class="tsd-signature-symbol"> = ...</span></span><div class="tsd-comment tsd-typography"><p>options</p>
|
|
290
290
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>table list</p>
|
|
291
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
292
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">where0</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><span class="tsd-kind-parameter">selectopts</span>: <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a><span class="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/
|
|
291
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L388">packages/saltcorn-data/models/table.ts:388</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="find_with_external"><code class="tsd-tag">Static</code><span>find_<wbr/>with_<wbr/>external</span><a href="#find_with_external" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="find_with_external-1"><span class="tsd-kind-call-signature">find_with_external</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">where0</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">selectopts</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#find_with_external-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Find Tables including external tables</p>
|
|
292
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">where0</span>: <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a><span class="tsd-signature-symbol"> = {}</span></span></li><li><span><span class="tsd-kind-parameter">selectopts</span>: <a href="../types/_saltcorn_db-common.dbtypes.SelectOptions.html" class="tsd-signature-type tsd-kind-type-alias">SelectOptions</a><span class="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L444">packages/saltcorn-data/models/table.ts:444</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="findone"><code class="tsd-tag">Static</code><span>find<wbr/>One</span><a href="#findone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="findone-1"><span class="tsd-kind-call-signature">findOne</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">where</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a> <span class="tsd-signature-symbol">|</span> <a href="" class="tsd-signature-type tsd-kind-class">Table</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Table</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><a href="#findone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Find one Table</p>
|
|
293
293
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">where</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">|</span> <a href="../types/_saltcorn_db-common.dbtypes.Where.html" class="tsd-signature-type tsd-kind-type-alias">Where</a> <span class="tsd-signature-symbol">|</span> <a href="" class="tsd-signature-type tsd-kind-class">Table</a></span><div class="tsd-comment tsd-typography"><p>where condition</p>
|
|
294
294
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Table</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></h4><p>table or null</p>
|
|
295
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/2356b2705ef931f8dc1387363443314a966e9463/packages/saltcorn-data/models/table.ts#L349">packages/saltcorn-data/models/table.ts:349</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="state_refresh"><code class="tsd-tag">Static</code><span>state_<wbr/>refresh</span><a href="#state_refresh" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="state_refresh-1"><span class="tsd-kind-call-signature">state_refresh</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noSignal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#state_refresh-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noSignal</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/2356b2705ef931f8dc1387363443314a966e9463/packages/saltcorn-data/models/table.ts#L2871">packages/saltcorn-data/models/table.ts:2871</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#querying-table-rows"><span>Querying table rows</span></a><a href="#updating-a-row"><span>Updating a <wbr/>Row</span></a><a href="#inserting-a-new-row"><span>Inserting a new <wbr/>Row</span></a><a href="#deleting-rows"><span>Deleting rows</span></a><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#constraints"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>constraints</span></a><a href="#description"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>external</span></a><a href="#fields"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fields</span></a><a href="#has_sync_info"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>sync_<wbr/>info</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#is_user_group"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>user_<wbr/>group</span></a><a href="#min_role_read"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min_<wbr/>role_<wbr/>read</span></a><a href="#min_role_write"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min_<wbr/>role_<wbr/>write</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#ownership_field_id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ownership_<wbr/>field_<wbr/>id</span></a><a href="#ownership_formula"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ownership_<wbr/>formula</span></a><a href="#provider_cfg"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provider_<wbr/>cfg</span></a><a href="#provider_name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provider_<wbr/>name</span></a><a href="#versioned"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>versioned</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#composite_pk_names"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>composite_<wbr/>pk_<wbr/>names</span></a><a href="#pk_name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pk_<wbr/>name</span></a><a href="#pk_type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pk_<wbr/>type</span></a><a href="#santized_name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>santized_<wbr/>name</span></a><a href="#sql_name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sql_<wbr/>name</span></a><a href="#to_json"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>to_<wbr/>json</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#aggregationquery"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>aggregation<wbr/>Query</span></a><a href="#check_table_constraints"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check_<wbr/>table_<wbr/>constraints</span></a><a href="#compress_history"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>compress_<wbr/>history</span></a><a href="#countrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count<wbr/>Rows</span></a><a href="#delete"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#delete_url"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete_<wbr/>url</span></a><a href="#deleterows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Rows</span></a><a href="#distinctvalues"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>distinct<wbr/>Values</span></a><a href="#dump_history_to_json"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dump_<wbr/>history_<wbr/>to_<wbr/>json</span></a><a href="#dump_to_json"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dump_<wbr/>to_<wbr/>json</span></a><a href="#enable_fkey_constraints"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable_<wbr/>fkey_<wbr/>constraints</span></a><a href="#field_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>field_<wbr/>options</span></a><a href="#get_child_relations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>child_<wbr/>relations</span></a><a href="#get_history"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>history</span></a><a href="#get_join_field_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>join_<wbr/>field_<wbr/>options</span></a><a href="#get_models"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>models</span></a><a href="#get_parent_relations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>parent_<wbr/>relations</span></a><a href="#get_relation_data"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>relation_<wbr/>data</span></a><a href="#get_relation_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>relation_<wbr/>options</span></a><a href="#getfield"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Field</span></a><a href="#getfields"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Fields</span></a><a href="#getforeignkeys"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Foreign<wbr/>Keys</span></a><a href="#getforeigntables"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Foreign<wbr/>Tables</span></a><a href="#getformulaexamples"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Formula<wbr/>Examples</span></a><a href="#getjoinedquery"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Joined<wbr/>Query</span></a><a href="#getjoinedrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Joined<wbr/>Row</span></a><a href="#getjoinedrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Joined<wbr/>Rows</span></a><a href="#getrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Row</span></a><a href="#getrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Rows</span></a><a href="#gettags"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tags</span></a><a href="#import_csv_file"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import_<wbr/>csv_<wbr/>file</span></a><a href="#import_json_file"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import_<wbr/>json_<wbr/>file</span></a><a href="#import_json_history_file"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import_<wbr/>json_<wbr/>history_<wbr/>file</span></a><a href="#insert_history_row"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>insert_<wbr/>history_<wbr/>row</span></a><a href="#insertrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>insert<wbr/>Row</span></a><a href="#is_owner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is_<wbr/>owner</span></a><a href="#latestsyncinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>latest<wbr/>Sync<wbr/>Info</span></a><a href="#latestsyncinfos"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>latest<wbr/>Sync<wbr/>Infos</span></a><a href="#move_include_fts_to_search_context"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move_<wbr/>include_<wbr/>fts_<wbr/>to_<wbr/>search_<wbr/>context</span></a><a href="#normalise_error_message"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>normalise_<wbr/>error_<wbr/>message</span></a><a href="#owner_fieldname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>owner_<wbr/>fieldname</span></a><a href="#owner_fieldname_from_fields"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>owner_<wbr/>fieldname_<wbr/>from_<wbr/>fields</span></a><a href="#ownership_formula_where"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ownership_<wbr/>formula_<wbr/>where</span></a><a href="#ownership_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ownership_<wbr/>options</span></a><a href="#processselectoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process<wbr/>Select<wbr/>Options</span></a><a href="#read_state_strict"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read_<wbr/>state_<wbr/>strict</span></a><a href="#redo_row_changes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>redo_<wbr/>row_<wbr/>changes</span></a><a href="#rename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rename</span></a><a href="#repaircompositeprimary"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>repair<wbr/>Composite<wbr/>Primary</span></a><a href="#resetsequence"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Sequence</span></a><a href="#restore_row_version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore_<wbr/>row_<wbr/>version</span></a><a href="#slug_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>slug_<wbr/>options</span></a><a href="#to_provided_table"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to_<wbr/>provided_<wbr/>table</span></a><a href="#togglebool"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Bool</span></a><a href="#tryinsertrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Insert<wbr/>Row</span></a><a href="#tryupdaterow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Update<wbr/>Row</span></a><a href="#undo_row_changes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>undo_<wbr/>row_<wbr/>changes</span></a><a href="#update"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a><a href="#updaterow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Row</span></a><a href="#updatewherewithownership"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Where<wbr/>With<wbr/>Ownership</span></a><a href="#allslugoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>all<wbr/>Slug<wbr/>Options</span></a><a href="#create"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a><a href="#create_from_csv"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create_<wbr/>from_<wbr/>csv</span></a><a href="#createindb"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>In<wbr/>Db</span></a><a href="#find"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find</span></a><a href="#find_with_external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find_<wbr/>with_<wbr/>external</span></a><a href="#findone"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>One</span></a><a href="#state_refresh"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>state_<wbr/>refresh</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
295
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L349">packages/saltcorn-data/models/table.ts:349</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="state_refresh"><code class="tsd-tag">Static</code><span>state_<wbr/>refresh</span><a href="#state_refresh" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="state_refresh-1"><span class="tsd-kind-call-signature">state_refresh</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noSignal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#state_refresh-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noSignal</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/saltcorn/saltcorn/blob/123d470497f31b56d6e14aa926787817d09d99c7/packages/saltcorn-data/models/table.ts#L2877">packages/saltcorn-data/models/table.ts:2877</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#querying-table-rows"><span>Querying table rows</span></a><a href="#updating-a-row"><span>Updating a <wbr/>Row</span></a><a href="#inserting-a-new-row"><span>Inserting a new <wbr/>Row</span></a><a href="#deleting-rows"><span>Deleting rows</span></a><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#constraints"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>constraints</span></a><a href="#description"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>external</span></a><a href="#fields"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fields</span></a><a href="#has_sync_info"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has_<wbr/>sync_<wbr/>info</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#is_user_group"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>user_<wbr/>group</span></a><a href="#min_role_read"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min_<wbr/>role_<wbr/>read</span></a><a href="#min_role_write"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min_<wbr/>role_<wbr/>write</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#ownership_field_id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ownership_<wbr/>field_<wbr/>id</span></a><a href="#ownership_formula"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ownership_<wbr/>formula</span></a><a href="#provider_cfg"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provider_<wbr/>cfg</span></a><a href="#provider_name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provider_<wbr/>name</span></a><a href="#versioned"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>versioned</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#composite_pk_names"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>composite_<wbr/>pk_<wbr/>names</span></a><a href="#pk_name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pk_<wbr/>name</span></a><a href="#pk_type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>pk_<wbr/>type</span></a><a href="#santized_name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>santized_<wbr/>name</span></a><a href="#sql_name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>sql_<wbr/>name</span></a><a href="#to_json"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>to_<wbr/>json</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#aggregationquery"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>aggregation<wbr/>Query</span></a><a href="#check_table_constraints"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>check_<wbr/>table_<wbr/>constraints</span></a><a href="#compress_history"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>compress_<wbr/>history</span></a><a href="#countrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>count<wbr/>Rows</span></a><a href="#delete"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete</span></a><a href="#delete_url"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete_<wbr/>url</span></a><a href="#deleterows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Rows</span></a><a href="#distinctvalues"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>distinct<wbr/>Values</span></a><a href="#dump_history_to_json"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dump_<wbr/>history_<wbr/>to_<wbr/>json</span></a><a href="#dump_to_json"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dump_<wbr/>to_<wbr/>json</span></a><a href="#enable_fkey_constraints"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable_<wbr/>fkey_<wbr/>constraints</span></a><a href="#field_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>field_<wbr/>options</span></a><a href="#get_child_relations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>child_<wbr/>relations</span></a><a href="#get_history"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>history</span></a><a href="#get_join_field_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>join_<wbr/>field_<wbr/>options</span></a><a href="#get_models"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>models</span></a><a href="#get_parent_relations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>parent_<wbr/>relations</span></a><a href="#get_relation_data"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>relation_<wbr/>data</span></a><a href="#get_relation_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get_<wbr/>relation_<wbr/>options</span></a><a href="#getfield"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Field</span></a><a href="#getfields"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Fields</span></a><a href="#getforeignkeys"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Foreign<wbr/>Keys</span></a><a href="#getforeigntables"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Foreign<wbr/>Tables</span></a><a href="#getformulaexamples"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Formula<wbr/>Examples</span></a><a href="#getjoinedquery"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Joined<wbr/>Query</span></a><a href="#getjoinedrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Joined<wbr/>Row</span></a><a href="#getjoinedrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Joined<wbr/>Rows</span></a><a href="#getrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Row</span></a><a href="#getrows"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Rows</span></a><a href="#gettags"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Tags</span></a><a href="#import_csv_file"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import_<wbr/>csv_<wbr/>file</span></a><a href="#import_json_file"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import_<wbr/>json_<wbr/>file</span></a><a href="#import_json_history_file"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import_<wbr/>json_<wbr/>history_<wbr/>file</span></a><a href="#insert_history_row"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>insert_<wbr/>history_<wbr/>row</span></a><a href="#insertrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>insert<wbr/>Row</span></a><a href="#is_owner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is_<wbr/>owner</span></a><a href="#latestsyncinfo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>latest<wbr/>Sync<wbr/>Info</span></a><a href="#latestsyncinfos"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>latest<wbr/>Sync<wbr/>Infos</span></a><a href="#move_include_fts_to_search_context"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>move_<wbr/>include_<wbr/>fts_<wbr/>to_<wbr/>search_<wbr/>context</span></a><a href="#normalise_error_message"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>normalise_<wbr/>error_<wbr/>message</span></a><a href="#owner_fieldname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>owner_<wbr/>fieldname</span></a><a href="#owner_fieldname_from_fields"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>owner_<wbr/>fieldname_<wbr/>from_<wbr/>fields</span></a><a href="#ownership_formula_where"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ownership_<wbr/>formula_<wbr/>where</span></a><a href="#ownership_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>ownership_<wbr/>options</span></a><a href="#processselectoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>process<wbr/>Select<wbr/>Options</span></a><a href="#read_state_strict"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read_<wbr/>state_<wbr/>strict</span></a><a href="#redo_row_changes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>redo_<wbr/>row_<wbr/>changes</span></a><a href="#rename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rename</span></a><a href="#repaircompositeprimary"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>repair<wbr/>Composite<wbr/>Primary</span></a><a href="#resetsequence"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reset<wbr/>Sequence</span></a><a href="#restore_row_version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>restore_<wbr/>row_<wbr/>version</span></a><a href="#slug_options"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>slug_<wbr/>options</span></a><a href="#to_provided_table"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to_<wbr/>provided_<wbr/>table</span></a><a href="#togglebool"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toggle<wbr/>Bool</span></a><a href="#tryinsertrow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Insert<wbr/>Row</span></a><a href="#tryupdaterow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>try<wbr/>Update<wbr/>Row</span></a><a href="#undo_row_changes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>undo_<wbr/>row_<wbr/>changes</span></a><a href="#update"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update</span></a><a href="#updaterow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Row</span></a><a href="#updatewherewithownership"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Where<wbr/>With<wbr/>Ownership</span></a><a href="#allslugoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>all<wbr/>Slug<wbr/>Options</span></a><a href="#create"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create</span></a><a href="#create_from_csv"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create_<wbr/>from_<wbr/>csv</span></a><a href="#createindb"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>In<wbr/>Db</span></a><a href="#find"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find</span></a><a href="#find_with_external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find_<wbr/>with_<wbr/>external</span></a><a href="#findone"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>find<wbr/>One</span></a><a href="#state_refresh"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>state_<wbr/>refresh</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|