Table

Specification

{
  "name": String,
  "description": String,
  "fields": [
    <fields spec>
  ],
  "persistenceMapping": {
    <persistenceMapping spec>
  }
}

Structure Values

Field NameTypeDescriptionRequiredDefault
nameStringObject name.Required
descriptionStringTable annotation and expanded table information.
None
fieldsArray of fields objectsSpecifications for each field. The fields argument is only used when creating a table from a JSON spec.
None
persistenceMappingpersistenceMappingDefines the location and format of the underlying data for this table. The persistenceMapping argument is only used when creating a table from a JSON spec.
None


Example

{
  "name": "f_transaction",
  "description": "This table contains transaction records",
  "fields": [
    {
      "name": "uid",
      "description": "This is the primary key of the table",
      "fieldType": "int"
    }
  ],
  "persistenceMapping": {
    "sourceName": "my_data_warehouse",
    "file": {
      "path": "/storage_files",
      "fileName": "transactions_3c4c9f",
      "compression": None,
      "format": "json"
    },
    "mapping": [
      {
        "sourceField": "uid",
        "targetField": "uid"
      }
    ],
    "isWritable": true,
    "mappingType": "FileSystem"
  }
}
Was this article helpful?
0 out of 0 found this helpful