Interface: RdfUpload

Defined in: src/types/ingestion.ts:2576

One original RDF artifact: its upload extent and its durable ingestion checkpoint.

Remarks

Mapped from the snake_case wire Artifact. status is the engine’s own string, copied verbatim: uploading until every byte is stored, then queued, processing, paused, complete or failed as the import runs. A read answers interrupted for an import that reads queued or processing but has no live worker; IngestionClient.completeRdfUpload resumes it from the last committed batch.

Example

const upload = await client.ingestion.getRdfUpload(id);
console.log(upload.status, `${upload.uploadedBytes}/${upload.size}`);

Properties

batchesCommitted

batchesCommitted: number

Defined in: src/types/ingestion.ts:2622

The batches committed so far.

chunkBytes

chunkBytes: number

Defined in: src/types/ingestion.ts:2589

The chunk size the engine requires: every chunk except the last has exactly this many bytes, and starts at a multiple of it.

chunkSha256

chunkSha256: string[]

Defined in: src/types/ingestion.ts:2595

The SHA-256 of each stored chunk, lowercase hex, in offset order. The listing (IngestionClient.listRdfUploads) answers it empty; read one artifact for the digests.

datasetScope?

optional datasetScope?: string | null

Defined in: src/types/ingestion.ts:2613

The shared N-Triples/N-Quads dataset scope, when the upload declared one.

documentId?

optional documentId?: string | null

Defined in: src/types/ingestion.ts:2611

The document of the import within its session, once it has started.

engineBinarySha256?

optional engineBinarySha256?: string | null

Defined in: src/types/ingestion.ts:2599

The identity of the engine executable that produced the resumable checkpoint.

error?

optional error?: string | null

Defined in: src/types/ingestion.ts:2628

Why the import failed, when it did.

format

format: RdfFormatDto

Defined in: src/types/ingestion.ts:2601

The RDF format the engine read from the file name.

gzip

gzip: boolean

Defined in: src/types/ingestion.ts:2603

Whether the engine decodes the file as gzip.

id

id: string

Defined in: src/types/ingestion.ts:2578

The artifact id.

name

name: string

Defined in: src/types/ingestion.ts:2580

The file name the upload was opened with.

ownerId

ownerId: string

Defined in: src/types/ingestion.ts:2607

The principal that opened the upload; only it can send chunks, complete or pause.

prefixBindings

prefixBindings: Record<string, string>

Defined in: src/types/ingestion.ts:2618

The namespace prefixes the import registered, persisted with the checkpoint. Keys are prefixes and are copied verbatim.

quadsCommitted

quadsCommitted: number

Defined in: src/types/ingestion.ts:2620

The quads committed so far.

resourcesCreated

resourcesCreated: number

Defined in: src/types/ingestion.ts:2624

The resources the import created so far.

sessionId?

optional sessionId?: string | null

Defined in: src/types/ingestion.ts:2609

The ingestion session of the import, once it has started.

sha256?

optional sha256?: string | null

Defined in: src/types/ingestion.ts:2597

The SHA-256 of the whole file, once the engine has computed it.

size

size: number

Defined in: src/types/ingestion.ts:2582

The declared size of the file in bytes.

sortsCreated

sortsCreated: number

Defined in: src/types/ingestion.ts:2626

The sorts the import created so far.

status

status: string

Defined in: src/types/ingestion.ts:2605

The engine’s status string (see the remarks).

updatedAt

updatedAt: string

Defined in: src/types/ingestion.ts:2630

When the engine last saved this record (RFC 3339).

uploadedBytes

uploadedBytes: number

Defined in: src/types/ingestion.ts:2584

The bytes the engine has stored durably.