appwrite/src/Appwrite/Event/Database.php

201 lines
4.3 KiB
PHP
Raw Normal View History

<?php
namespace Appwrite\Event;
use Utopia\Database\Document;
2024-05-08 04:25:12 +00:00
use Utopia\DSN\DSN;
2025-01-29 14:13:58 +00:00
use Utopia\Queue\Publisher;
use Utopia\System\System;
class Database extends Event
{
protected string $type = '';
Database layer (#3338) * database response model * database collection config * new database scopes * database service update * database execption codes * remove read write permission from database model * updating tests and fixing some bugs * server side tests are now passing * databases api * tests for database endpoint * composer update * fix error * formatting * formatting fixes * get database test * more updates to events and usage * more usage updates * fix delete type * fix test * delete database * more fixes * databaseId in attributes and indexes * more fixes * fix issues * fix index subquery * fix console scope and index query * updating tests as required * fix phpcs errors and warnings * updates to review suggestions * UI progress * ui updates and cleaning up * fix type * rework database events * update tests * update types * event generation fixed * events config updated * updating context to support multiple * realtime updates * fix ids * update context * validator updates * fix naming conflict * fix tests * fix lint errors * fix wprler and realtime tests * fix webhooks test * fix event validator and other tests * formatting fixes * removing leftover var_dumps * remove leftover comment * update usage params * usage metrics updates * update database usage * fix usage * specs update * updates to usage * fix UI and usage * fix lints * internal id fixes * fixes for internal Id * renaming services and related files * rename tests * rename doc link * rename readme * fix test name * tests: fixes for 0.15.x sync Co-authored-by: Torsten Dittmann <torsten.dittmann@googlemail.com>
2022-06-22 10:51:49 +00:00
protected ?Document $database = null;
2025-05-07 08:41:28 +00:00
// tables api
2025-04-27 05:03:44 +00:00
protected ?Document $row = null;
2025-05-07 08:41:28 +00:00
protected ?Document $table = null;
// collections api
protected ?Document $document = null;
protected ?Document $collection = null;
2025-01-29 14:13:58 +00:00
public function __construct(protected Publisher $publisher)
{
2025-01-29 14:13:58 +00:00
parent::__construct($publisher);
2023-06-02 03:54:34 +00:00
$this->setClass(System::getEnv('_APP_DATABASE_CLASS_NAME', Event::DATABASE_CLASS_NAME));
}
2022-04-18 16:21:45 +00:00
/**
* Sets the type for this database event (use the constants starting with DATABASE_TYPE_*).
*
* @param string $type
* @return self
*/
public function setType(string $type): self
{
$this->type = $type;
return $this;
}
2022-04-18 16:21:45 +00:00
/**
* Returns the set type for the database event.
2022-05-23 14:54:50 +00:00
* @return string
2022-04-18 16:21:45 +00:00
*/
public function getType(): string
{
return $this->type;
}
Database layer (#3338) * database response model * database collection config * new database scopes * database service update * database execption codes * remove read write permission from database model * updating tests and fixing some bugs * server side tests are now passing * databases api * tests for database endpoint * composer update * fix error * formatting * formatting fixes * get database test * more updates to events and usage * more usage updates * fix delete type * fix test * delete database * more fixes * databaseId in attributes and indexes * more fixes * fix issues * fix index subquery * fix console scope and index query * updating tests as required * fix phpcs errors and warnings * updates to review suggestions * UI progress * ui updates and cleaning up * fix type * rework database events * update tests * update types * event generation fixed * events config updated * updating context to support multiple * realtime updates * fix ids * update context * validator updates * fix naming conflict * fix tests * fix lint errors * fix wprler and realtime tests * fix webhooks test * fix event validator and other tests * formatting fixes * removing leftover var_dumps * remove leftover comment * update usage params * usage metrics updates * update database usage * fix usage * specs update * updates to usage * fix UI and usage * fix lints * internal id fixes * fixes for internal Id * renaming services and related files * rename tests * rename doc link * rename readme * fix test name * tests: fixes for 0.15.x sync Co-authored-by: Torsten Dittmann <torsten.dittmann@googlemail.com>
2022-06-22 10:51:49 +00:00
/**
* Set the database for this event
*
* @param Document $database
* @return self
*/
public function setDatabase(Document $database): self
{
$this->database = $database;
return $this;
}
/**
* Returns set database for this event.
*
* @return null|Document
*/
public function getDatabase(): ?Document
{
return $this->database;
}
2022-04-18 16:21:45 +00:00
/**
2025-04-27 05:03:44 +00:00
* Set the table for this database event.
2022-04-18 16:21:45 +00:00
*
2025-04-27 05:03:44 +00:00
* @param Document $table
2022-04-18 16:21:45 +00:00
* @return self
*/
2025-04-27 05:03:44 +00:00
public function setTable(Document $table): self
{
2025-04-27 05:03:44 +00:00
$this->table = $table;
return $this;
}
2022-04-18 16:21:45 +00:00
/**
2025-04-27 05:03:44 +00:00
* Returns set table for this event.
2022-04-18 16:21:45 +00:00
*
2022-05-10 12:31:20 +00:00
* @return null|Document
2022-04-18 16:21:45 +00:00
*/
2025-04-27 05:03:44 +00:00
public function getTable(): ?Document
{
2025-04-27 05:03:44 +00:00
return $this->table;
}
2022-04-18 16:21:45 +00:00
/**
2025-04-27 05:03:44 +00:00
* Set the row for this database event.
2022-04-18 16:21:45 +00:00
*
2025-04-27 05:03:44 +00:00
* @param Document $row
2022-04-18 16:21:45 +00:00
* @return self
*/
2025-04-27 05:03:44 +00:00
public function setRow(Document $row): self
{
2025-04-27 05:03:44 +00:00
$this->row = $row;
return $this;
}
2022-04-18 16:21:45 +00:00
/**
2025-04-27 05:03:44 +00:00
* Returns set row for this database event.
2022-05-10 12:31:20 +00:00
* @return null|Document
2022-04-18 16:21:45 +00:00
*/
2025-04-27 05:03:44 +00:00
public function getRow(): ?Document
{
2025-04-27 05:03:44 +00:00
return $this->row;
}
2025-05-07 08:41:28 +00:00
/**
* Set the collection for this database event.
*
* @param Document $collection
* @return self
*/
public function setCollection(Document $collection): self
{
$this->collection = $collection;
return $this;
}
/**
* Returns set collection for this event.
*
* @return null|Document
*/
public function getCollection(): ?Document
{
return $this->collection;
}
/**
* Set the document for this database event.
*
* @param Document $document
* @return self
*/
public function setDocument(Document $document): self
{
$this->document = $document;
return $this;
}
/**
* Returns set document for this database event.
* @return null|Document
*/
public function getDocument(): ?Document
{
return $this->document;
}
public function setProject(Document $project): static
{
2025-09-12 09:07:40 +00:00
$database = $project->getAttribute('database');
if (!empty($database)) {
try {
$dsn = new DSN($database);
} catch (\InvalidArgumentException) {
// TODO: Temporary until all projects are using shared tables
$dsn = new DSN("mysql://$database");
}
$this->queue = $dsn->getHost();
2024-05-08 04:25:12 +00:00
}
2025-09-12 09:07:40 +00:00
return parent::setProject($project);
2025-01-17 05:08:39 +00:00
}
2025-01-17 05:08:39 +00:00
/**
* Prepare the payload for the event
*
* @return array
*/
protected function preparePayload(): array
{
return [
'project' => $this->project,
'user' => $this->user,
'type' => $this->type,
2025-04-27 05:03:44 +00:00
'table' => $this->table,
'row' => $this->row,
2025-05-07 08:41:28 +00:00
'collection' => $this->collection,
'document' => $this->document,
2025-01-17 05:08:39 +00:00
'database' => $this->database,
'events' => Event::generateEvents($this->getEvent(), $this->getParams())
];
}
2022-05-23 14:54:50 +00:00
}