@triply/triplydb
    Preparing search index...

    Interface AddDatasetOptions

    Metadata for a dataset created by AccountBase.addDataset or AccountBase.ensureDataset.

    Everything NewDataset accepts except name, which is passed separately, plus IRI prefix declarations that are applied once the dataset exists.

    interface AddDatasetOptions {
        accessLevel?: AccessLevel;
        autogeneratedIdType?: AutoGeneratedIdType;
        description?: string;
        displayName?: string;
        license?: keyof Licenses;
        prefixes?: Prefixes;
        toAccount?: string;
    }

    Hierarchy

    Index
    accessLevel? autogeneratedIdType? description? displayName? license? prefixes? toAccount?
    accessLevel?: AccessLevel

    Who can reach the dataset — see AccessLevel. Defaults to private.

    autogeneratedIdType?: AutoGeneratedIdType

    Shape of the identifiers generated for blank nodes — see AutoGeneratedIdType.

    description?: string

    Free-text description, shown on the dataset's page.

    displayName?: string

    Title shown in the interface, free of the restrictions that apply to name.

    license?: keyof Licenses

    Licence the data is published under.

    prefixes?: Prefixes

    IRI prefix declarations to add to the new dataset, as alias-to-IRI pairs.

    toAccount?: string

    Account to copy or transfer the dataset to. Required on copy and chown; ignored on create, where the account comes from the URL.

    Settings

    On This Page
    Properties