Skip to content

The lightweight PHP database framework to accelerate the development.

License

Notifications You must be signed in to change notification settings

catfan/Medoo

Repository files navigation

Build StatusTotal DownloadsLatest Stable VersionLicenseBackers on Open CollectiveSponsors on Open Collective

The lightweight PHP database framework to accelerate development.

Features

  • Lightweight - Single-file framework with minimal dependencies.

  • Easy - Simple and intuitive API for quick integration.

  • Powerful - Supports complex SQL queries, data mapping, and SQL injection prevention.

  • Compatible - Works with MySQL, MariaDB, PostgreSQL, SQLite, MSSQL, Oracle, Sybase, and more.

  • Friendly - Integrates seamlessly with Laravel, CodeIgniter, Yii, Slim, and other PHP frameworks.

  • Free - Licensed under MIT, free to use for any purpose.

Requirements

  • PHP 7.3 or later
  • PDO extension enabled

Get Started

Install via composer

Add Medoo to the composer.json configuration file.

$ composer require catfan/medoo

Then update Composer

$ composer update
// Require Composer's autoloaderrequire'vendor/autoload.php'; // Import Medoo namespaceuseMedoo\Medoo; // Initialize database connection$database = newMedoo([ 'type' => 'mysql', 'host' => 'localhost', 'database' => 'name', 'username' => 'your_username', 'password' => 'your_password' ]); // Insert data$database->insert('account', [ 'user_name' => 'foo', 'email' => '[email protected]' ]); // Retrieve data$data = $database->select('account', [ 'user_name', 'email' ], [ 'user_id' => 50 ]); echojson_encode($data); // [{// "user_name" : "foo",// "email" : "[email protected]",// }]

Contribution Guidelines

Before submitting a pull request, ensure compatibility with multiple database engines and include unit tests when possible.

Testing & Code Style

  • Run phpunit tests to execute unit tests.
  • Use php-cs-fixer fix to enforce code style consistency.

Commit Message Format

Each commit should begin with a tag indicating the type of change:

  • [fix] for bug fixes
  • [feature] for new features
  • [update] for improvements

Keep contributions simple and well-documented.

License

Medoo is released under the MIT License.

Links

Support Our Other Product

Gear Browser - Web Browser for Geek

Gear Browser