Interface ViewOptions

The view name in the database. Defaults to the class name (snake_cased) if not provided.

What the view selects, as query options rather than SQL — the preferred form, and the only one that is portable across dialects:

@View({ name: 'active_users', definition: { from: 'users', where: { status: 'active' } } })
class ActiveUser extends Model {}
Copy

Compiling a definition needs a dialect, so pass one to getSQL() or use ViewRegistry.createView(prorm, Target), which takes it from the instance.

The SELECT statement that defines the view.

A function that returns the SELECT statement. Useful when the query depends on runtime values or other model table names.

Optional schema prefix (e.g. 'public' for PostgreSQL).

If true, generates CREATE OR REPLACE VIEW. Default: false.

PostgreSQL only: if true, the view will be marked WITH CHECK OPTION.

Target dialect for DDL generation. One of: 'mysql' | 'mariadb' | 'postgres' | 'sqlite' Defaults to 'mysql'.

PostgreSQL only: if true generates a MATERIALIZED VIEW.