---
url: https://docs.juniper.bot/message-templates/types/storage/guild-index-entry.md
description: Тип данных GuildIndexEntry, используемый в шаблонном движке JuniperBot.
---

[Число]: /message-templates/types/index#literals

[Строка]: /message-templates/types/index#literals

[Логический]: /message-templates/types/index#literals

[Список]: /message-templates/types/index#lists

[Карта]: /message-templates/types/index#maps

[DateTime]: /message-templates/types/index#datetime

[TwitchChannel]: /message-templates/types/subscriptions/twitch#twitch-channel

[TwitchStream]: /message-templates/types/subscriptions/twitch#twitch-stream

[TwitchGame]: /message-templates/types/subscriptions/twitch#twitch-game

[YouTubeChannel]: /message-templates/types/subscriptions/youtube#youtube-channel

[YouTubeVideo]: /message-templates/types/subscriptions/youtube#youtube-video

[VkWallPost]: /message-templates/types/subscriptions/vk#vkwallpost

[Rank]: /message-templates/types/discord/rank

[Guild]: /message-templates/types/discord/guild

[Member]: /message-templates/types/discord/member

[Role]: /message-templates/types/discord/role

[Message]: /message-templates/types/discord/message

[Attachment]: /message-templates/types/discord/attachment

[Embed]: /message-templates/types/discord/embed

[Activity]: /message-templates/types/discord/activity

[MemberVoiceState]: /message-templates/types/discord/member-voice-state

[MemberPrimaryGuild]: /message-templates/types/discord/member-primary-guild

[MenuBuilder]: /message-templates/types/discord/menu-builder

[UserFlag]: /message-templates/types/discord/user-flag

[Permission]: /message-templates/types/discord/permission

[Category]: /message-templates/types/discord/category

[TextChannel]: /message-templates/types/discord/text-channel

[VoiceChannel]: /message-templates/types/discord/voice-channel

[NewsChannel]: /message-templates/types/discord/news-channel

[StageChannel]: /message-templates/types/discord/stage-channel

[ForumChannel]: /message-templates/types/discord/forum-channel

[MediaChannel]: /message-templates/types/discord/media-channel

[ThreadChannel]: /message-templates/types/discord/thread-channel

[Page]: /message-templates/types/storage/page

[GuildIndex]: /message-templates/types/storage/guild-index

[GuildIndexEntry]: /message-templates/types/storage/guild-index-entry

[GuildIndexes]: /message-templates/types/storage/guild-indexes

[MemberAttribute]: /message-templates/types/storage/member-attribute

[MemberAttributes]: /message-templates/types/storage/member-attributes

[Arguments]: /message-templates/types/custom-commands/arguments

[Parameters]: /message-templates/types/custom-commands/parameters

[Component]: /message-templates/types/custom-commands/component

[Modal]: /message-templates/types/custom-commands/modal

# GuildIndexEntry

Этот тип данных описывает конкретную запись [индекса](guild-index).

::: info Подробная информация
Для более подробной информации об индексах сервера и их использовании обратитесь к статье
[Индексы сервера](../../persistence/guild-indexes).
:::

## Свойства { #properties }

| Свойство    | Тип        | Описание                                          |
|:------------|:-----------|:--------------------------------------------------|
| `key`       | \[Строка]   | Ключ записи                                       |
| `value`     | \[Число]    | Значение записи                                   |
| `metadata`  | \[Строка]   | Метаданные записи                                 |
| `indexName` | \[Строка]   | Название индекса, к которому относится эта запись |
| `updatedAt` | \[DateTime] | Дата последнего обновления записи                 |

## Методы { #methods }

### `update(Значение, Метаданные)` { #method-update .template-method }

::: tabs

\== Описание | mdi-text

Обновляет значение записи.

Возвращает это же значение.

**Возвращаемые типы:** \[Число]

\== Параметры | mdi-code-parentheses

| Параметр     | Тип      | Описание                                                                                                                                                                                                         |
|:-------------|:---------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `Значение`   | \[Число]  | Новое значение записи                                                                                                                                                                                            |
| `Метаданные` | \[Строка] | Новые метаданные записи. Здесь можно хранить какую-либо дополнительную информацию о записи до 500 символов.Данный параметр опционален и если не указан, останется предыдущее значение если оно есть. |

\== Примеры | mdi-code-block-braces

```template
{% do guild.getIndex('myIndex').get('entryKey').update(123) %}
```

```template
{% do guild.indexes.myIndex.entryKey.update(123) %}
```

:::

### `increment(Число)`  { #method-increment .template-method }

::: tabs

\== Описание | mdi-text

Увеличивает значение записи на указанное число. Возвращает новое значение.

**Возвращаемые типы:** \[Число]

\== Параметры | mdi-code-parentheses

| Параметр | Тип     | Описание                                     |
|:---------|:--------|:---------------------------------------------|
| `Число`  | \[Число] | Увеличить значение записи на указанное число |

\== Примеры | mdi-code-block-braces

```template
{% do guild.getIndex('myIndex').get('entryKey').increment(1) %}
```

```template
{% do guild.indexes.myIndex.entryKey.increment(1) %}
```

:::

### `decrement(Число)`  { #method-decrement .template-method }

::: tabs

\== Описание | mdi-text

Уменьшает значение записи на указанное число. Возвращает новое значение.

**Возвращаемые типы:** \[Число]

\== Параметры | mdi-code-parentheses

| Параметр | Тип     | Описание                                     |
|:---------|:--------|:---------------------------------------------|
| `Число`  | \[Число] | Уменьшить значение записи на указанное число |

\== Примеры | mdi-code-block-braces

```template
{% do guild.getIndex('myIndex').get('entryKey').decrement(1) %}
```

```template
{% do guild.indexes.myIndex.entryKey.decrement(1) %}
```

:::

### `clear()`  { #method-clear .template-method }

::: tabs

\== Описание | mdi-text

Очищает запись и удаляет из базы данных.

\== Примеры | mdi-code-block-braces

```template
{% do guild.getIndex('myIndex').get('entryKey').clear() %}
```

```template
{% do guild.indexes.myIndex.entryKey.clear() %}
```

:::