Database Reference

Validate against: http://json-schema.org/schema

Description

A reference to an item in a database, used when you wish to store an item separately in the database (following a relational database model), rather than inline. A disadvantage of this approach is that it often requires making multiple database calls. To avoid this, in most cases the actual object can be used instead of a database reference. For example, instead of making a reference to a separate Person file, you can simply include the Person object directly in place of the database reference. This is useful when you don't want to deal with cross references and multiple database calls. In this case, it is often a good idea to include just a minimal set of data. For a person, for example, you might include just the ID, abbreviation, family name, and given name. This prevents you from having to replicate all of the data about that Person each time it is used.

Type: object

Additional properties: true

Properties

  • Type: "type"

    Description

    The type of object. Must be set to DatabaseReference.

    Type: string

  • Referenced Abbreviation: "abbreviation"

    Description

    The abbreviation of the referenced database item.

    Must be an instance of the Abbreviation schema.

  • Referenced ID: "id"

    Description

    The ID of the referenced database item

  • Filename: "filename"

    Description

    If the reference database item is a media item, use this field for the name of the referenced file.

    Type: string

  • Referenced Index: "index"

    Description

    The index of the referenced database item. Indexes should start at 1 rather than 0 to increase human readability.

    Type: integer

    Minimum: 1

  • Referenced Key: "key"

    Description

    The key of the referenced database item

    Type: string

    Regular expression pattern: ^[^\s]+$

  • Name: "name"

    Description

    The name of the referenced database item, optionally in multiple languages.

    Must be an instance of the MultiLangString schema.

  • Referenced Item Type: "referenceType"

    Description

    The type of database item being referenced

    Type: string

    Allowed Values (enum)

    • "BibliographicReference"
    • "Bundle"
    • "Language"
    • "Lexeme"
    • "Location"
    • "Media"
    • "Morpheme"
    • "Orthography"
    • "Person"
    • "Sense"
    • "Text"
    • "Utterance"
    • "Word"
  • Referenced URL: "url"

    Description

    The URL of the referenced database item

    Type: string

    Format: uri