|
|
||
|---|---|---|
| src | ||
| tests | ||
| .gitattributes | ||
| .gitignore | ||
| composer.json | ||
| composer.lock | ||
| LICENSE | ||
| 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
composer require bit-badger/pdo-document
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::Noneis the default; no IDs will be generatedAutoId::Numberwill assign max-ID-plus-one to documents with an ID of 0AutoId::UUIDwill generate a v4 UUID for documents with an emptystringIDAutoId::RandomStringwill generate a string of letters and numbers for documents with an emptystringID;Configuration::$idStringLengthcontrols 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.