Entity (table) attributes

An entity is equivalent to a database table.

Each entity object can contain the following attributes:

{
  "name": string,
  "records": string,
  "unique_records_for": string,
  "record_count": string,
  "view": boolean,
  "sql": string,
  "is_static": boolean,
  "source": {
    "data": string,
    "filename": string
  },
  "constraints": constraint[],
  "fields": field[]
}

name	The name of the entity.
records	Use exact to generate an exact number of rows. Use unique to generate one row for each unique value of a field in this entity.
unique_records_for	Only applies when records is set to unique. The name of the field that determines the number of unique rows to generate for this entity.
record_count	An expression that evaluates to the number of rows to generate for this entity. Only used for entities where the row count is not determined by a foreign key relationship. Ignored if either: records is set to unique The entity has one or more fields that use the Foreign Key generator with a distribution set to something other than none.
view	If true, the entity is generated as a view.
sql	If view is true, the SQL to use to generate the view. Otherwise ignored.
is_static	true if the entity is backed by a static CSV file. Otherwise false.
source	Present if the entity is backed by a static CSV file or has an attached CSV file.
source.data	The raw data from the CSV file.
source.filename	The name of the CSV file.
constraints	List of constraints. For the list of constraint attributes, go to Constraint attributes.
fields	List of fields. For the list of field attributes. go to Column attributes. For views, this is ignored.