> For the complete documentation index, see [llms.txt](https://myroslavs-organization.gitbook.io/orm/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://myroslavs-organization.gitbook.io/orm/api/decorators/index.md).

# 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://myroslavs-organization.gitbook.io/orm/api/decorators/index.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.