forked from yahoo/elide-doc
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request yahoo#172 from yahoo/elide-6.x
Elide 6.x & Subscription Documentation
- Loading branch information
Showing
103 changed files
with
8,574 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| - name: FromTable | ||
| description: Aggregation store annotation which binds an Elide model to a physical database table. | ||
| applicationLevel: | ||
| - Class | ||
| parameters: | ||
| - name: name | ||
| default: <em>None</em> | ||
| type: String | ||
| required: True | ||
| description: The name of the physical table which backs the Elide model. | ||
| - name: dbConnectionName | ||
| default: <em>None</em> | ||
| type: String | ||
| required: False | ||
| description: The name of the database connection source where the physical data resides. | ||
|
|
||
| - name: FromSubquery | ||
| description: Aggregation store annotation which binds an Elide model to a native SQL query. | ||
| applicationLevel: | ||
| - Class | ||
| parameters: | ||
| - name: sql | ||
| default: <em>None</em> | ||
| type: String | ||
| required: True | ||
| description: The native SQL query that defines this model. | ||
| - name: dbConnectionName | ||
| default: <em>None</em> | ||
| type: String | ||
| required: False | ||
| description: The name of the database connection source where the physical data resides. | ||
|
|
||
| - name: ColumnMeta | ||
| description: Metadata to export about a table column. | ||
| applicationLevel: | ||
| - Method | ||
| - Field | ||
| parameters: | ||
| - name: description | ||
| default: <em>None</em> | ||
| type: String | ||
| required: False | ||
| description: The description of the column. | ||
| - name: category | ||
| default: <em>None</em> | ||
| type: String | ||
| required: False | ||
| description: The category of the column. | ||
| - name: tableSource | ||
| default: <em>None</em> | ||
| type: String | ||
| required: False | ||
| description: The table and column names where to find the values (tableName.columnName). | ||
| - name: tags | ||
| default: <em>None</em> | ||
| type: String[] | ||
| required: False | ||
| description: list of free-form text labels for the column. | ||
| - name: values | ||
| default: <em>None</em> | ||
| type: String[] | ||
| required: False | ||
| description: An optional enumerated list of dimension values for small cardinality dimensions. | ||
| - name: size | ||
| default: <em>UNKNOWN</em> | ||
| type: CardinalitySize | ||
| required: False | ||
| description: A hint about the dimension's cardinality (TINY, SMALL, MEDIUM, LARGE, HUGE or UNKNOWN). | ||
| - name: friendlyName | ||
| default: <em>Same As field name</em> | ||
| type: String | ||
| required: False | ||
| description: The friendly name for this column to be displayed in the UI. | ||
|
|
||
| - name: TableMeta | ||
| description: Metadata to export about a table. | ||
| applicationLevel: | ||
| - Class | ||
| parameters: | ||
| - name: description | ||
| default: <em>None</em> | ||
| type: String | ||
| required: False | ||
| description: The description of the table. | ||
| - name: category | ||
| default: <em>None</em> | ||
| type: String | ||
| required: False | ||
| description: The category of the table. | ||
| - name: tags | ||
| default: <em>None</em> | ||
| type: String[] | ||
| required: False | ||
| description: list of free-form text labels for the column. | ||
| - name: filterTemplate | ||
| default: <em>None</em> | ||
| type: String[] | ||
| required: False | ||
| description: An RSQL filter expression template that must directly match or be included in the client provided filter. | ||
| - name: isFact | ||
| default: True | ||
| type: Boolean | ||
| required: False | ||
| description: Is the table a Fact table. | ||
| - name: size | ||
| default: <em>UNKNOWN</em> | ||
| type: CardinalitySize | ||
| required: False | ||
| description: A hint about the table's size (TINY, SMALL, MEDIUM, LARGE, HUGE or UNKNOWN). | ||
| - name: friendlyName | ||
| default: <em>Same As table name</em> | ||
| type: String | ||
| required: False | ||
| description: The friendly name for this table to be displayed in the UI. | ||
|
|
||
| - name: MetricFormula | ||
| description: Native SQL fragment that defines a metric column. | ||
| applicationLevel: | ||
| - Method | ||
| - Field | ||
| parameters: | ||
| - name: value | ||
| default: <em>None</em> | ||
| type: String | ||
| required: True | ||
| description: A templated (optional) native SQL fragment. Field references enclosed in `{{ }}` are substituted with the SQL fragments of other model fields. | ||
|
|
||
| - name: DimensionFormula | ||
| description: Native SQL fragment that defines a dimension column. | ||
| applicationLevel: | ||
| - Method | ||
| - Field | ||
| parameters: | ||
| - name: value | ||
| default: <em>None</em> | ||
| type: String | ||
| required: True | ||
| description: A templated (optional) native SQL fragment. Field references enclosed in `{{ }}` are substituted with the SQL fragments of other model fields. | ||
|
|
||
| - name: Join | ||
| description: A templated SQL 'on' clause to join two tables. Annotates a model field reference to another table. | ||
| applicationLevel: | ||
| - Method | ||
| - Field | ||
| parameters: | ||
| - name: value | ||
| default: <em>None</em> | ||
| type: String | ||
| required: True | ||
| description: A join constraint like '%from.col1 = %join.col2' where %from is the current model and %join is the model being joined. | ||
|
|
||
| - name: TimeGrainDefinition | ||
| description: Defines a time grain. | ||
| applicationLevel: | ||
| - Temporal Annotation | ||
| parameters: | ||
| - name: grain | ||
| default: Day | ||
| type: TimeGrain | ||
| required: True | ||
| description: The time grain or period (DAY, YEAR, etc). | ||
| - name: expression | ||
| default: <em>None</em> | ||
| type: String | ||
| required: False | ||
| description: A templated native SQL fragment. The template variable '{{}}' in the expression will be replaced with the column formula at query time. | ||
|
|
||
| - name: Temporal | ||
| description: Marks the dimension as a _time_ dimension. | ||
| applicationLevel: | ||
| - Method | ||
| - Field | ||
| parameters: | ||
| - name: grains | ||
| default: <em>None</em> | ||
| type: TimeGrainDefinition[] | ||
| required: True | ||
| description: The time grains or periods associated with the time dimension. | ||
| - name: timeZone | ||
| default: UTC | ||
| type: String | ||
| required: False | ||
| description: The timezone associated with the time dimension. | ||
|
|
||
| - name: VersionQuery | ||
| description: Specifies a SQL query for SQLQueryEngine to use for detecting data changes. This must be present for SQLQueryEngine to support caching an entity. | ||
| applicationLevel: | ||
| - Class | ||
| parameters: | ||
| - name: sql | ||
| default: <em>None</em> | ||
| type: String | ||
| required: True | ||
| description: SQL SELECT query that returns a string or integer value. The value must change whenever the corresponding database table changes. |
Oops, something went wrong.