awe Base Query Schema
Generated from query.xsd. It includes variable.xsd.
This Schema defines the way an awe Query must be structured
28 elements, 76 declared attributes (0 documented).
Elements
Elements: table, field, constant, operation, case, when, then, else, over, filter, and, or, left-operand, right-operand, query, computed, compound, where, having, join, union, totalize, totalize-by, totalize-field, group-by, partition-by, order-by, variable
table
Type: tableType
Contains: no child elements
Contained by: retrieve-data, multiple, delete, insert, update, query, join
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | identifierType | no | Not documented yet | |
schema | identifierType | no | Not documented yet | |
query | identifierType | no | Not documented yet | |
alias | string | no | Not documented yet |
field
Type: fieldType
Contains: no child elements
Contained by: retrieve-data, multiple, delete, insert, update, operation, then, else, over, left-operand, right-operand, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | identifierType | no | Not documented yet | |
table | identifierType | no | Not documented yet | |
function | functionTypeEnum (21 values) | no | Not documented yet | |
cast | INTEGER, LONG, FLOAT, DOUBLE, STRING | no | Not documented yet | |
noprint | true, false | no | Not documented yet | |
transform | transformType (21 values) | no | Not documented yet | |
pattern | string | no | Not documented yet | |
translate | string | no | Not documented yet | |
format-from | string | no | Not documented yet | |
format-to | string | no | Not documented yet | |
alias | identifierType | no | Not documented yet | |
audit | true, false | no | Not documented yet | |
key | true, false | no | Not documented yet | |
query | identifierType | no | Not documented yet | |
variable | identifierType | no | Not documented yet | |
sequence | identifierType | no | Not documented yet | |
auto-incremental | identifierType | no | Not documented yet | |
optional | true, false | no | Not documented yet |
constant
Type: constantType
Contains: no child elements
Contained by: retrieve-data, delete, insert, update, operation, then, else, over, left-operand, right-operand, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | identifierType | no | Not documented yet | |
table | identifierType | no | Not documented yet | |
function | functionTypeEnum (21 values) | no | Not documented yet | |
cast | INTEGER, LONG, FLOAT, DOUBLE, STRING | no | Not documented yet | |
noprint | true, false | no | Not documented yet | |
transform | transformType (21 values) | no | Not documented yet | |
pattern | string | no | Not documented yet | |
translate | string | no | Not documented yet | |
format-from | string | no | Not documented yet | |
format-to | string | no | Not documented yet | |
alias | identifierType | no | Not documented yet | |
audit | true, false | no | Not documented yet | |
key | true, false | no | Not documented yet | |
value | string | no | Not documented yet | |
type | variableRestriction (25 values) | no | Not documented yet |
operation
Type: operationType
Contains: field (0..n), constant (0..n), operation (0..n), case (0..n), over (0..n)
Contained by: retrieve-data, delete, insert, update, operation, then, else, over, left-operand, right-operand, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | identifierType | no | Not documented yet | |
table | identifierType | no | Not documented yet | |
function | functionTypeEnum (21 values) | no | Not documented yet | |
cast | INTEGER, LONG, FLOAT, DOUBLE, STRING | no | Not documented yet | |
noprint | true, false | no | Not documented yet | |
transform | transformType (21 values) | no | Not documented yet | |
pattern | string | no | Not documented yet | |
translate | string | no | Not documented yet | |
format-from | string | no | Not documented yet | |
format-to | string | no | Not documented yet | |
alias | identifierType | no | Not documented yet | |
audit | true, false | no | Not documented yet | |
key | true, false | no | Not documented yet | |
operator | operationRestriction (33 values) | yes | Not documented yet |
case
Type: caseType
Contains: when (0..n), else (0..1)
Contained by: retrieve-data, operation, then, else, over, left-operand, right-operand, query, group-by, partition-by
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | identifierType | no | Not documented yet | |
table | identifierType | no | Not documented yet | |
function | functionTypeEnum (21 values) | no | Not documented yet | |
cast | INTEGER, LONG, FLOAT, DOUBLE, STRING | no | Not documented yet | |
noprint | true, false | no | Not documented yet | |
transform | transformType (21 values) | no | Not documented yet | |
pattern | string | no | Not documented yet | |
translate | string | no | Not documented yet | |
format-from | string | no | Not documented yet | |
format-to | string | no | Not documented yet | |
alias | identifierType | no | Not documented yet | |
audit | true, false | no | Not documented yet | |
key | true, false | no | Not documented yet |
when
Type: caseWhenType
Contains: left-operand (0..1), right-operand (0..1), and (0..1), then (1)
Contained by: case
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
left-field | identifierType | no | Not documented yet | |
left-table | identifierType | no | Not documented yet | |
left-variable | identifierType | no | Not documented yet | |
left-function | functionTypeEnum (21 values) | no | Not documented yet | |
right-field | identifierType | no | Not documented yet | |
right-table | identifierType | no | Not documented yet | |
right-variable | identifierType | no | Not documented yet | |
right-function | functionTypeEnum (21 values) | no | Not documented yet | |
ignorecase | true, false | no | Not documented yet | |
trim | true, false | no | Not documented yet | |
optional | true, false | no | Not documented yet | |
query | identifierType | no | Not documented yet | |
type | NUMBER, DECIMAL_NUMBER, DATE, TIME, STRING | no | Not documented yet | |
condition | conditionEnum (14 values) | no | Not documented yet |
then
Type: operandType
Contains: field (0..1), constant (0..1), operation (0..1), case (0..1), over (0..1)
Contained by: when
Attributes: none
else
Type: operandType
Contains: field (0..1), constant (0..1), operation (0..1), case (0..1), over (0..1)
Contained by: case
Attributes: none
over
Type: overType
Contains: field (0..n), constant (0..n), operation (0..n), case (0..n), over (0..n), partition-by (0..n), order-by (0..n)
Contained by: retrieve-data, operation, then, else, over, left-operand, right-operand, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | identifierType | no | Not documented yet | |
table | identifierType | no | Not documented yet | |
function | functionTypeEnum (21 values) | no | Not documented yet | |
cast | INTEGER, LONG, FLOAT, DOUBLE, STRING | no | Not documented yet | |
noprint | true, false | no | Not documented yet | |
transform | transformType (21 values) | no | Not documented yet | |
pattern | string | no | Not documented yet | |
translate | string | no | Not documented yet | |
format-from | string | no | Not documented yet | |
format-to | string | no | Not documented yet | |
alias | identifierType | no | Not documented yet | |
audit | true, false | no | Not documented yet | |
key | true, false | no | Not documented yet |
filter
Type: filterType
Contains: left-operand (0..1), right-operand (0..1)
Contained by: and, or, where, having
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
left-field | identifierType | no | Not documented yet | |
left-table | identifierType | no | Not documented yet | |
left-variable | identifierType | no | Not documented yet | |
left-function | functionTypeEnum (21 values) | no | Not documented yet | |
right-field | identifierType | no | Not documented yet | |
right-table | identifierType | no | Not documented yet | |
right-variable | identifierType | no | Not documented yet | |
right-function | functionTypeEnum (21 values) | no | Not documented yet | |
ignorecase | true, false | no | Not documented yet | |
trim | true, false | no | Not documented yet | |
optional | true, false | no | Not documented yet | |
query | identifierType | no | Not documented yet | |
type | NUMBER, DECIMAL_NUMBER, DATE, TIME, STRING | no | Not documented yet | |
condition | conditionEnum (14 values) | yes | Not documented yet |
and
Type: filterGroupType
Contains: filter (0..n), or (0..n), and (0..n)
Contained by: when, and, or, where, having, join
Attributes: none
or
Type: filterGroupType
Contains: filter (0..n), or (0..n), and (0..n)
Contained by: and, or, where, having, join
Attributes: none
left-operand
Type: operandType
Contains: field (0..1), constant (0..1), operation (0..1), case (0..1), over (0..1)
Attributes: none
right-operand
Type: operandType
Contains: field (0..1), constant (0..1), operation (0..1), case (0..1), over (0..1)
Attributes: none
query
Type: queryType
Contains: table (0..n), computed (0..n), compound (0..n), field (0..n), constant (0..n), operation (0..n), case (0..n), over (0..n), join (0..n), union (0..n), variable (0..n), where (0..n), having (0..n), order-by (0..n), group-by (0..n), totalize (0..n)
Contained by: queries
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
distinct | true, false | no | Not documented yet | |
enumerated | identifierType | no | Not documented yet | |
service | identifierType | no | Not documented yet | |
queue | identifierType | no | Not documented yet | |
cacheable | true, false | no | Not documented yet | |
managed-pagination | true, false | no | Not documented yet | |
post-process | true, false | no | Not documented yet | |
public | true, false | no | Not documented yet | |
id | identifierType | yes | Not documented yet |
computed
Type: computedType
Contains: no child elements
Contained by: retrieve-data, query, compound
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
alias | string | yes | Not documented yet | |
format | string | yes | Not documented yet | |
eval | true, false | no | Not documented yet | |
nullValue | string | no | Not documented yet | |
transform | transformType (21 values) | no | Not documented yet | |
pattern | string | no | Not documented yet | |
translate | identifierType | no | Not documented yet | |
label | string | no | Not documented yet |
compound
Type: compoundType
Contains: computed (1..n)
Contained by: retrieve-data, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
alias | string | yes | Not documented yet |
where
Type: whereType
Contains: filter (0..n), or (0..n), and (0..n)
Contained by: retrieve-data, delete, update, query
Attributes: none
having
Type: whereType
Contains: filter (0..n), or (0..n), and (0..n)
Contained by: retrieve-data, query
Attributes: none
join
Type: joinType
Contains: table (1), or (0..1), and (0..1)
Contained by: retrieve-data, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
type | FULL, INNER, LEFT, RIGHT | no | Not documented yet |
union
Type: unionType
Contains: no child elements
Contained by: retrieve-data, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
query | identifierType | yes | Not documented yet | |
type | ALL | no | Not documented yet |
totalize
Type: totalizeType
Contains: totalize-by (0..n), totalize-field (0..n)
Contained by: retrieve-data, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
function | aggregationFunctions (9 values) | yes | Not documented yet | |
label | string | yes | Not documented yet | |
field | identifierType | yes | Not documented yet | |
style | TOTAL, SUBTOTAL | yes | Not documented yet |
totalize-by
Type: totalizeElementType
Contains: no child elements
Contained by: totalize
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
field | identifierType | yes | Not documented yet |
totalize-field
Type: totalizeFieldType
Contains: no child elements
Contained by: totalize
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
field | identifierType | yes | Not documented yet | |
function | aggregationFunctions (9 values) | no | Not documented yet |
group-by
Type: groupByType
Contains: case (0..1)
Contained by: retrieve-data, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
field | identifierType | no | Not documented yet | |
table | identifierType | no | Not documented yet | |
function | functionTypeEnum (21 values) | no | Not documented yet |
partition-by
Type: groupByType
Contains: case (0..1)
Contained by: over
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
field | identifierType | no | Not documented yet | |
table | identifierType | no | Not documented yet | |
function | functionTypeEnum (21 values) | no | Not documented yet |
order-by
Type: orderByType
Contains: no child elements
Contained by: retrieve-data, over, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
field | identifierType | yes | Not documented yet | |
table | identifierType | no | Not documented yet | |
function | functionTypeEnum (21 values) | no | Not documented yet | |
type | ASC, DESC | no | Not documented yet | |
nulls | FIRST, LAST | no | Not documented yet |
variable
Type: variableType
Contains: no child elements
Contained by: retrieve-data, multiple, serve, queue, delete, insert, update, include-target, query
| Attribute | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | yes | Not documented yet | |
name | string | no | Not documented yet | |
value | string | no | Not documented yet | |
session | string | no | Not documented yet | |
property | string | no | Not documented yet | |
optional | string | no | Not documented yet | |
type | variableRestriction (25 values) | yes | Not documented yet |
Simple types
identifierType
Base type: string
Pattern: ([0-9a-zA-Z_\-]+)
totalizeStyleType
Base type: string
Allowed values: TOTAL, SUBTOTAL
joinElementType
Base type: string
Allowed values: FULL, INNER, LEFT, RIGHT
unionElementType
Base type: string
Allowed values: ALL
transformType
Base type: string
Allowed values: DATE, DATE_MS, TIME, TIMESTAMP, TIMESTAMP_MS, JS_DATE, JS_TIMESTAMP, ELAPSED_TIME, DATE_SINCE, NUMBER, NUMBER_PLAIN, BOOLEAN, TEXT_HTML, TEXT_UNILINE, TEXT_PLAIN, MARKDOWN_HTML, DECRYPT, GENERIC_DATE, DATE_RDB, ARRAY, LIST
conditionEnum
Base type: string
Allowed values: eq, ne, ge, le, gt, lt, in, not in, is null, is not null, like, not like, exists, not exists
valueTypeEnum
Base type: string
Allowed values: NUMBER, DECIMAL_NUMBER, DATE, TIME, STRING
functionTypeEnum
Allowed values: AVG, CNT, CNT_DISTINCT, MAX, MIN, SUM, FIRST_VALUE, LAST_VALUE, LENGTH, ABS, TRUNCDATE, ROW_NUMBER, RANK, YEAR, MONTH, DAY, HOUR, MINUTE, SECOND, TRIM, LAG
castType
Base type: string
Allowed values: INTEGER, LONG, FLOAT, DOUBLE, STRING
fieldFunctions
Base type: string
Allowed values: ABS, TRUNCDATE, ROW_NUMBER, RANK, YEAR, MONTH, DAY, HOUR, MINUTE, SECOND, TRIM, LAG
aggregationFunctions
Base type: string
Allowed values: AVG, CNT, CNT_DISTINCT, MAX, MIN, SUM, FIRST_VALUE, LAST_VALUE, LENGTH
operationRestriction
Base type: string
Allowed values: CONCAT, REPLACE, SUBSTRING, NULLIF, COALESCE, ADD, SUB, MULT, DIV, MOD, POWER, ROUND, ADD_SECONDS, ADD_MINUTES, ADD_HOURS, ADD_DAYS, ADD_WEEKS, ADD_MONTHS, ADD_YEARS, SUB_SECONDS, SUB_MINUTES, SUB_HOURS, SUB_DAYS, SUB_WEEKS, SUB_MONTHS, SUB_YEARS, DIFF_SECONDS, DIFF_MINUTES, DIFF_HOURS, DIFF_DAYS, DIFF_WEEKS, DIFF_MONTHS, DIFF_YEARS
orderType
Base type: string
Allowed values: ASC, DESC
nullsType
Base type: string
Allowed values: FIRST, LAST