Import Models#
This documentation auto-generates details about the Pydantic models defined in
app/domain/imports/models/models.py.
Models used by the Import domain.
- pydantic model app.domain.imports.models.models.ImportBatch[source]#
Core import batch model with database and internal attributes included.
Show Entity Relationship Diagram
![digraph "Entity Relationship Diagram created by erdantic" {
graph [fontcolor=gray66,
fontname="Times New Roman,Times,Liberation Serif,serif",
fontsize=9,
nodesep=0.5,
rankdir=LR,
ranksep=1.5
];
node [fontname="Times New Roman,Times,Liberation Serif,serif",
fontsize=14,
label="\N",
shape=plain
];
edge [dir=both];
"app.domain.imports.models.models.ImportBatch" [label=<<table border="0" cellborder="1" cellspacing="0"><tr><td port="_root" colspan="2"><b>ImportBatch</b></td></tr><tr><td>id</td><td port="id">UUID</td></tr><tr><td>storage_url</td><td port="storage_url">HttpUrl</td></tr><tr><td>status</td><td port="status">ImportBatchStatus | None</td></tr><tr><td>import_record_id</td><td port="import_record_id">UUID</td></tr><tr><td>import_record</td><td port="import_record">ImportRecord | None</td></tr><tr><td>import_results</td><td port="import_results">list[ImportResult] | None</td></tr></table>>,
tooltip="app.domain.imports.models.models.ImportBatch

Core import batch model with database and internal attributes included.
"];
"app.domain.imports.models.models.ImportRecord" [label=<<table border="0" cellborder="1" cellspacing="0"><tr><td port="_root" colspan="2"><b>ImportRecord</b></td></tr><tr><td>id</td><td port="id">UUID</td></tr><tr><td>search_string</td><td port="search_string">str | None</td></tr><tr><td>searched_at</td><td port="searched_at">PastDatetime</td></tr><tr><td>processor_name</td><td port="processor_name">str</td></tr><tr><td>processor_version</td><td port="processor_version">str</td></tr><tr><td>notes</td><td port="notes">str | None</td></tr><tr><td>expected_reference_count</td><td port="expected_reference_count">int</td></tr><tr><td>source_name</td><td port="source_name">str</td></tr><tr><td>status</td><td port="status">ImportRecordStatus</td></tr><tr><td>batches</td><td port="batches">list[ImportBatch] | None</td></tr></table>>,
tooltip="app.domain.imports.models.models.ImportRecord

Core import record model with database and internal attributes included.&#\
xA;"];
"app.domain.imports.models.models.ImportBatch":import_record:e -> "app.domain.imports.models.models.ImportRecord":_root:w [arrowhead=noneteetee,
arrowtail=nonenone];
"app.domain.imports.models.models.ImportResult" [label=<<table border="0" cellborder="1" cellspacing="0"><tr><td port="_root" colspan="2"><b>ImportResult</b></td></tr><tr><td>id</td><td port="id">UUID</td></tr><tr><td>import_batch_id</td><td port="import_batch_id">UUID</td></tr><tr><td>status</td><td port="status">ImportResultStatus</td></tr><tr><td>import_batch</td><td port="import_batch">ImportBatch | None</td></tr><tr><td>reference_id</td><td port="reference_id">UUID | None</td></tr><tr><td>failure_details</td><td port="failure_details">str | None</td></tr></table>>,
tooltip="app.domain.imports.models.models.ImportResult

Core import result model with database attributes included.
"];
"app.domain.imports.models.models.ImportBatch":import_results:e -> "app.domain.imports.models.models.ImportResult":_root:w [arrowhead=noneteetee,
arrowtail=nonenone];
"app.domain.imports.models.models.ImportRecord":batches:e -> "app.domain.imports.models.models.ImportBatch":_root:w [arrowhead=noneteetee,
arrowtail=nonenone];
"app.domain.imports.models.models.ImportResult":import_batch:e -> "app.domain.imports.models.models.ImportBatch":_root:w [arrowhead=noneteetee,
arrowtail=nonenone];
}](../../_images/graphviz-65e17eb7b249c1fbf57ed9b115ec09ec629470d9.png)
Show JSON schema
{ "$defs": { "ImportBatch": { "description": "Core import batch model with database and internal attributes included.", "properties": { "id": { "description": "The autogenerated database ID.", "format": "uuid", "title": "Id", "type": "string" }, "storage_url": { "description": "\nThe URL at which the set of references for this batch are stored.\n ", "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Storage Url", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/$defs/ImportBatchStatus" }, { "type": "null" } ], "default": null, "description": "The status of the batch." }, "import_record_id": { "description": "The ID of the parent import record.", "format": "uuid", "title": "Import Record Id", "type": "string" }, "import_record": { "anyOf": [ { "$ref": "#/$defs/ImportRecord" }, { "type": "null" } ], "default": null, "description": "The parent import record." }, "import_results": { "anyOf": [ { "items": { "$ref": "#/$defs/ImportResult" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The results from processing the batch.", "title": "Import Results" } }, "required": [ "storage_url", "import_record_id" ], "title": "ImportBatch", "type": "object" }, "ImportBatchStatus": { "description": "Describes the status of an import batch.", "enum": [ "created", "started", "failed", "partially_failed", "completed" ], "title": "ImportBatchStatus", "type": "string" }, "ImportRecord": { "description": "Core import record model with database and internal attributes included.", "properties": { "id": { "description": "The autogenerated database ID.", "format": "uuid", "title": "Id", "type": "string" }, "search_string": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The search string used to produce this import", "title": "Search String" }, "searched_at": { "description": "\nThe timestamp (including timezone) at which the search which produced\nthis import was conducted. If no timezone is included, the timestamp\nis assumed to be in UTC.\n ", "format": "date-time", "title": "Searched At", "type": "string" }, "processor_name": { "description": "The name of the processor that is importing the data.", "title": "Processor Name", "type": "string" }, "processor_version": { "description": "The version of the processor that is importing the data.", "title": "Processor Version", "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "\nAny additional notes regarding the import (eg. reason for importing, known\nissues).\n ", "title": "Notes" }, "expected_reference_count": { "description": "\nThe number of references expected to be included in this import.\n-1 is accepted if the number is unknown.\n", "minimum": -1, "title": "Expected Reference Count", "type": "integer" }, "source_name": { "description": "The source of the reference being imported (eg. Open Alex)", "title": "Source Name", "type": "string" }, "status": { "$ref": "#/$defs/ImportRecordStatus", "default": "created", "description": "The status of the upload." }, "batches": { "anyOf": [ { "items": { "$ref": "#/$defs/ImportBatch" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The batches associated with this import.", "title": "Batches" } }, "required": [ "processor_name", "processor_version", "expected_reference_count", "source_name" ], "title": "ImportRecord", "type": "object" }, "ImportRecordStatus": { "description": "Describes the status of an import record.", "enum": [ "created", "started", "completed" ], "title": "ImportRecordStatus", "type": "string" }, "ImportResult": { "description": "Core import result model with database attributes included.", "properties": { "id": { "description": "The autogenerated database ID.", "format": "uuid", "title": "Id", "type": "string" }, "import_batch_id": { "description": "The ID of the parent import batch.", "format": "uuid", "title": "Import Batch Id", "type": "string" }, "status": { "$ref": "#/$defs/ImportResultStatus", "default": "created", "description": "The status of the result." }, "import_batch": { "anyOf": [ { "$ref": "#/$defs/ImportBatch" }, { "type": "null" } ], "default": null, "description": "The parent import batch." }, "reference_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The ID of the created reference.", "title": "Reference Id" }, "failure_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Details of any failure that occurred during processing.", "title": "Failure Details" } }, "required": [ "import_batch_id" ], "title": "ImportResult", "type": "object" }, "ImportResultStatus": { "description": "Describes the status of an import result.", "enum": [ "created", "started", "completed", "partially_failed", "failed", "retrying" ], "title": "ImportResultStatus", "type": "string" } }, "$ref": "#/$defs/ImportBatch" }
- Config:
from_attributes: bool = True
- Fields:
- field import_record: ImportRecord | None = None[source]#
The parent import record.
- field import_results: list[ImportResult] | None = None[source]#
The results from processing the batch.
- field status: ImportBatchStatus | None = None[source]#
The status of the batch.
- class app.domain.imports.models.models.ImportBatchStatus(*values)[source]#
Describes the status of an import batch.
- pydantic model app.domain.imports.models.models.ImportRecord[source]#
Core import record model with database and internal attributes included.
Show Entity Relationship Diagram
Show JSON schema
{ "$defs": { "ImportBatch": { "description": "Core import batch model with database and internal attributes included.", "properties": { "id": { "description": "The autogenerated database ID.", "format": "uuid", "title": "Id", "type": "string" }, "storage_url": { "description": "\nThe URL at which the set of references for this batch are stored.\n ", "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Storage Url", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/$defs/ImportBatchStatus" }, { "type": "null" } ], "default": null, "description": "The status of the batch." }, "import_record_id": { "description": "The ID of the parent import record.", "format": "uuid", "title": "Import Record Id", "type": "string" }, "import_record": { "anyOf": [ { "$ref": "#/$defs/ImportRecord" }, { "type": "null" } ], "default": null, "description": "The parent import record." }, "import_results": { "anyOf": [ { "items": { "$ref": "#/$defs/ImportResult" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The results from processing the batch.", "title": "Import Results" } }, "required": [ "storage_url", "import_record_id" ], "title": "ImportBatch", "type": "object" }, "ImportBatchStatus": { "description": "Describes the status of an import batch.", "enum": [ "created", "started", "failed", "partially_failed", "completed" ], "title": "ImportBatchStatus", "type": "string" }, "ImportRecord": { "description": "Core import record model with database and internal attributes included.", "properties": { "id": { "description": "The autogenerated database ID.", "format": "uuid", "title": "Id", "type": "string" }, "search_string": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The search string used to produce this import", "title": "Search String" }, "searched_at": { "description": "\nThe timestamp (including timezone) at which the search which produced\nthis import was conducted. If no timezone is included, the timestamp\nis assumed to be in UTC.\n ", "format": "date-time", "title": "Searched At", "type": "string" }, "processor_name": { "description": "The name of the processor that is importing the data.", "title": "Processor Name", "type": "string" }, "processor_version": { "description": "The version of the processor that is importing the data.", "title": "Processor Version", "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "\nAny additional notes regarding the import (eg. reason for importing, known\nissues).\n ", "title": "Notes" }, "expected_reference_count": { "description": "\nThe number of references expected to be included in this import.\n-1 is accepted if the number is unknown.\n", "minimum": -1, "title": "Expected Reference Count", "type": "integer" }, "source_name": { "description": "The source of the reference being imported (eg. Open Alex)", "title": "Source Name", "type": "string" }, "status": { "$ref": "#/$defs/ImportRecordStatus", "default": "created", "description": "The status of the upload." }, "batches": { "anyOf": [ { "items": { "$ref": "#/$defs/ImportBatch" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The batches associated with this import.", "title": "Batches" } }, "required": [ "processor_name", "processor_version", "expected_reference_count", "source_name" ], "title": "ImportRecord", "type": "object" }, "ImportRecordStatus": { "description": "Describes the status of an import record.", "enum": [ "created", "started", "completed" ], "title": "ImportRecordStatus", "type": "string" }, "ImportResult": { "description": "Core import result model with database attributes included.", "properties": { "id": { "description": "The autogenerated database ID.", "format": "uuid", "title": "Id", "type": "string" }, "import_batch_id": { "description": "The ID of the parent import batch.", "format": "uuid", "title": "Import Batch Id", "type": "string" }, "status": { "$ref": "#/$defs/ImportResultStatus", "default": "created", "description": "The status of the result." }, "import_batch": { "anyOf": [ { "$ref": "#/$defs/ImportBatch" }, { "type": "null" } ], "default": null, "description": "The parent import batch." }, "reference_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The ID of the created reference.", "title": "Reference Id" }, "failure_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Details of any failure that occurred during processing.", "title": "Failure Details" } }, "required": [ "import_batch_id" ], "title": "ImportResult", "type": "object" }, "ImportResultStatus": { "description": "Describes the status of an import result.", "enum": [ "created", "started", "completed", "partially_failed", "failed", "retrying" ], "title": "ImportResultStatus", "type": "string" } }, "$ref": "#/$defs/ImportRecord" }
- Config:
from_attributes: bool = True
- Fields:
- field batches: list[ImportBatch] | None = None[source]#
The batches associated with this import.
- field expected_reference_count: int [Required][source]#
The number of references expected to be included in this import. -1 is accepted if the number is unknown.
- Constraints:
ge = -1
- field notes: str | None = None[source]#
Any additional notes regarding the import (eg. reason for importing, known issues).
- field processor_version: str [Required][source]#
The version of the processor that is importing the data.
- field searched_at: PastDatetime [Optional][source]#
The timestamp (including timezone) at which the search which produced this import was conducted. If no timezone is included, the timestamp is assumed to be in UTC.
- field source_name: str [Required][source]#
The source of the reference being imported (eg. Open Alex)
- field status: ImportRecordStatus = ImportRecordStatus.CREATED[source]#
The status of the upload.
- class app.domain.imports.models.models.ImportRecordStatus(*values)[source]#
Describes the status of an import record.
- pydantic model app.domain.imports.models.models.ImportResult[source]#
Core import result model with database attributes included.
Show Entity Relationship Diagram
Show JSON schema
{ "$defs": { "ImportBatch": { "description": "Core import batch model with database and internal attributes included.", "properties": { "id": { "description": "The autogenerated database ID.", "format": "uuid", "title": "Id", "type": "string" }, "storage_url": { "description": "\nThe URL at which the set of references for this batch are stored.\n ", "format": "uri", "maxLength": 2083, "minLength": 1, "title": "Storage Url", "type": "string" }, "status": { "anyOf": [ { "$ref": "#/$defs/ImportBatchStatus" }, { "type": "null" } ], "default": null, "description": "The status of the batch." }, "import_record_id": { "description": "The ID of the parent import record.", "format": "uuid", "title": "Import Record Id", "type": "string" }, "import_record": { "anyOf": [ { "$ref": "#/$defs/ImportRecord" }, { "type": "null" } ], "default": null, "description": "The parent import record." }, "import_results": { "anyOf": [ { "items": { "$ref": "#/$defs/ImportResult" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The results from processing the batch.", "title": "Import Results" } }, "required": [ "storage_url", "import_record_id" ], "title": "ImportBatch", "type": "object" }, "ImportBatchStatus": { "description": "Describes the status of an import batch.", "enum": [ "created", "started", "failed", "partially_failed", "completed" ], "title": "ImportBatchStatus", "type": "string" }, "ImportRecord": { "description": "Core import record model with database and internal attributes included.", "properties": { "id": { "description": "The autogenerated database ID.", "format": "uuid", "title": "Id", "type": "string" }, "search_string": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The search string used to produce this import", "title": "Search String" }, "searched_at": { "description": "\nThe timestamp (including timezone) at which the search which produced\nthis import was conducted. If no timezone is included, the timestamp\nis assumed to be in UTC.\n ", "format": "date-time", "title": "Searched At", "type": "string" }, "processor_name": { "description": "The name of the processor that is importing the data.", "title": "Processor Name", "type": "string" }, "processor_version": { "description": "The version of the processor that is importing the data.", "title": "Processor Version", "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "\nAny additional notes regarding the import (eg. reason for importing, known\nissues).\n ", "title": "Notes" }, "expected_reference_count": { "description": "\nThe number of references expected to be included in this import.\n-1 is accepted if the number is unknown.\n", "minimum": -1, "title": "Expected Reference Count", "type": "integer" }, "source_name": { "description": "The source of the reference being imported (eg. Open Alex)", "title": "Source Name", "type": "string" }, "status": { "$ref": "#/$defs/ImportRecordStatus", "default": "created", "description": "The status of the upload." }, "batches": { "anyOf": [ { "items": { "$ref": "#/$defs/ImportBatch" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "The batches associated with this import.", "title": "Batches" } }, "required": [ "processor_name", "processor_version", "expected_reference_count", "source_name" ], "title": "ImportRecord", "type": "object" }, "ImportRecordStatus": { "description": "Describes the status of an import record.", "enum": [ "created", "started", "completed" ], "title": "ImportRecordStatus", "type": "string" }, "ImportResult": { "description": "Core import result model with database attributes included.", "properties": { "id": { "description": "The autogenerated database ID.", "format": "uuid", "title": "Id", "type": "string" }, "import_batch_id": { "description": "The ID of the parent import batch.", "format": "uuid", "title": "Import Batch Id", "type": "string" }, "status": { "$ref": "#/$defs/ImportResultStatus", "default": "created", "description": "The status of the result." }, "import_batch": { "anyOf": [ { "$ref": "#/$defs/ImportBatch" }, { "type": "null" } ], "default": null, "description": "The parent import batch." }, "reference_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "description": "The ID of the created reference.", "title": "Reference Id" }, "failure_details": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Details of any failure that occurred during processing.", "title": "Failure Details" } }, "required": [ "import_batch_id" ], "title": "ImportResult", "type": "object" }, "ImportResultStatus": { "description": "Describes the status of an import result.", "enum": [ "created", "started", "completed", "partially_failed", "failed", "retrying" ], "title": "ImportResultStatus", "type": "string" } }, "$ref": "#/$defs/ImportResult" }
- Config:
from_attributes: bool = True
- Fields:
- field failure_details: str | None = None[source]#
Details of any failure that occurred during processing.
- field import_batch: ImportBatch | None = None[source]#
The parent import batch.
- field status: ImportResultStatus = ImportResultStatus.CREATED[source]#
The status of the result.
- class app.domain.imports.models.models.ImportResultStatus(*values)[source]#
Describes the status of an import result.
- FAILED = 'failed'[source]#
The reference failed to be created. See the result’s failure_details field for more information.