ColumnIndex() function

Declares a plain btree index on a model column.

Signature:

export declare function ColumnIndex(target: any, propertyName: string, propertyDescriptor?: PropertyDescriptor): void;

Parameters

Parameter

Type

Description

target

any

Model prototype the property belongs to.

propertyName

string

Column to index.

propertyDescriptor

PropertyDescriptor

(Optional) Unused; present because a decorator receives it.

Returns:

void

Remarks

The bare form of the decorator, equivalent to calling it with no options. Use the factory form for anything Postgres-specific.

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.