AbstractField Data Type

The complete metadata for each field (column) in a data file or table.

Abstract Type
Subtypes
ObjectField, AtomicField
Properties
name data type description
name string Field name as determined by Waterline Data schema discovery. If the file does not have header information, the field names are assigned.
nullable boolean Internal use.
properties array of Property Field properties. Includes:
  • fieldPath - Same as name unless the file format includes hierarchical data; then this property includes each parent field for this field. For example, "entities.hashtags.text".
  • fieldIndex - Field index as set by Waterline Data schema discovery.
  • nullCount - Number of nulls among this field's values.
  • valueCount - Number of non-null values.
  • density - Ratio of valueCount to the total number of rows (valueCount + nullCount)
  • cardinality - Number of unique values.
  • max - Largest or last value among this field's values.
  • min - Smallest or first value among this field's values.
  • topk - Array of up to 20 sample values.
dataType DataType Field data type as determined by Waterline Data schema discovery.
comment string
displayName string
importedComment string

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "name" : "...",
  "nullable" : true,
  "properties" : [ {
    "name" : "...",
    "type" : "BOOLEAN",
    "value" : { }
  }, {
    "name" : "...",
    "type" : "INT",
    "value" : { }
  } ],
  "dataType" : "INTEGER",
  "comment" : "...",
  "displayName" : "...",
  "importedComment" : "..."
}