prorm API Reference
    Preparing search index...

    Interface EngineOptions

    interface EngineOptions {
        engine?: string;
        mergeTreeEngine?: MergeTreeEngineConfig;
        orderBy?: string | string[];
        partitionBy?: string;
        ttl?: string;
        projections?: Record<string, ProjectionDefinition>;
    }
    Index
    engine? mergeTreeEngine? orderBy? partitionBy? ttl? projections?
    engine?: string

    MySQL/MariaDB-style raw engine name, e.g. 'InnoDB', 'MyISAM'. Ignored by dialects that use mergeTreeEngine instead (ClickHouse).

    mergeTreeEngine?: MergeTreeEngineConfig

    ClickHouse MergeTree-family engine configuration (see MergeTreeEngineConfig in src/dialects/clickhouse/index.ts). Takes precedence over engine when both are supplied, since it gets the engine's required-column validation (e.g. CollapsingMergeTree's Sign Int8 column) a raw engine string cannot.

    orderBy?: string | string[]

    ClickHouse ORDER BY clause (mandatory for MergeTree-family engines - ClickHouse's stand-in for a traditional primary key, controlling physical sort/merge order). Either a raw SQL fragment or a column list.

    partitionBy?: string

    ClickHouse PARTITION BY clause.

    ttl?: string

    ClickHouse table-level TTL expression, e.g. 'createdAt + INTERVAL 30 DAY' or "createdAt + INTERVAL 30 DAY TO VOLUME 'cold'".

    projections?: Record<string, ProjectionDefinition>

    ClickHouse MergeTree projections to create inline at CREATE TABLE time, keyed by projection name.

    Settings
    Member Visibility

    On This Page
    Properties