TagoIO SDK for JavaScript and TypeScript
    Preparing search index...

    Interface SQLCreateInfo

    interface SQLCreateInfo {
        active?: boolean;
        cache_enabled?: boolean;
        cache_ttl_seconds?: number;
        description?: string;
        name: string;
        params?: SQLParam[];
        query: string;
        rate_limit_rpm?: number;
        tags?: TagsObj[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    active? cache_enabled? cache_ttl_seconds? description? name params? query rate_limit_rpm? tags?

    Properties

    active?: boolean

    An inactive query cannot be executed. Default true.

    cache_enabled?: boolean

    Enables the result cache on execute. Default false.

    cache_ttl_seconds?: number

    Clamped to 0..=86400 (24h). A TTL of 0 disables caching.

    description?: string

    Optional, up to 1024 chars.

    name: string

    Required, 1..=64 chars.

    params?: SQLParam[]

    Positional defaults; must cover exactly the placeholders the query uses ($1..$N).

    query: string

    The TagoSQL query. Parsed and validated against your plan at save time.

    rate_limit_rpm?: number

    Per-query soft rate cap; rejected at save time if above the plan's hard cap.

    tags?: TagsObj[]

    Settings

    Member Visibility

    On This Page

    Properties