core/column-1.0.0

A column in a table.

Description

Each column contains a name and an array of data, and an optional description and unit.

Outline

Schema Definitions

This type is an object with the following properties:
  • name
    stringRequired
    The name of the column. Each name in a table must be unique.

    No length restriction
    Must match the following pattern:
    [A-Za-z_][A-Za-z0-9_]*
    
  • data
    objectRequired
    The array data for the column.

    This node must validate against all of the following:

  • description
    string
    An optional description of the column.

    No length restriction
    Default value: ‘’
  • unit
    object
    An optional unit for the column.

    This node must validate against all of the following:

  • meta
    object
    Additional free-form metadata about the column.

    object
    Default value:
    {}
    

Original Schema

%YAML 1.1
---
$schema: "http://stsci.edu/schemas/yaml-schema/draft-01"
id: "http://stsci.edu/schemas/asdf/core/column-1.0.0"
tag: "tag:stsci.edu:asdf/core/column-1.0.0"

title: >
  A column in a table.

description: |
  Each column contains a name and an array of data, and an optional description
  and unit.

type: object
properties:
  name:
    description: |
      The name of the column.  Each name in a
      [table](http://stsci.edu/schemas/asdf/core/table-1.0.0) must be
      unique.
    type: string
    pattern: "[A-Za-z_][A-Za-z0-9_]*"

  data:
    description: |
      The array data for the column.
    allOf:
      - $ref: ndarray-1.0.0

  description:
    description: |
      An optional description of the column.
    type: string
    default: ''

  unit:
    description:
      An optional unit for the column.
    allOf:
      - $ref: ../unit/unit-1.0.0

  meta:
    description:
      Additional free-form metadata about the column.
    type: object
    default: {}

required: [name, data]
additionalProperties: false
...