expkerneltransferrun
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
One run of an import or export tool: a row of exp_transfer_run (doc/eng-us/features/6.0/transfer-runs.md).
Description
One run of an import or export tool: a row of exp_transfer_run (doc/eng-us/features/6.0/transfer-runs.md).
Every tool of the transfer registry writes one row per run through expKernelTransferHistory, whatever ran it (expqueue, the kernel's content jobs, its own process): the tool (its registry id, transfer.xrowextract), the direction and kind, what it covered (scope, scope_ref), who ran it, when, how it ended, the counts, the bytes, the format, a file reference relative to the tool (never a path), the engine and its job (job_ref), the tool's own job or run (tool_ref) and the link to the tool's own page of the run (detail_url). The tools keep their detailed records (rows, logs, files) themselves; this row is the summary every page can list and count.
normalize() is pure: it is what every write goes through, so the values a row can hold are tested without a database.
@since 6.0.15
Persistent
Yes. Table exp_transfer_run.
Attributes
| Attribute | Type | Static* |
|---|---|---|
| id | integer | Yes. |
| user_id | integer | Yes. |
| created | integer | Yes. |
| modified | integer | Yes. |
| started | integer | Yes. |
| finished | integer | Yes. |
| duration | integer | Yes. |
| rows_total | integer | Yes. |
| rows_done | integer | Yes. |
| rows_failed | integer | Yes. |
| bytes | integer | Yes. |
| tool | string | Yes. |
| direction | string | Yes. |
| kind | string | Yes. |
| title | string | Yes. |
| state | string | Yes. |
| format | string | Yes. |
| scope | string | Yes. |
| scope_ref | string | Yes. |
| file_ref | string | Yes. |
| engine | string | Yes. |
| job_ref | string | Yes. |
| tool_ref | string | Yes. |
| detail_url | string | Yes. |
| error | string | Yes. |
| siteaccess | string | Yes. |
| detail | text | Yes. |
| detail_array | - | No. |
| is_final | - | No. |
| outcome | - | No. |
* Yes: a field of the table (a stored value); No: a function attribute, computed when it is asked for.
Source
kernel/classes/transfer/expkerneltransferrun.php, expKernelTransferRun::definition()
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this object.
Contributors
- Graham Brookins Updated
Comments
Add a comment