Skip to main content
Version: Next

raw

Callable

  • Creates raw SQL query fragment that can be assigned to a property or part of a filter. This fragment is represented by RawQueryFragment class instance that can be serialized to a string, so it can be used both as an object value and key. When serialized, the fragment key gets cached and only such cached key will be recognized by the ORM. This adds a runtime safety to the raw query fragments.

    raw() helper is required since v6 to use a raw fragment in your query, both through EntityManager and QueryBuilder.

    // as a value
    await em.find(User, { time: raw('now()') });

    // as a key
    await em.find(User, { [raw('lower(name)')]: name.toLowerCase() });

    // value can be empty array
    await em.find(User, { [raw('(select 1 = 1)')]: [] });

    The raw helper supports several signatures, you can pass in a callback that receives the current property alias:

    await em.find(User, { [raw(alias => `lower(${alias}.name)`)]: name.toLowerCase() });

    You can also use the sql tagged template function, which works the same, but supports only the simple string signature:

    await em.find(User, { [sql`lower(name)`]: name.toLowerCase() });

    When using inside filters, you might have to use a callback signature to create new raw instance for every filter usage.

    @Filter({ name: 'long', cond: () => ({ [raw('length(perex)')]: { $gt: 10000 } }) })

    Parameters

    Returns R