bit-badger/pdo-document
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 16 Wiki Activity
Bit Badger Documents PHP implementation with PDO
25 Commits 2 Branches 16 Tags 1.1 MiB
PHP 100%
v2.0.0-rc1
Go to file
Daniel J. Summers 486028bd40 v2 RC1 Changes (#7) 
- Changes `items` and `hasItems` on `DocumentList` to be properties
- Updates dependent option/result library, which contains similar changes

Reviewed-on: #7
2024-10-02 01:37:08 +00:00
src v2 RC1 Changes (#7) 2024-10-02 01:37:08 +00:00
tests v2 RC1 Changes (#7) 2024-10-02 01:37:08 +00:00
.gitattributes Exclude tests and other files 2024-06-09 20:50:43 -04:00
.gitignore Add PostgreSQL Support (#3) 2024-06-21 13:46:41 +00:00
composer.json v2 RC1 Changes (#7) 2024-10-02 01:37:08 +00:00
composer.lock v2 RC1 Changes (#7) 2024-10-02 01:37:08 +00:00
LICENSE Initial commit 2024-06-03 23:07:15 +00:00
README.md v2 RC1 Changes (#7) 2024-10-02 01:37:08 +00:00

README.md

PDODocument

This library allows SQLite and PostgreSQL to be treated as document databases. It is a PHP implementation of the .NET BitBadger.Documents library.

Add via Composer

Static Badge     Packagist Version

composer require bit-badger/pdo-document

For the v1 series, the DocumentList type's members hasItems and items are functions; in the v2 series, they are properties. Additionally, the Option and Result types included in the project have a similar difference; see the v1 README for PHP 8.2 or 8.3 and the v2 README for PHP 8.4. Both versions are supported; the v1 / v2 distinction helps composer make the right choice based on the target PHP version of your project.

Configuration

Connection Details

The PDO data source name must be provided via Configuration::useDSN(). Configuration also has $username, $password, and $options variables that will be used to construct the PDO object it will use for data access.

Document Identifiers

Each document must have a unique identifier. By default, the library assumes that this is a property or array key named id, but this can be controlled by setting Configuration::$idField. Once documents exist, this should not be changed.

IDs can be generated automatically on insert. The AutoId enumeration has 4 values:

  • AutoId::None is the default; no IDs will be generated
  • AutoId::Number will assign max-ID-plus-one to documents with an ID of 0
  • AutoId::UUID will generate a v4 UUID for documents with an empty string ID
  • AutoId::RandomString will generate a string of letters and numbers for documents with an empty string ID; Configuration::$idStringLength controls the length of the generated string, and defaults to 16 characters

In all generated scenarios, if the ID value is not 0 or blank, that ID will be used instead of a generated one.

Usage

Full documentation is available on the project site.