# Атрибут `PrimaryKey`

Атрибут `PrimaryKey` предназначен для явного указания, что определенное поле в модели данных является первичным ключом.
Первичный ключ служит уникальной ссылкой на каждую запись в таблице и используется для однозначной идентификации данных.

## Основное назначение

Атрибут используется для четкого указания того, что данное поле выступает в роли первичного ключа, который однозначно
идентифицирует каждую запись в базе данных. Такое выделение помогает оптимизировать производительность и поддерживает
целостность данных.

## Пример использования атрибута

Допустим, у вас есть модель данных, описывающая пользователя, и вы хотите явно указать, что поле `id` является первичным
ключом:

```php
use goodboyalex\php_db_components_pack\attributes\PrimaryKey;

final class User
{
    #[PrimaryKey]
    private int $Id;

    // Остальные поля и геттеры/сеттеры...
}
```

В данном примере атрибут `#[PrimaryKey]` применяется к полю `$Id`, явно указывая, что оно является первичным ключом.

## Пространство имён

Атрибут объявлен в пространстве имён:

```php
namespace goodboyalex\php_db_components_pack\attributes;
```

## Версии и автор

- **Автор**: Александр Бабаев
- **Версия**: 1.0
- **Дата выпуска**: с версии 1.0

## Особенности

- **Применяется только к полям (properties).** Атрибут используется исключительно для аннотирования полей классов,
  которые соответствуют столбцам базы данных.

## Когда использовать атрибут?

Атрибут `PrimaryKey` рекомендуется использовать, когда необходимо явно указать поле, служащее первичным ключом для
таблицы. Это полезно для правильной индексации данных и эффективной работы с ними.

[На главную](../../index.md)