Interface IActionRdfUpdateQuads

Data interface for the type of action.

interface IActionRdfUpdateQuads {
    context: IActionContext;
    createGraphs?: {
        graphs: NamedNode<string>[];
        requireNonExistence: boolean;
    };
    deleteGraphs?: {
        dropGraphs: boolean;
        graphs: DefaultGraph
        | "NAMED"
        | "ALL"
        | NamedNode<string>[];
        requireExistence: boolean;
    };
    quadStreamDelete?: AsyncIterator<Quad>;
    quadStreamInsert?: AsyncIterator<Quad>;
}

Hierarchy (View Summary)

Properties

context createGraphs? deleteGraphs? quadStreamDelete? quadStreamInsert?

Properties

context

context: IActionContext

The input context that is passed through by actors.

OptionalcreateGraphs

createGraphs?: { graphs: NamedNode<string>[]; requireNonExistence: boolean }

An optional creation of (empty) graphs.

Type declaration

  • graphs: NamedNode<string>[]

    The graph names to create.

  • requireNonExistence: boolean

    If true, an error MUST be thrown when the graph already exists.

    For destinations that do not record empty graphs, this should only throw if at least one quad with the given quad already exists.

OptionaldeleteGraphs

deleteGraphs?: {
    dropGraphs: boolean;
    graphs: DefaultGraph | "NAMED" | "ALL" | NamedNode<string>[];
    requireExistence: boolean;
}

An optional deletion of graphs.

Type declaration

  • dropGraphs: boolean

    If the graph itself should also be dropped. Should not happen on the 'DEFAULT' graph.

    Should only be considered on destinations that record empty graphs.

  • graphs: DefaultGraph | "NAMED" | "ALL" | NamedNode<string>[]

    The graph(s) in which all triples must be removed.

  • requireExistence: boolean

    If true, and the graph does not exist, an error must be emitted.

    Should only be considered on destinations that record empty graphs.

OptionalquadStreamDelete

quadStreamDelete?: AsyncIterator<Quad>

An optional stream of quads to delete.

OptionalquadStreamInsert

quadStreamInsert?: AsyncIterator<Quad>

An optional stream of quads to insert.

Settings

Member Visibility

On This Page

Properties