THE LINUX FOUNDATION PROJECTS
Docs navigation
On this page

    3.5 Key-Value Format

    Since: 1.0-preview

    Columns that provide Key-Value information are often used in place of separate columns for enumerating data which would be inherently sparse and/or without predetermined keys. This consolidates related information and provides more consistency in the schema. Key-value pairs are also referred to as name-value pairs, attribute-value pairs, or field-value pairs.

    All key-value related columns defined in the FOCUS specification MUST follow the key-value formatting requirements listed below.

    3.5.3 Description

    Rules and formatting requirements for columns appearing in billing data that convey data as key-value pairs.

    3.5.4 Requirements

    • Key-Value Format columns MUST contain a serialized JSON string, consistent with the ECMA 404 definition of an object.
    • Keys in a key-value pair MUST be unique within an object.
    • Values in a key-value pair MUST be one of the following types: number, string, true, false, or null.
    • Values in a key-value pair MUST NOT be an object or an array.

    3.5.5 Exceptions

    None