taeluf/big-db

A feature-rich (but somewhat minimalist) database layer for php, with ORM, migrations, and more.

v1.0.x-dev 2024-01-30 15:35 UTC

Requires

• taeluf/lildb: v0.1.x-dev

Requires (Dev)

• taeluf/cli: v0.1.x-dev
• taeluf/code-scrawl: v0.8.x-dev
• taeluf/tester: v0.3.x-dev

Suggests

• taeluf/cli: Required for bigdb cli, for easy access to your database

MIT

• Taeluf

README

BigDb

PHP Database Layer with ORM, migrations, stored sql statements, cli, and multi-database support.

NOTICE: cli bin/bigdb is undergoing major changes & is currently broken.
NOTICE: BigDb is mostly stable, but is still under development & much may change.

Documentation

• Use a BigDb Library
  • Cli - work with your database from the command line
  • Querying - Simple CRUD operations and SQL execution.
  • Use ORMs - Query for orms & use them to insert, update, and delete rows.
  • Run Migrations - vendor/bin/bigdb migrate [cur_ver] [target_ver]
  • Database Setup - Setup one or multiple database libraries
• Create a BigDb Library
  • todo Project Structure - Where to put files, and a basic overview.
  • todo BigDb Subclass - Subclass BigDb modify internals and share features across orms.
  • todo Create ORMs - Represent database rows with php objects
  • todo Migrations - Upgrade & Downgrade your database schema
  • todo Store Sql - Store SQL, execute them, query for rows, query for ORMs
• Bugs/Issues - Known issues & quirks
• Development / Other
  • todo Test Your ORMs - Simplified testing by defining data.
  • Changelog
  • Status Notes
  • License
  • API Documentation - Breakdown of all the classes, their properties, and methods.
  • Sample BigDb Library - A full BigDb library used by our tests. See BigDb Tests for an example of how this library is used.

Install

composer require taeluf/big-db v1.0.x-dev   

or in your composer.json

{"require":{ "taeluf/big-db": "v1.0.x-dev"}}  

Overview | Usage

TODO usage overview docs

Overview | Create a Database Library

TODO library overview docs