SerializationType
Internal node-kind tags used to discriminate every part of the query object graph during
serialization. Every _type getter you see across the class reference (Select._type,
Eq._type, Field._type, ...) returns one of these members, and every call to
ctx.serialize(type, data, defaultFn) is keyed by one. This enum is primarily relevant to authors
of a SerializerExtension/dialect package who need to know which node type to intercept — not to
everyday query building. See
Generating SQL per dialect.
import { SerializationType } from '@sqb/builder';
Members
| Member | Value | Produced by |
|---|---|---|
SELECT_QUERY | 'select_query' | Select |
SELECT_QUERY_COLUMNS | 'select_query.columns' | Select's column list |
SELECT_QUERY_FROM | 'select_query.from' | Select's from clause |
SELECT_QUERY_JOIN | 'select_query.join' | Select's join list |
SELECT_QUERY_GROUPBY | 'select_query.groupby' | Select's group by clause |
SELECT_QUERY_ORDERBY | 'select_query.orderby' | Select's / StringAgg's order by clause |
INSERT_QUERY | 'insert_query' | Insert |
INSERT_QUERY_COLUMNS | 'insert_query.columns' | Insert's column list |
INSERT_QUERY_VALUES | 'insert_query.values' | Insert's values list |
UPDATE_QUERY | 'update_query' | Update |
UPDATE_QUERY_VALUES | 'update_query.values' | Update's set list |
DELETE_QUERY | 'delete_query' | Delete |
UNION_QUERY | 'union_query' | Union |
FIELD_NAME | 'field_name' | Field |
GROUP_COLUMN | 'group_column' | GroupColumn |
ORDER_COLUMN | 'order_column' | OrderColumn |
RETURNING_COLUMN | 'returning_column' | ReturningColumn |
TABLE_NAME | 'table_name' | TableName |
JOIN | 'join' | Join and its subclasses |
JOIN_CONDITIONS | 'join_conditions' | A join's on clause |
RAW | 'raw' | Raw |
CASE_STATEMENT | 'case_expression' | Case |
COALESCE_STATEMENT | 'coalesce_expression' | Coalesce |
LOWER_STATEMENT | 'lower_expression' | Lower |
UPPER_STATEMENT | 'upper_expression' | Upper |
MAX_STATEMENT | 'max_expression' | Max |
MIN_STATEMENT | 'min_expression' | Min |
COUNT_STATEMENT | 'count_expression' | Count |
CONDITIONS_BLOCK | 'conditions_block' | A where-style conditions block |
COMPARISON_EXPRESSION | 'comparison_expression' | CompOperator subclasses (Eq, Gt, Like, ...) |
LOGICAL_EXPRESSION | 'logical_expression' | LogicalOperator subclasses (And, Or) |
NEGATIVE_EXPRESSION | 'negative_expression' | Not |
RETURNING_BLOCK | 'returning_block' | ReturningQuery's returning clause |
DATE_VALUE | 'date_value' | A Date literal encountered during serialization |
STRING_VALUE | 'string_value' | A string literal |
BOOLEAN_VALUE | 'boolean_value' | A boolean literal |
NUMBER_VALUE | 'number_value' | A number literal |
EXTERNAL_PARAMETER | 'external_parameter' | Param |
ARRAY | 'array' | An array literal |
SEQUENCE_GETTER_STATEMENT | 'sequence_getter_statement' | Sequence |
STRINGAGG_STATEMENT | 'String_agg_statement' | StringAgg |