Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ColumnSpecification

Package version

interface

An interface representing ColumnSpecification. Swagger 2.0 schema for a column within the data table representing a web service input or output. See Swagger specification: http://swagger.io/specification/

Hierarchy

  • ColumnSpecification

Index

Properties

Optional enum

enum: any[]
member

{any[]} [enum] If the data type is categorical, this provides the list of accepted categories.

Optional format

format: ColumnFormat
member

{ColumnFormat} [format] Additional format information for the data type. Possible values include: 'Byte', 'Char', 'Complex64', 'Complex128', 'Date-time', 'Date-timeOffset', 'Double', 'Duration', 'Float', 'Int8', 'Int16', 'Int32', 'Int64', 'Uint8', 'Uint16', 'Uint32', 'Uint64'

type

member

{ColumnType} type Data type of the column. Possible values include: 'Boolean', 'Integer', 'Number', 'String'

Optional xMsIsnullable

xMsIsnullable: undefined | false | true
member

{boolean} [xMsIsnullable] Flag indicating if the type supports null values or not.

Optional xMsIsordered

xMsIsordered: undefined | false | true
member

{boolean} [xMsIsordered] Flag indicating whether the categories are treated as an ordered set or not, if this is a categorical column.

Generated using TypeDoc