comphp/dbengine

Provides unified access to database engines regardless of the underlying connectivity

Maintainers

Details

github.com/commonphp/dbengine

Source

Issues

Installs: 4

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 0

Forks: 0

Open Issues: 0

v0.1 2024-02-17 02:28 UTC

Requires

Requires (Dev)

MIT e5bb3d5c7590fb57759f86f123b232f79a1094ce

  • timothy.mcclatchey <timothy.woop@commonphp.org>

This package is auto-updated.

Last update: 2024-05-17 03:20:11 UTC

README

CommonPHP's Database Library is a toolkit for database interaction and management in PHP applications. It offers a comprehensive set of features for connecting to databases, objectifying queries, executing them, and handling results efficiently.

Features

  • Connection Management: Simplifies the setup and management of database connections.
  • Query Builder: Offers a fluent interface for constructing SQL queries including parameter management and dynamic query parts (SELECT * FROM {0} WHERE id=@id)
  • Type Conversion: Provides an extensible system for converting between PHP types and database types.
  • Exception Handling: Includes detailed exceptions for precise error handling in database operations.

Components

The library is structured into several key components, including the Connection Manager, Query Builder, and various type converters. It also defines interfaces and contracts for extendability, alongside a suite of exceptions for robust error management.

Requirements

Requires PHP 8.3 or newer and is built to integrate seamlessly with other CommonPHP libraries.

Installation

Use Composer to install:

composer require comphp/dbengine

Basic Usage

Initialize the Connection Manager and use the Query Builder to create and execute database queries. Type converters can be used to handle complex data types, and exceptions are thrown for any errors encountered during database operations.

Extending the Library

Custom type converters can be implemented by adhering to the provided interfaces, enhancing the library's flexibility and adaptability to different database systems and requirements.

Documentation

For detailed examples and usage instructions, refer to the source code and PHPDoc comments within each component.

Contributing

Contributions are welcome, following the contribution guidelines provided in the repository.

Testing

The library includes unit tests using PHPUnit. Instructions for running tests are provided, encouraging contributions to maintain high test coverage.

License

Licensed under the MIT License, promoting open and permissive usage in projects.