FAQ
Frequently Asked Questions
Section titled “Frequently Asked Questions”How do I get started?
Section titled “How do I get started?”Start by messaging @index_inspector_bot on Telegram and sending the /start command. Then, use /init to set up your first project.
Is my code safe?
Section titled “Is my code safe?”Yes. Index Inspector only reads the source code paths you specify. We do not store your code permanently; it is analyzed in memory and immediately discarded after the scan report is generated.
Does the bot need database access?
Section titled “Does the bot need database access?”No. Index Inspector performs static analysis on your code. It identifies potential performance issues by looking at the queries written in your code, rather than connecting directly to your live database.
Why did my scan fail?
Section titled “Why did my scan fail?”Common reasons for scan failure include:
- Invalid Git URL or lack of permissions.
- The specified branch does not exist.
- No database queries were found in the provided scan paths.
Check your project settings with
/update_projectif issues persist.
Can I use this in a team group?
Section titled “Can I use this in a team group?”Absolutely! Invite the bot to your group and use /chat_id to get the group’s ID. You can then manage projects that notify the entire group when a scan is complete.
What databases are supported?
Section titled “What databases are supported?”Currently, we support PostgreSQL and MySQL. Support for MongoDB and SQLite is in our development roadmap.
How are the recommendations calculated?
Section titled “How are the recommendations calculated?”We analyze your queries for WHERE clauses, JOIN conditions, and ORDER BY statements. We then extract your existing indexed columns from your migration files (using the Migration Scan Paths you provide) to ensure we only suggest new indexes that would provide additional performance gains.
Are there usage limits?
Section titled “Are there usage limits?”Free users can run up to 5 scans per month. For higher limits, please contact our support team.
How do I report a bug?
Section titled “How do I report a bug?”If you encounter any issues, please send a message to our support chat or open an issue on our GitHub repository.