@xeplr/actions 1.2.0 → 1.3.0
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/README.md +1 -1
- package/lib/builtins/db/procedure.js +5 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -87,7 +87,7 @@ var moved = await actions.runAction(actions.builtins.dbMove, {
|
|
|
87
87
|
|---|---|
|
|
88
88
|
| `name` | Required. |
|
|
89
89
|
| `description` | Text for pickers. |
|
|
90
|
-
| `inputSchema` | `[{ name, type, required, default, description, order, ... }]`, validated by `@xeplr/schema-handler` `applySchema`. Built-ins also use `group`, `showWhen`, `system`, `options`, `optionsFrom`, `dependsOn`, `label`, `hidden` (left out of a form unless a value is already set) and `control` (`'parameters'`: `[{ name, value }]` shown as rows, a value fixed or bound to the run's window: `{window.from}` / `{window.to}`, see `@xeplr/jobs`) — hints for a form; validation treats every field the same. |
|
|
90
|
+
| `inputSchema` | `[{ name, type, required, default, description, order, ... }]`, validated by `@xeplr/schema-handler` `applySchema`. Built-ins also use `group`, `showWhen`, `system`, `options`, `optionsFrom`, `dependsOn`, `label`, `hidden` (left out of a form unless a value is already set), `suggestFrom` / `suggestWith` (a host option source that suggests values, asked with the named sibling inputs; `db-procedure`'s parameters ask `procedureParams` with the connection, database and procedure) and `control` (`'parameters'`: `[{ name, value }]` shown as rows, a value fixed or bound to the run's window: `{window.from}` / `{window.to}`, see `@xeplr/jobs`) — hints for a form; validation treats every field the same. |
|
|
91
91
|
| `outputSchema` | Optional documentation of the return value. |
|
|
92
92
|
| `requires` | Module names checked with `require.resolve` at `register()`. |
|
|
93
93
|
| `execute({ input, system, metaStore })` | Returns (or resolves to) the output. |
|
|
@@ -101,7 +101,12 @@ module.exports = {
|
|
|
101
101
|
// `control: 'parameters'`: a form shows these as rows — a name and where
|
|
102
102
|
// its value comes from (a fixed value, or the start / end of the run's
|
|
103
103
|
// window, which a job binds as "{window.from}" / "{window.to}").
|
|
104
|
+
// `suggestFrom`: where a form finds the procedure's own parameter names
|
|
105
|
+
// (a host option source), asked with the values of `suggestWith` — the
|
|
106
|
+
// connection, database and procedure chosen above.
|
|
104
107
|
{ name: 'params', type: 'array', order: 7, control: 'parameters', label: 'Parameters',
|
|
108
|
+
suggestFrom: 'procedureParams',
|
|
109
|
+
suggestWith: { connectionId: 'connectionInfoId', dbInfoId: 'dbInfoId', procedure: 'procedure' },
|
|
105
110
|
description: 'Parameters, as [{ name, value }] or bare values. Named entries are matched by ' +
|
|
106
111
|
'name on postgres and mssql; MySQL has no named-argument syntax, so there they ' +
|
|
107
112
|
'are positional and must be in the order the procedure declares them.' },
|
package/package.json
CHANGED