- What is guanguans/laravel-soar used for?
- It is a Laravel wrapper around Xiaomi's SOAR SQL optimizer and rewriter. It provides SQL health scores, index and performance suggestions, and query rewriting advice through Artisan commands, a facade, and query logging. Use it as an offline SQL quality and review tool for development, CI, and internal diagnostics, not as a runtime query optimizer.
- How do I install laravel-soar in a Laravel application?
- Install the package with Composer, publish its configuration file, and configure the path to the external SOAR binary. You can then run the provided Artisan commands or call the facade from jobs, tests, or internal tooling. Verify the package's Composer constraints against your Laravel and PHP versions before adopting it.
- Does laravel-soar rewrite Eloquent queries automatically in production?
- No. The rewrite feature should be treated as generated advice, not automatic production query mutation. It is not a transparent Eloquent or query-builder rewriter that changes queries at runtime. Review and apply its recommendations manually or through your own controlled process.
- Which Laravel and PHP versions does laravel-soar support?
- The package is Laravel-native, but exact Laravel and PHP support depends on its Composer constraints. Check the package's composer.json and test matrix against your target application matrix before installing. Pin compatible versions and verify behavior in a branch or staging environment.
- Which SQL dialects can laravel-soar analyze?
- It fits best with MySQL-compatible workloads because it wraps Xiaomi's SOAR tool. The underlying SOAR binary ultimately determines dialect and syntax support. Verify findings against the exact MySQL version and SQL syntax used by your application.
- How should I install and pin the SOAR binary for CI and local development?
- The SOAR executable is external to the Laravel package and must be installed separately on each developer machine and CI runner. Pin a specific binary version, document the installation path, and ensure OS and architecture parity across macOS, Linux, and Windows where applicable. Verify the binary's own license and support model separately from the MIT-licensed wrapper.
- Can laravel-soar fail a CI build on high-severity SQL findings?
- Yes, but start in report-only mode to baseline findings and measure false positives. Define severity thresholds and then make selected checks blocking for agreed query classes. Keep an explicit disable or override path for emergencies and for queries that are intentionally exempt.
- Is it safe to run laravel-soar synchronously in a production request?
- Avoid synchronous use in request and response paths. Analysis is process-based and CPU and memory intensive per invocation, so it scales well for batch CI and periodic review rather than high-QPS runtime checks. If you need programmatic use, wrap it in queued jobs with strict timeouts and caching by SQL fingerprint.
- What are good alternatives to laravel-soar for SQL review?
- Alternatives include running the Xiaomi SOAR CLI directly, using MySQL EXPLAIN and slow query logs, or adopting other SQL linting and review tools in CI. The Laravel package mainly adds Laravel-native commands, configuration, facades, and query logging around the external SOAR binary. Choose based on whether you need Laravel integration or a standalone SQL analysis workflow.
- Who maintains laravel-soar and what maintenance risks should I plan for?
- It is a community package with community-level support rather than a vendor SLA. You must manage two upgrade streams: the Laravel wrapper and the external SOAR binary. Plan ownership for binary packaging, CI image updates, output compatibility, false-positive triage, and internal runbooks. Verify the underlying SOAR license and support path separately before relying on it as a blocking gate.