Skip to content

Class: UniqueKey

a collection of slots whose values uniquely identify an instance of a class

URI: linkml:UniqueKey

classDiagram Extensible <|-- UniqueKey Annotatable <|-- UniqueKey CommonMetadata <|-- UniqueKey UniqueKey : aliases UniqueKey : alt_descriptions UniqueKey : annotations UniqueKey : broad_mappings UniqueKey : close_mappings UniqueKey : comments UniqueKey : deprecated UniqueKey : deprecated_element_has_exact_replacement UniqueKey : deprecated_element_has_possible_replacement UniqueKey : description UniqueKey : exact_mappings UniqueKey : examples UniqueKey : extensions UniqueKey : from_schema UniqueKey : imported_from UniqueKey : in_language UniqueKey : in_subset UniqueKey : mappings UniqueKey : narrow_mappings UniqueKey : notes UniqueKey : rank UniqueKey : related_mappings UniqueKey : see_also UniqueKey : source UniqueKey : structured_aliases UniqueKey : title UniqueKey : todos UniqueKey : unique_key_name UniqueKey : unique_key_slots

Inheritance

  • UniqueKey [ extensible annotatable common_metadata]

Slots

Name Cardinality and Range Description
unique_key_name 1..1
String
name of the unique key
unique_key_slots 1..*
SlotDefinition
list of slot names that form a key
extensions 0..*
Extension
a tag/text tuple attached to an arbitrary element
annotations 0..*
Annotation
a collection of tag/text tuples with the semantics of OWL Annotation
description 0..1 recommended
String
a description of the element's purpose and use
alt_descriptions 0..*
AltDescription
A sourced alternative description for an element
title 0..1
String
the official title of the element
deprecated 0..1
String
Description of why and when this element will no longer be used
todos 0..*
String
Outstanding issue that needs resolution
notes 0..*
String
editorial notes about an element intended for internal consumption
comments 0..*
String
notes and comments about an element intended for external consumption
examples 0..*
Example
example usages of an element
in_subset 0..*
SubsetDefinition
used to indicate membership of a term in a defined subset of terms used for a...
from_schema 0..1
Uri
id of the schema that defined the element
imported_from 0..1
String
the imports entry that this element was derived from
source 0..1
Uriorcurie
A related resource from which the element is derived
in_language 0..1
String
see_also 0..*
Uriorcurie
a reference
deprecated_element_has_exact_replacement 0..1
Uriorcurie
When an element is deprecated, it can be automatically replaced by this uri o...
deprecated_element_has_possible_replacement 0..1
Uriorcurie
When an element is deprecated, it can be potentially replaced by this uri or ...
aliases 0..*
String
Alaternate names for the element
structured_aliases 0..*
StructuredAlias
A list of structured_alias objects
mappings 0..*
Uriorcurie
A list of terms from different schemas or terminology systems that have compa...
exact_mappings 0..*
Uriorcurie
A list of terms from different schemas or terminology systems that have ident...
close_mappings 0..*
Uriorcurie
A list of terms from different schemas or terminology systems that have close...
related_mappings 0..*
Uriorcurie
A list of terms from different schemas or terminology systems that have relat...
narrow_mappings 0..*
Uriorcurie
A list of terms from different schemas or terminology systems that have narro...
broad_mappings 0..*
Uriorcurie
A list of terms from different schemas or terminology systems that have broad...
rank 0..1
Integer
the relative order in which the element occurs, lower values are given preced...

Usages

used by used in type used
ClassDefinition unique_keys range unique_key
UniqueKey unique_key_name domain unique_key
UniqueKey unique_key_slots domain unique_key

Identifier and Mapping Information

Schema Source

  • from schema: https://w3id.org/linkml/meta

Mappings

Mapping Type Mapped Value
self ['linkml:UniqueKey']
native ['linkml:UniqueKey']

LinkML Specification

Direct

name: unique_key
description: a collection of slots whose values uniquely identify an instance of a
  class
in_subset:
- SpecificationSubset
- BasicSubset
- RelationalModelProfile
from_schema: https://w3id.org/linkml/meta
rank: 20
mixins:
- extensible
- annotatable
- common_metadata
slots:
- unique_key_name
- unique_key_slots

Induced

name: unique_key
description: a collection of slots whose values uniquely identify an instance of a
  class
