Download the PHP package cadfael/cadfael without Composer
On this page you can find all versions of the php package cadfael/cadfael. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cadfael/cadfael
More information about cadfael/cadfael
Files in cadfael/cadfael
Package cadfael
Short Description Tool for performing static analysis on databases.
License GPL-3.0-or-later
Informations about the package cadfael
Cadfael
Artwork Commissioned and Copyright by Ben Fleuter
Cadfael is static analysis tool to provide critiquing for MySQL databases.
Documentation
All the checks and the reasoning, considerations and remediations for them are documented in the wiki.
Installation
There are a couple options for installation depending on your personal preference.
Phar
You can grab the phar file from the most recent release. This ensures you won't have any dependency conflicts.
Global
If you'd like Cadfael available anywhere on your system, you can install it globally.
Ensure that your global composer vendor bin folder is set in your path. You may need to add this to your .bashrc
file.
Local
If you want to use it within a specific project you can install it with:
The path to the executable will be in ./vendor/bin/
.
Usage
Advanced Usage
You can also include the --performance_schema
flag if you wish to run checks against the performance_schema schema which collect analytics about your server since the last time it was restarted. This is particularly useful if you want to see how your database is being used and detect issues related to queries, access of tables and heavy or badly optimized queries.
For meaningful results you should run this against the database that is being used in production otherwise you'll only be checking against the metrics collected in your development environment. BUT FIRST always speak to your DBA/Security people first before run random tools from the internet against your production database.
Environmental Variables
You may want to pass parameters to Cadfael via the environment (especially if you want to integrate it into a build pipeline or want to manage secrets securely).
The following environmental variables can be used instead of parameters to the binary:
- MYSQL_HOST
- MYSQL_PORT
- MYSQL_DATABASE
- MYSQL_USER
- MYSQL_PASSWORD
You can test this from the command line like this:
Output
Take it for a spin
You can use resources/sample.sql
to create a test database of tables to see some examples of Cadfael's checks.
Or you can try testing Cadfael on a few open data sources
WARNING: These are not always online and available.
Contributions
This project adopts the Contributor Covenant Code of Conduct for contributions.
Feel free to open an issue if you find any problems or have any suggestions or requests.
All versions of cadfael with dependencies
doctrine/dbal Version ^2.10
symfony/console Version ^5.0
monolog/monolog Version ^2.1
greenlion/php-sql-parser Version ^4.5
ext-json Version *