Download the PHP package tourze/doctrine-indexed-bundle without Composer

Doctrine Indexed Bundle

中文

A Symfony bundle that enhances Doctrine ORM with automatic index management.

Features

• Automatically adds indexes to specified entity properties
• Supports regular, fulltext, and unique indexes
• Smart index naming strategy, automatically handles long table names
• Attribute-based configuration (PHP 8 attributes), no extra config files
• Zero configuration required, works out-of-the-box

Requirements

• PHP 8.1 or higher
• Symfony 6.4 or higher
• Doctrine Bundle 2.13 or higher

Installation

Usage

1. Register the bundle in config/bundles.php:

2. Use attributes to mark entity fields that require indexes:

Configuration

This bundle requires no configuration and works out-of-the-box. However, you can customize index names by providing a name parameter to the attributes:

Index Naming Convention

The bundle automatically generates index names as follows:

• Regular index: {table_name}_idx_{column_name}
• Fulltext index: {table_name}_fulltext_{column_name}
• Unique constraint: {table_name}_unique_{column_name}

If the generated name exceeds the maximum length (64 characters), the bundle will use MD5 hashing to create a shorter name while maintaining uniqueness.

Advanced Usage

Custom Index Names

You can specify custom names for indexes:

Multiple Attributes

You can combine different index types on the same entity:

How It Works

• Listens to Doctrine's loadClassMetadata event and scans entity properties
• Checks for IndexColumn, FulltextColumn, or UniqueColumn attributes on properties
• Automatically adds the corresponding index to the entity field
• Naming strategy ensures compatibility with DBMS index name length limits

Contributing

Feel free to submit issues and pull requests to help improve this bundle.

License

MIT License