Represent how a relational database connection must be implemented.
__construct(string $details)
Create a new database handler and logically connect the given database.
| string | $details | the connection string |
the error occurred while connecting to the database
given details are invalid
create(string $collection, array|\Gishiki\Algorithms\Collections\CollectionInterface $data) : mixed
Write data to the database on the given collection/table.
| string | $collection | the name of the collection that will hold the data |
| array|\Gishiki\Algorithms\Collections\CollectionInterface | $data | the collection of data to be written |
the error occurred while inserting data to the database
the given collection name or data is not a collection of valid values
the unique ID of the inserted data
update(string $collection, array|\Gishiki\Algorithms\Collections\CollectionInterface $data, \Gishiki\Database\Runtime\SelectionCriteria $where) : integer
Update values of documents/records matching the given criteria.
| string | $collection | the name of the collection that will hold the changed data |
| array|\Gishiki\Algorithms\Collections\CollectionInterface | $data | the new data of selected documents/records |
| \Gishiki\Database\Runtime\SelectionCriteria | $where | the criteria used to select documents/records to update |
the error occurred while updating data on the database
the given collection name or data is not a collection of valid values
the number of affected documents/records
delete(string $collection, \Gishiki\Database\Runtime\SelectionCriteria $where) : integer
Remove documents/records matching the given criteria.
| string | $collection | the name of the collection that will be affected |
| \Gishiki\Database\Runtime\SelectionCriteria | $where | the criteria used to select documents/records to update |
the error occurred while removing data from the database
the given collection name is not a valid collection name
the number of removed documents/records
deleteAll(string $collection) : integer
Remove EVERY documents/records on the given collection/table.
| string | $collection | the name of the collection that will be affected |
the error occurred while removing data from the database
the given collection name is not a valid collection name
the number of removed documents/records
read(string $collection, \Gishiki\Database\Runtime\SelectionCriteria $where, \Gishiki\Database\Runtime\ResultModifier $mod) : array
Fetch documents/records matching the given criteria.
| string | $collection | the name of the collection that will be searched |
| \Gishiki\Database\Runtime\SelectionCriteria | $where | the criteria used to select documents/records to fetch |
| \Gishiki\Database\Runtime\ResultModifier | $mod | the modifier to be applied to the result set |
the error occurred while fetching data from the database
the given collection name is not a valid collection name
the search result expressed as an array of associative arrays
readSelective(string $collection, array $fields, \Gishiki\Database\Runtime\SelectionCriteria $where, \Gishiki\Database\Runtime\ResultModifier $mod) : array
Fetch documents/records matching the given criteria, but retrieve only the specified columns.
| string | $collection | the name of the collection that will be searched |
| array | $fields | the list containing names of columns to be fetched |
| \Gishiki\Database\Runtime\SelectionCriteria | $where | the criteria used to select documents/records to fetch |
| \Gishiki\Database\Runtime\ResultModifier | $mod | the modifier to be applied to the result set |
the error occurred while fetching data from the database
the given collection name is not a valid collection name
the search result expressed as an array of associative arrays
createTable(\Gishiki\Database\Schema\Table $table)
Create the given table schema.
| \Gishiki\Database\Schema\Table | $table | the table to be created on the database |
the error occurred while creating the table