Skip to content

descriptorPrimaryKey.schema.md

Latest commit

 

History

History
211 lines (110 loc) · 4.74 KB

descriptorPrimaryKey.schema.md

File metadata and controls

211 lines (110 loc) · 4.74 KB

Primary Key Descriptor Schema

https://ns.adobe.com/xdm/common/descriptors/descriptorPrimaryKey

Used to identify a single or a set of column(s) that must be enforced as non-null and unique.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted descriptors/primarykey/descriptorPrimaryKey.schema.json

Schema Hierarchy

  • Primary Key Descriptor https://ns.adobe.com/xdm/common/descriptors/descriptorPrimaryKey

Primary Key Descriptor Examples

{
  "@type": "xdm:descriptorPrimaryKey",
  "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile",
  "xdm:sourceVersion": 1,
  "xdm:sourceProperty": [
    "/_id"
  ]
}
{
  "@type": "xdm:descriptorPrimaryKey",
  "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/profile",
  "xdm:sourceVersion": 1,
  "xdm:sourceProperty": [
    "/_id",
    "/personID"
  ]
}

Primary Key Descriptor Properties

Property Type Required Defined by
@id string Optional Schema Descriptor
@type const Optional Primary Key Descriptor (this schema)
xdm:sourceItem complex Optional Schema Descriptor
xdm:sourceProperty complex Optional Schema Descriptor
xdm:sourceSchema string Optional Schema Descriptor
xdm:sourceVersion number Optional Schema Descriptor
* any Additional this schema allows additional properties

@id

Identifier

The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

@type

Type

@type

  • is optional
  • type: const
  • defined in this schema

The value of this property must be equal to:

"xdm:descriptorPrimaryKey"

xdm:sourceItem

Source Item

When present, the selector used to match a specific item in the array pointed to by sourceProperty.

xdm:sourceItem

xdm:sourceItem Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Condition 3

Condition 4

xdm:sourceProperty

Source Property

When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by xdm:sourceSchema.

xdm:sourceProperty

xdm:sourceProperty Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

xdm:sourceSchema

Source Schema

The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'

xdm:sourceSchema

xdm:sourceSchema Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:sourceVersion

Source Version

Major version being referenced.

xdm:sourceVersion

xdm:sourceVersion Type

number