in_subset:
- SpecificationSubset
- BasicSubset
- RelationalModelProfile
from_schema: https://w3id.org/linkml/meta
rank: 20
mixins:
- extensible
- annotatable
- common_metadata
attributes:
  unique_key_name:
    name: unique_key_name
    description: name of the unique key
    in_subset:
    - SpecificationSubset
    - BasicSubset
    - RelationalModelProfile
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: unique_key
    key: true
    alias: unique_key_name
    owner: unique_key
    domain_of:
    - unique_key
    range: string
    required: true
  unique_key_slots:
    name: unique_key_slots
    description: list of slot names that form a key
    in_subset:
    - SpecificationSubset
    - BasicSubset
    - RelationalModelProfile
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: unique_key
    multivalued: true
    alias: unique_key_slots
    owner: unique_key
    domain_of:
    - unique_key
    range: slot_definition
    required: true
  extensions:
    name: extensions
    description: a tag/text tuple attached to an arbitrary element
    from_schema: https://w3id.org/linkml/extensions
    rank: 1000
    domain: extensible
    multivalued: true
    alias: extensions
    owner: unique_key
    domain_of:
    - extension
    - extensible
    range: extension
    inlined: true
  annotations:
    name: annotations
    description: a collection of tag/text tuples with the semantics of OWL Annotation
    from_schema: https://w3id.org/linkml/annotations
    rank: 1000
    is_a: extensions
    domain: annotatable
    multivalued: true
    alias: annotations
    owner: unique_key
    domain_of:
    - annotatable
    - annotation
    range: annotation
    inlined: true
  description:
    name: description
    description: a description of the element's purpose and use
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - definition
    exact_mappings:
    - dcterms:description
    - schema:description
    rank: 5
    domain: element
    slot_uri: skos:definition
    alias: description
    owner: unique_key
    domain_of:
    - common_metadata
    - permissible_value
    range: string
    recommended: true
  alt_descriptions:
    name: alt_descriptions
    description: A sourced alternative description for an element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - alternate definitions
    rank: 1000
    domain: element
    multivalued: true
    alias: alt_descriptions
    owner: unique_key
    domain_of:
    - common_metadata
    range: alt_description
    inlined: true
  title:
    name: title
    description: the official title of the element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - long name
    rank: 3
    domain: element
    slot_uri: dcterms:title
    alias: title
    owner: unique_key
    domain_of:
    - common_metadata
    range: string
  deprecated:
    name: deprecated
    description: Description of why and when this element will no longer be used
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    close_mappings:
    - owl:deprecated
    rank: 1000
    domain: element
    alias: deprecated
    owner: unique_key
    domain_of:
    - common_metadata
    range: string
  todos:
    name: todos
    description: Outstanding issue that needs resolution
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    multivalued: true
    alias: todos
    owner: unique_key
    domain_of:
    - common_metadata
    range: string
  notes:
    name: notes
    description: editorial notes about an element intended for internal consumption
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: skos:editorialNote
    multivalued: true
    alias: notes
    owner: unique_key
    domain_of:
    - common_metadata
    range: string
  comments:
    name: comments
    description: notes and comments about an element intended for external consumption
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    exact_mappings:
    - rdfs:comment
    rank: 1000
    domain: element
    slot_uri: skos:note
    multivalued: true
    alias: comments
    owner: unique_key
    domain_of:
    - common_metadata
    range: string
  examples:
    name: examples
    description: example usages of an element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    close_mappings:
    - vann:example
    rank: 1000
    singular_name: example
    domain: element
    multivalued: true
    alias: examples
    owner: unique_key
    domain_of:
    - common_metadata
    range: example
    inlined: true
  in_subset:
    name: in_subset
    description: used to indicate membership of a term in a defined subset of terms
      used for a particular domain or application (e.g. the translator_minimal subset
      holding the minimal set of predicates used in a translator knowledge graph)
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: OIO:inSubset
    multivalued: true
    alias: in_subset
    owner: unique_key
    domain_of:
    - common_metadata
    range: subset_definition
  from_schema:
    name: from_schema
    description: id of the schema that defined the element
    notes:
    - A stronger model would be range schema_definition, but this doesn't address
      the import model
    in_subset:
    - SpecificationSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: skos:inScheme
    readonly: supplied by the schema loader
    alias: from_schema
    owner: unique_key
    domain_of:
    - common_metadata
    range: uri
  imported_from:
    name: imported_from
    description: the imports entry that this element was derived from.  Empty means
      primary source
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    readonly: supplied by the schema loader
    alias: imported_from
    owner: unique_key
    domain_of:
    - common_metadata
    range: string
  source:
    name: source
    description: A related resource from which the element is derived.
    comments:
    - The described resource may be derived from the related resource in whole or
      in part
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - origin
    - derived from
    close_mappings:
    - prov:wasDerivedFrom
    - schema:isBasedOn
    rank: 1000
    domain: element
    slot_uri: dcterms:source
    alias: source
    owner: unique_key
    domain_of:
    - common_metadata
    range: uriorcurie
  in_language:
    name: in_language
    notes:
    - Use a string from IETF BCP 47
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    slot_uri: schema:inLanguage
    alias: in_language
    owner: unique_key
    domain_of:
    - common_metadata
    range: string
  see_also:
    name: see_also
    description: a reference
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: rdfs:seeAlso
    multivalued: true
    alias: see_also
    owner: unique_key
    domain_of:
    - common_metadata
    range: uriorcurie
  deprecated element has exact replacement:
    name: deprecated element has exact replacement
    description: When an element is deprecated, it can be automatically replaced by
      this uri or curie
    from_schema: https://w3id.org/linkml/mappings
    mappings:
    - IAO:0100001
    rank: 1000
    alias: deprecated_element_has_exact_replacement
    owner: unique_key
    domain_of:
    - common_metadata
    range: uriorcurie
  deprecated element has possible replacement:
    name: deprecated element has possible replacement
    description: When an element is deprecated, it can be potentially replaced by
      this uri or curie
    from_schema: https://w3id.org/linkml/mappings
    mappings:
    - OIO:consider
    rank: 1000
    alias: deprecated_element_has_possible_replacement
    owner: unique_key
    domain_of:
    - common_metadata
    range: uriorcurie
  aliases:
    name: aliases
    description: Alaternate names for the element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - synonyms
    - alternate names
    - alternative labels
    - designations
    exact_mappings:
    - schema:alternateName
    rank: 1000
    domain: element
    slot_uri: skos:altLabel
    multivalued: true
    alias: aliases
    owner: unique_key
    domain_of:
    - common_metadata
    range: string
  structured_aliases:
    name: structured_aliases
    description: A list of structured_alias objects.
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    slot_uri: skosxl:altLabel
    multivalued: true
    alias: structured_aliases
    owner: unique_key
    domain_of:
    - common_metadata
    range: structured_alias
    inlined: true
  mappings:
    name: mappings
    description: A list of terms from different schemas or terminology systems that
      have comparable meaning. These may include terms that are precisely equivalent,
      broader or narrower in meaning, or otherwise semantically related but not equivalent
      from a strict ontological perspective.
    from_schema: https://w3id.org/linkml/mappings
    aliases:
    - xrefs
    - identifiers
    - alternate identifiers
    - alternate ids
    rank: 1000
    slot_uri: skos:mappingRelation
    multivalued: true
    alias: mappings
    owner: unique_key
    domain_of:
    - common_metadata
    range: uriorcurie
  exact mappings:
    name: exact mappings
    description: A list of terms from different schemas or terminology systems that
      have identical meaning.
    from_schema: https://w3id.org/linkml/mappings
    rank: 1000
    is_a: mappings
    slot_uri: skos:exactMatch
    multivalued: true
    inherited: false
    alias: exact_mappings
    owner: unique_key
    domain_of:
    - common_metadata
    - UnitOfMeasure
    range: uriorcurie
  close mappings:
    name: close mappings
    description: A list of terms from different schemas or terminology systems that
      have close meaning.
    from_schema: https://w3id.org/linkml/mappings
    rank: 1000
    is_a: mappings
    slot_uri: skos:closeMatch
    multivalued: true
    inherited: false
    alias: close_mappings
    owner: unique_key
    domain_of:
    - common_metadata
    range: uriorcurie
  related mappings:
    name: related mappings
    description: A list of terms from different schemas or terminology systems that
      have related meaning.
    from_schema: https://w3id.org/linkml/mappings
    rank: 1000
    is_a: mappings
    slot_uri: skos:relatedMatch
    multivalued: true
    inherited: false
    alias: related_mappings
    owner: unique_key
    domain_of:
    - common_metadata
    range: uriorcurie
  narrow mappings:
    name: narrow mappings
    description: A list of terms from different schemas or terminology systems that
      have narrower meaning.
    from_schema: https://w3id.org/linkml/mappings
    rank: 1000
    is_a: mappings
    slot_uri: skos:narrowMatch
    multivalued: true
    inherited: false
    alias: narrow_mappings
    owner: unique_key
    domain_of:
    - common_metadata
    range: uriorcurie
  broad mappings:
    name: broad mappings
    description: A list of terms from different schemas or terminology systems that
      have broader meaning.
    from_schema: https://w3id.org/linkml/mappings
    rank: 1000
    is_a: mappings
    slot_uri: skos:broadMatch
    multivalued: true
    inherited: false
    alias: broad_mappings
    owner: unique_key
    domain_of:
    - common_metadata
    range: uriorcurie
  rank:
    name: rank
    description: the relative order in which the element occurs, lower values are
      given precedence
    comments:
    - the rank of an element does not affect the semantics
    in_subset:
    - SpecificationSubset
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - order
    - precedence
    - display order
    exact_mappings:
    - qudt:order
    rank: 51
    slot_uri: sh:order
    alias: rank
    owner: unique_key
    domain_of:
    - common_metadata
    - class_rule
    range: integer