OpenSearchAdapter/src/Indices/IndexManagerInterface.php at ca83c3f98553d5af772d2c99499cacb0c9a2b8fc · DirectoryTree/OpenSearchAdapter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?php

namespace DirectoryTree\OpenSearchAdapter\Indices;

/**
 * Manages OpenSearch indices, mappings, settings, and aliases.
 */
interface IndexManagerInterface
{
    /**
     * Open the given index.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/open-index/
     */
    public function open(string $index): static;

    /**
     * Close the given index.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/close-index/
     */
    public function close(string $index): static;

    /**
     * Determine if the given index exists.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/exists/
     */
    public function exists(string $index): bool;

    /**
     * Create an index from the given blueprint.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/create-index/
     */
    public function create(IndexBlueprint $index): static;

    /**
     * Update the mapping for the given index.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/put-mapping/
     */
    public function putMapping(string $index, Mapping $mapping): static;

    /**
     * Update the settings for the given index.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/update-settings/
     */
    public function putSettings(string $index, Settings $settings): static;

    /**
     * Delete the given index.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/delete-index/
     */
    public function delete(string $index): static;

    /**
     * Get the aliases for the given index.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/alias/
     *
     * @return array<string, Alias>
     */
    public function getAliases(string $index): array;

    /**
     * Create or update an alias for the given index.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/alias/
     */
    public function putAlias(string $index, Alias $alias): static;

    /**
     * Delete the given alias from the index.
     *
     * @see https://docs.opensearch.org/latest/api-reference/index-apis/alias/
     */
    public function deleteAlias(string $index, string $aliasName): static;

    /**
     * Atomically apply multiple alias actions.
     *
     * @see https://docs.opensearch.org/latest/api-reference/alias/aliases-api/
     */
    public function updateAliases(AliasActions $actions): static;
}