ORM
  • Introduction
  • Basics of Usage
    • Connecting to the Database
    • Creating a Model
    • Simple Queries
  • Configuration
  • Core Features
    • Models
    • CRUD Operations (Create, Read, Update, Delete): examples
    • Relationships
    • Transactions
  • Advanced Usage
    • Data Definition Language
    • Indexes
    • Triggers
    • Caching
  • Examples and templates
  • Security
    • Query parameterization and protection against SQL injections
    • Logging
    • Monitoring
    • Sanitization
  • ORM-CLI
    • Installing
    • Commands and usage
  • System architecture and implementation
    • Support of various databases
      • Implementation using a pattern strategy
      • Implementation using generics
      • Implementation using metaprogramming
    • Decorators
    • Migrations
      • Assignment of id in Tables and Columns
      • Assigning IDs to indexes and triggers
      • Working with migrations in ORM-CLI
        • Implementation of a pattern command for migration
    • QueryBuilder
    • Caching
    • File structure
  • API
    • Decorators
      • Column
      • ComputedColumn
      • Index
      • ForeignKey
      • PrimaryGeneratedColumn
      • Relations
      • Table
      • Trigger
      • Types decorators
        • Integer
        • Numeric
        • Float
        • Boolean
        • String
    • DDL
    • QueryBuilder
    • Additional API
Powered by GitBook
On this page
  1. API
  2. Decorators

Index

Index Decorator

The Index decorator is used to create indexes in the database. It takes an IndexDecoratorInterface object as a parameter.

Parameters of IndexDecoratorInterface

  • indexName:

    • Type: string

    • Description: The name of the index.

  • columns:

    • Type: string[]

    • Description: An array of column names that will be included in the index.

  • tableName:

    • Type: string

    • Description: The name of the table to which the index belongs. If not specified, the index is applied to the current table.

  • options:

    • Type: IndexOptionsDecoratorInterface

    • Description: An object containing additional options for configuring the index.

PreviousComputedColumnNextForeignKey

Last updated 7 months ago