Admin CLI app for performing administrative tasks such as applying indexes

[satran004]

Overview

During the start of the sync process with public networks like mainnet, preprod, etc., the default applications of yaci-store remove optional indexes (indexes required for read operations) from the database. These indexes need to be applied again after the sync reaches the tip. Currently, this is a manual process where the user must get the index SQL file from GitHub and apply it to the yaci-store database.

Solution

We can introduce a new CLI application, "admin-cli," to be distributed as part of the regular release. This CLI process can read the existing yaci-store configuration file to obtain the database connection details. It will support different commands for various kinds of administrative work.

Initially, it will include an "apply-index" command that can check the existing yaci-store tables and apply indexes if required.

In future releases, we can add additional tasks like creating application configurations for custom scope indexers, etc.

Benefits

• Using this CLI app, the user can avoid manually copying the SQL file to apply indexes.
• We won't need to maintain optional indexes in multiple applications like yaci-store-all or yaci-store-aggregation-app. The CLI app can analyze existing tables in the database and apply indexes accordingly, allowing us to maintain only one copy of the SQL file to apply indexes.