Specification
{ "name": String, "description": String, "fields": [ <fields spec> ], "persistenceMapping": { <persistenceMapping spec> } }
Structure Values
Field Name | Type | Description | Required | Default |
---|---|---|---|---|
name | String | Object name. | Required | |
description | String | Table annotation and expanded table information. | None | |
fields | Array of fields objects | Specifications for each field. The fields argument is only used when creating a table from a JSON spec. | None | |
persistenceMapping | persistenceMapping | Defines 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" } }