mirror of
https://github.com/appwrite/appwrite
synced 2026-04-21 13:37:16 +00:00
5590f0bcd0
# Conflicts: # .env # .github/workflows/tests.yml # app/controllers/api/projects.php # app/controllers/api/teams.php # app/init/registers.php # app/views/install/compose.phtml # composer.json # composer.lock # docker-compose.yml # src/Appwrite/Platform/Modules/Databases/Http/TablesDB/Create.php # src/Appwrite/Platform/Tasks/Install.php # src/Appwrite/Platform/Tasks/Upgrade.php # tests/e2e/Services/Databases/Legacy/DatabasesBase.php # tests/e2e/Services/Databases/TablesDB/DatabasesBase.php
986 lines
41 KiB
PHP
986 lines
41 KiB
PHP
<?php
|
|
|
|
use Appwrite\Event\Event;
|
|
use Appwrite\Event\Migration;
|
|
use Appwrite\Extend\Exception;
|
|
use Appwrite\OpenSSL\OpenSSL;
|
|
use Appwrite\SDK\AuthType;
|
|
use Appwrite\SDK\ContentType;
|
|
use Appwrite\SDK\Method;
|
|
use Appwrite\SDK\Response as SDKResponse;
|
|
use Appwrite\Utopia\Database\Validator\CompoundUID;
|
|
use Appwrite\Utopia\Database\Validator\Queries\Migrations;
|
|
use Appwrite\Utopia\Response;
|
|
use Utopia\Database\Database;
|
|
use Utopia\Database\Document;
|
|
use Utopia\Database\Exception\Order as OrderException;
|
|
use Utopia\Database\Exception\Query as QueryException;
|
|
use Utopia\Database\Helpers\ID;
|
|
use Utopia\Database\Query;
|
|
use Utopia\Database\Validator\Authorization;
|
|
use Utopia\Database\Validator\Queries\Documents;
|
|
use Utopia\Database\Validator\Query\Cursor;
|
|
use Utopia\Database\Validator\UID;
|
|
use Utopia\Http\Http;
|
|
use Utopia\Migration\Resource;
|
|
use Utopia\Migration\Sources\Appwrite;
|
|
use Utopia\Migration\Sources\CSV;
|
|
use Utopia\Migration\Sources\Firebase;
|
|
use Utopia\Migration\Sources\NHost;
|
|
use Utopia\Migration\Sources\Supabase;
|
|
use Utopia\Migration\Transfer;
|
|
use Utopia\Storage\Compression\Algorithms\GZIP;
|
|
use Utopia\Storage\Compression\Algorithms\Zstd;
|
|
use Utopia\Storage\Compression\Compression;
|
|
use Utopia\Storage\Device;
|
|
use Utopia\System\System;
|
|
use Utopia\Validator\ArrayList;
|
|
use Utopia\Validator\Boolean;
|
|
use Utopia\Validator\Integer;
|
|
use Utopia\Validator\Text;
|
|
use Utopia\Validator\URL;
|
|
use Utopia\Validator\WhiteList;
|
|
|
|
include_once __DIR__ . '/../shared/api.php';
|
|
|
|
Http::post('/v1/migrations/appwrite')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Create Appwrite migration')
|
|
->label('scope', 'migrations.write')
|
|
->label('event', 'migrations.[migrationId].create')
|
|
->label('audits.event', 'migration.create')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'createAppwriteMigration',
|
|
description: '/docs/references/migrations/migration-appwrite.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_ACCEPTED,
|
|
model: Response::MODEL_MIGRATION,
|
|
)
|
|
]
|
|
))
|
|
->param('resources', [], new ArrayList(new WhiteList(Appwrite::getSupportedResources())), 'List of resources to migrate')
|
|
->param('endpoint', '', new URL(), 'Source Appwrite endpoint')
|
|
->param('projectId', '', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Source Project ID', false, ['dbForProject'])
|
|
->param('apiKey', '', new Text(512), 'Source API Key')
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('user')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMigrations')
|
|
->action(function (array $resources, string $endpoint, string $projectId, string $apiKey, Response $response, Database $dbForProject, Document $project, array $platform, Document $user, Event $queueForEvents, Migration $queueForMigrations) {
|
|
$migration = $dbForProject->createDocument('migrations', new Document([
|
|
'$id' => ID::unique(),
|
|
'status' => 'pending',
|
|
'stage' => 'init',
|
|
'source' => Appwrite::getName(),
|
|
'destination' => Appwrite::getName(),
|
|
'credentials' => [
|
|
'endpoint' => $endpoint,
|
|
'projectId' => $projectId,
|
|
'apiKey' => $apiKey,
|
|
],
|
|
'resources' => $resources,
|
|
'statusCounters' => '{}',
|
|
'resourceData' => '{}',
|
|
'errors' => [],
|
|
]));
|
|
|
|
$queueForEvents->setParam('migrationId', $migration->getId());
|
|
|
|
// Trigger Transfer
|
|
$queueForMigrations
|
|
->setMigration($migration)
|
|
->setProject($project)
|
|
->setPlatform($platform)
|
|
->setUser($user)
|
|
->trigger();
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_ACCEPTED)
|
|
->dynamic($migration, Response::MODEL_MIGRATION);
|
|
});
|
|
|
|
Http::post('/v1/migrations/firebase')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Create Firebase migration')
|
|
->label('scope', 'migrations.write')
|
|
->label('event', 'migrations.[migrationId].create')
|
|
->label('audits.event', 'migration.create')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'createFirebaseMigration',
|
|
description: '/docs/references/migrations/migration-firebase.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_ACCEPTED,
|
|
model: Response::MODEL_MIGRATION,
|
|
)
|
|
]
|
|
))
|
|
->param('resources', [], new ArrayList(new WhiteList(Firebase::getSupportedResources())), 'List of resources to migrate')
|
|
->param('serviceAccount', '', new Text(65536), 'JSON of the Firebase service account credentials')
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('user')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMigrations')
|
|
->action(function (array $resources, string $serviceAccount, Response $response, Database $dbForProject, Document $project, array $platform, Document $user, Event $queueForEvents, Migration $queueForMigrations) {
|
|
$serviceAccountData = json_decode($serviceAccount, true);
|
|
|
|
if (empty($serviceAccountData)) {
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Invalid Service Account JSON');
|
|
}
|
|
|
|
if (!isset($serviceAccountData['project_id']) || !isset($serviceAccountData['client_email']) || !isset($serviceAccountData['private_key'])) {
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Invalid Service Account JSON');
|
|
}
|
|
|
|
$migration = $dbForProject->createDocument('migrations', new Document([
|
|
'$id' => ID::unique(),
|
|
'status' => 'pending',
|
|
'stage' => 'init',
|
|
'source' => Firebase::getName(),
|
|
'destination' => Appwrite::getName(),
|
|
'credentials' => [
|
|
'serviceAccount' => $serviceAccount,
|
|
],
|
|
'resources' => $resources,
|
|
'statusCounters' => '{}',
|
|
'resourceData' => '{}',
|
|
'errors' => [],
|
|
]));
|
|
|
|
$queueForEvents->setParam('migrationId', $migration->getId());
|
|
|
|
// Trigger Transfer
|
|
$queueForMigrations
|
|
->setMigration($migration)
|
|
->setProject($project)
|
|
->setPlatform($platform)
|
|
->setUser($user)
|
|
->trigger();
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_ACCEPTED)
|
|
->dynamic($migration, Response::MODEL_MIGRATION);
|
|
});
|
|
|
|
Http::post('/v1/migrations/supabase')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Create Supabase migration')
|
|
->label('scope', 'migrations.write')
|
|
->label('event', 'migrations.[migrationId].create')
|
|
->label('audits.event', 'migration.create')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'createSupabaseMigration',
|
|
description: '/docs/references/migrations/migration-supabase.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_ACCEPTED,
|
|
model: Response::MODEL_MIGRATION,
|
|
)
|
|
]
|
|
))
|
|
->param('resources', [], new ArrayList(new WhiteList(Supabase::getSupportedResources(), true)), 'List of resources to migrate')
|
|
->param('endpoint', '', new URL(), 'Source\'s Supabase Endpoint')
|
|
->param('apiKey', '', new Text(512), 'Source\'s API Key')
|
|
->param('databaseHost', '', new Text(512), 'Source\'s Database Host')
|
|
->param('username', '', new Text(512), 'Source\'s Database Username')
|
|
->param('password', '', new Text(512), 'Source\'s Database Password')
|
|
->param('port', 5432, new Integer(true), 'Source\'s Database Port', true)
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('user')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMigrations')
|
|
->action(function (array $resources, string $endpoint, string $apiKey, string $databaseHost, string $username, string $password, int $port, Response $response, Database $dbForProject, Document $project, array $platform, Document $user, Event $queueForEvents, Migration $queueForMigrations) {
|
|
$migration = $dbForProject->createDocument('migrations', new Document([
|
|
'$id' => ID::unique(),
|
|
'status' => 'pending',
|
|
'stage' => 'init',
|
|
'source' => Supabase::getName(),
|
|
'destination' => Appwrite::getName(),
|
|
'credentials' => [
|
|
'endpoint' => $endpoint,
|
|
'apiKey' => $apiKey,
|
|
'databaseHost' => $databaseHost,
|
|
'username' => $username,
|
|
'password' => $password,
|
|
'port' => $port,
|
|
],
|
|
'resources' => $resources,
|
|
'statusCounters' => '{}',
|
|
'resourceData' => '{}',
|
|
'errors' => [],
|
|
]));
|
|
|
|
$queueForEvents->setParam('migrationId', $migration->getId());
|
|
|
|
// Trigger Transfer
|
|
$queueForMigrations
|
|
->setMigration($migration)
|
|
->setProject($project)
|
|
->setPlatform($platform)
|
|
->setUser($user)
|
|
->trigger();
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_ACCEPTED)
|
|
->dynamic($migration, Response::MODEL_MIGRATION);
|
|
});
|
|
|
|
Http::post('/v1/migrations/nhost')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Create NHost migration')
|
|
->label('scope', 'migrations.write')
|
|
->label('event', 'migrations.[migrationId].create')
|
|
->label('audits.event', 'migration.create')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'createNHostMigration',
|
|
description: '/docs/references/migrations/migration-nhost.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_ACCEPTED,
|
|
model: Response::MODEL_MIGRATION,
|
|
)
|
|
]
|
|
))
|
|
->param('resources', [], new ArrayList(new WhiteList(NHost::getSupportedResources())), 'List of resources to migrate')
|
|
->param('subdomain', '', new Text(512), 'Source\'s Subdomain')
|
|
->param('region', '', new Text(512), 'Source\'s Region')
|
|
->param('adminSecret', '', new Text(512), 'Source\'s Admin Secret')
|
|
->param('database', '', new Text(512), 'Source\'s Database Name')
|
|
->param('username', '', new Text(512), 'Source\'s Database Username')
|
|
->param('password', '', new Text(512), 'Source\'s Database Password')
|
|
->param('port', 5432, new Integer(true), 'Source\'s Database Port', true)
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('user')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMigrations')
|
|
->action(function (array $resources, string $subdomain, string $region, string $adminSecret, string $database, string $username, string $password, int $port, Response $response, Database $dbForProject, Document $project, array $platform, Document $user, Event $queueForEvents, Migration $queueForMigrations) {
|
|
$migration = $dbForProject->createDocument('migrations', new Document([
|
|
'$id' => ID::unique(),
|
|
'status' => 'pending',
|
|
'stage' => 'init',
|
|
'source' => NHost::getName(),
|
|
'destination' => Appwrite::getName(),
|
|
'credentials' => [
|
|
'subdomain' => $subdomain,
|
|
'region' => $region,
|
|
'adminSecret' => $adminSecret,
|
|
'database' => $database,
|
|
'username' => $username,
|
|
'password' => $password,
|
|
'port' => $port,
|
|
],
|
|
'resources' => $resources,
|
|
'statusCounters' => '{}',
|
|
'resourceData' => '{}',
|
|
'errors' => [],
|
|
]));
|
|
|
|
$queueForEvents->setParam('migrationId', $migration->getId());
|
|
|
|
// Trigger Transfer
|
|
$queueForMigrations
|
|
->setMigration($migration)
|
|
->setProject($project)
|
|
->setPlatform($platform)
|
|
->setUser($user)
|
|
->trigger();
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_ACCEPTED)
|
|
->dynamic($migration, Response::MODEL_MIGRATION);
|
|
});
|
|
|
|
Http::post('/v1/migrations/csv/imports')
|
|
->alias('/v1/migrations/csv')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Import documents from a CSV')
|
|
->label('scope', 'migrations.write')
|
|
->label('event', 'migrations.[migrationId].create')
|
|
->label('audits.event', 'migration.create')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'createCSVImport',
|
|
description: '/docs/references/migrations/migration-csv-import.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_ACCEPTED,
|
|
model: Response::MODEL_MIGRATION,
|
|
)
|
|
]
|
|
))
|
|
->param('bucketId', '', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).', false, ['dbForProject'])
|
|
->param('fileId', '', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'File ID.', false, ['dbForProject'])
|
|
->param('resourceId', null, new CompoundUID(), 'Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.')
|
|
->param('internalFile', false, new Boolean(), 'Is the file stored in an internal bucket?', true)
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('dbForPlatform')
|
|
->inject('authorization')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('deviceForFiles')
|
|
->inject('deviceForMigrations')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMigrations')
|
|
->action(function (
|
|
string $bucketId,
|
|
string $fileId,
|
|
string $resourceId,
|
|
bool $internalFile,
|
|
Response $response,
|
|
Database $dbForProject,
|
|
Database $dbForPlatform,
|
|
Authorization $authorization,
|
|
Document $project,
|
|
array $platform,
|
|
Device $deviceForFiles,
|
|
Device $deviceForMigrations,
|
|
Event $queueForEvents,
|
|
Migration $queueForMigrations
|
|
) {
|
|
$bucket = $authorization->skip(function () use ($internalFile, $dbForPlatform, $dbForProject, $bucketId) {
|
|
if ($internalFile) {
|
|
return $dbForPlatform->getDocument('buckets', 'default');
|
|
}
|
|
return $dbForProject->getDocument('buckets', $bucketId);
|
|
});
|
|
|
|
if ($bucket->isEmpty()) {
|
|
throw new Exception(Exception::STORAGE_BUCKET_NOT_FOUND);
|
|
}
|
|
|
|
$file = $authorization->skip(fn () => $internalFile ? $dbForPlatform->getDocument('bucket_' . $bucket->getSequence(), $fileId) : $dbForProject->getDocument('bucket_' . $bucket->getSequence(), $fileId));
|
|
if ($file->isEmpty()) {
|
|
throw new Exception(Exception::STORAGE_FILE_NOT_FOUND);
|
|
}
|
|
|
|
$path = $file->getAttribute('path', '');
|
|
if (!$deviceForFiles->exists($path)) {
|
|
throw new Exception(Exception::STORAGE_FILE_NOT_FOUND, 'File not found in ' . $path);
|
|
}
|
|
|
|
// No encryption or compression on files above 20MB.
|
|
$hasEncryption = !empty($file->getAttribute('openSSLCipher'));
|
|
$compression = $file->getAttribute('algorithm', Compression::NONE);
|
|
$hasCompression = $compression !== Compression::NONE;
|
|
|
|
$migrationId = ID::unique();
|
|
$newPath = $deviceForMigrations->getPath($migrationId . '_' . $fileId . '.csv');
|
|
|
|
if ($hasEncryption || $hasCompression) {
|
|
$source = $deviceForFiles->read($path);
|
|
|
|
if ($hasEncryption) {
|
|
$source = OpenSSL::decrypt(
|
|
$source,
|
|
$file->getAttribute('openSSLCipher'),
|
|
System::getEnv('_APP_OPENSSL_KEY_V' . $file->getAttribute('openSSLVersion')),
|
|
0,
|
|
hex2bin($file->getAttribute('openSSLIV')),
|
|
hex2bin($file->getAttribute('openSSLTag'))
|
|
);
|
|
}
|
|
|
|
if ($hasCompression) {
|
|
switch ($compression) {
|
|
case Compression::ZSTD:
|
|
$source = (new Zstd())->decompress($source);
|
|
break;
|
|
case Compression::GZIP:
|
|
$source = (new GZIP())->decompress($source);
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Manual write after decryption and/or decompression
|
|
if (!$deviceForMigrations->write($newPath, $source, 'text/csv')) {
|
|
throw new \Exception('Unable to copy file');
|
|
}
|
|
} elseif (!$deviceForFiles->transfer($path, $newPath, $deviceForMigrations)) {
|
|
throw new \Exception('Unable to copy file');
|
|
}
|
|
|
|
$fileSize = $deviceForMigrations->getFileSize($newPath);
|
|
$resources = Transfer::extractServices([Transfer::GROUP_DATABASES]);
|
|
|
|
$migration = $dbForProject->createDocument('migrations', new Document([
|
|
'$id' => $migrationId,
|
|
'status' => 'pending',
|
|
'stage' => 'init',
|
|
'source' => CSV::getName(),
|
|
'destination' => Appwrite::getName(),
|
|
'resources' => $resources,
|
|
'resourceId' => $resourceId,
|
|
'resourceType' => Resource::TYPE_DATABASE,
|
|
'statusCounters' => '{}',
|
|
'resourceData' => '{}',
|
|
'errors' => [],
|
|
'options' => [
|
|
'path' => $newPath,
|
|
'size' => $fileSize,
|
|
],
|
|
]));
|
|
|
|
$queueForEvents->setParam('migrationId', $migration->getId());
|
|
|
|
$queueForMigrations
|
|
->setMigration($migration)
|
|
->setProject($project)
|
|
->setProject($project)
|
|
->trigger();
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_ACCEPTED)
|
|
->dynamic($migration, Response::MODEL_MIGRATION);
|
|
});
|
|
|
|
Http::post('/v1/migrations/csv/exports')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Export documents to CSV')
|
|
->label('scope', 'migrations.write')
|
|
->label('event', 'migrations.[migrationId].create')
|
|
->label('audits.event', 'migration.create')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'createCSVExport',
|
|
description: '/docs/references/migrations/migration-csv-export.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_ACCEPTED,
|
|
model: Response::MODEL_MIGRATION,
|
|
)
|
|
]
|
|
))
|
|
->param('resourceId', null, new CompoundUID(), 'Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.')
|
|
->param('filename', '', new Text(255), 'The name of the file to be created for the export, excluding the .csv extension.')
|
|
->param('columns', [], new ArrayList(new Text(Database::LENGTH_KEY)), 'List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.', true)
|
|
->param('queries', [], new ArrayList(new Text(0)), 'Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' queries are allowed, each ' . APP_LIMIT_ARRAY_ELEMENT_SIZE . ' characters long.', true)
|
|
->param('delimiter', ',', new Text(1), 'The character that separates each column value. Default is comma.', true)
|
|
->param('enclosure', '"', new Text(1), 'The character that encloses each column value. Default is double quotes.', true)
|
|
->param('escape', '"', new Text(1), 'The escape character for the enclosure character. Default is double quotes.', true)
|
|
->param('header', true, new Boolean(), 'Whether to include the header row with column names. Default is true.', true)
|
|
->param('notify', true, new Boolean(), 'Set to true to receive an email when the export is complete. Default is true.', true)
|
|
->inject('user')
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('dbForPlatform')
|
|
->inject('authorization')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('queueForEvents')
|
|
->inject('queueForMigrations')
|
|
->action(function (
|
|
string $resourceId,
|
|
string $filename,
|
|
array $columns,
|
|
array $queries,
|
|
string $delimiter,
|
|
string $enclosure,
|
|
string $escape,
|
|
bool $header,
|
|
bool $notify,
|
|
Document $user,
|
|
Response $response,
|
|
Database $dbForProject,
|
|
Database $dbForPlatform,
|
|
Authorization $authorization,
|
|
Document $project,
|
|
array $platform,
|
|
Event $queueForEvents,
|
|
Migration $queueForMigrations
|
|
) {
|
|
try {
|
|
$parsedQueries = Query::parseQueries($queries);
|
|
} catch (QueryException $e) {
|
|
throw new Exception(Exception::GENERAL_QUERY_INVALID, $e->getMessage());
|
|
}
|
|
|
|
$bucket = $authorization->skip(fn () => $dbForPlatform->getDocument('buckets', 'default'));
|
|
if ($bucket->isEmpty()) {
|
|
throw new Exception(Exception::STORAGE_BUCKET_NOT_FOUND);
|
|
}
|
|
|
|
[$databaseId, $collectionId] = \explode(':', $resourceId, 2);
|
|
if (empty($databaseId)) {
|
|
throw new Exception(Exception::DATABASE_NOT_FOUND);
|
|
}
|
|
if (empty($collectionId)) {
|
|
throw new Exception(Exception::COLLECTION_NOT_FOUND);
|
|
}
|
|
|
|
$database = $authorization->skip(fn () => $dbForProject->getDocument('databases', $databaseId));
|
|
if ($database->isEmpty()) {
|
|
throw new Exception(Exception::DATABASE_NOT_FOUND);
|
|
}
|
|
|
|
$collection = $authorization->skip(fn () => $dbForProject->getDocument('database_' . $database->getSequence(), $collectionId));
|
|
if ($collection->isEmpty()) {
|
|
throw new Exception(Exception::COLLECTION_NOT_FOUND);
|
|
}
|
|
|
|
$validator = new Documents(
|
|
attributes: $collection->getAttribute('attributes', []),
|
|
indexes: $collection->getAttribute('indexes', []),
|
|
idAttributeType: $dbForProject->getAdapter()->getIdAttributeType(),
|
|
);
|
|
|
|
if (!$validator->isValid($parsedQueries)) {
|
|
throw new Exception(Exception::GENERAL_QUERY_INVALID, $validator->getDescription());
|
|
}
|
|
|
|
$migration = $dbForProject->createDocument('migrations', new Document([
|
|
'$id' => ID::unique(),
|
|
'status' => 'pending',
|
|
'stage' => 'init',
|
|
'source' => Appwrite::getName(),
|
|
'destination' => CSV::getName(),
|
|
'resources' => Transfer::extractServices([Transfer::GROUP_DATABASES]),
|
|
'resourceId' => $resourceId,
|
|
'resourceType' => Resource::TYPE_DATABASE,
|
|
'statusCounters' => '{}',
|
|
'resourceData' => '{}',
|
|
'errors' => [],
|
|
'options' => [
|
|
'bucketId' => 'default', // Always use internal bucket
|
|
'filename' => $filename,
|
|
'columns' => $columns,
|
|
'queries' => $queries,
|
|
'delimiter' => $delimiter,
|
|
'enclosure' => $enclosure,
|
|
'escape' => $escape,
|
|
'header' => $header,
|
|
'notify' => $notify,
|
|
'userInternalId' => $user->getSequence(),
|
|
],
|
|
]));
|
|
|
|
$queueForEvents->setParam('migrationId', $migration->getId());
|
|
|
|
$queueForMigrations
|
|
->setMigration($migration)
|
|
->setProject($project)
|
|
->setPlatform($platform)
|
|
->trigger();
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_ACCEPTED)
|
|
->dynamic($migration, Response::MODEL_MIGRATION);
|
|
});
|
|
|
|
Http::get('/v1/migrations')
|
|
->groups(['api', 'migrations'])
|
|
->desc('List migrations')
|
|
->label('scope', 'migrations.read')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'list',
|
|
description: '/docs/references/migrations/list-migrations.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_MIGRATION_LIST,
|
|
)
|
|
]
|
|
))
|
|
->param('queries', [], new Migrations(), 'Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' queries are allowed, each ' . APP_LIMIT_ARRAY_ELEMENT_SIZE . ' characters long. You may filter on the following attributes: ' . implode(', ', Migrations::ALLOWED_ATTRIBUTES), true)
|
|
->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true)
|
|
->param('total', true, new Boolean(true), 'When set to false, the total count returned will be 0 and will not be calculated.', true)
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->action(function (array $queries, string $search, bool $includeTotal, Response $response, Database $dbForProject) {
|
|
try {
|
|
$queries = Query::parseQueries($queries);
|
|
} catch (QueryException $e) {
|
|
throw new Exception(Exception::GENERAL_QUERY_INVALID, $e->getMessage());
|
|
}
|
|
|
|
if (!empty($search)) {
|
|
$queries[] = Query::search('search', $search);
|
|
}
|
|
|
|
$cursor = Query::getCursorQueries($queries, false);
|
|
$cursor = \reset($cursor);
|
|
|
|
if ($cursor !== false) {
|
|
$validator = new Cursor();
|
|
if (!$validator->isValid($cursor)) {
|
|
throw new Exception(Exception::GENERAL_QUERY_INVALID, $validator->getDescription());
|
|
}
|
|
|
|
$migrationId = $cursor->getValue();
|
|
$cursorDocument = $dbForProject->getDocument('migrations', $migrationId);
|
|
|
|
if ($cursorDocument->isEmpty()) {
|
|
throw new Exception(Exception::GENERAL_CURSOR_NOT_FOUND, "Migration '{$migrationId}' for the 'cursor' value not found.");
|
|
}
|
|
|
|
$cursor->setValue($cursorDocument);
|
|
}
|
|
|
|
$filterQueries = Query::groupByType($queries)['filters'];
|
|
try {
|
|
$migrations = $dbForProject->find('migrations', $queries);
|
|
$total = $includeTotal ? $dbForProject->count('migrations', $filterQueries, APP_LIMIT_COUNT) : 0;
|
|
} catch (OrderException $e) {
|
|
throw new Exception(Exception::DATABASE_QUERY_ORDER_NULL, "The order attribute '{$e->getAttribute()}' had a null value. Cursor pagination requires all documents order attribute values are non-null.");
|
|
}
|
|
$response->dynamic(new Document([
|
|
'migrations' => $migrations,
|
|
'total' => $total,
|
|
]), Response::MODEL_MIGRATION_LIST);
|
|
});
|
|
|
|
Http::get('/v1/migrations/:migrationId')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Get migration')
|
|
->label('scope', 'migrations.read')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'get',
|
|
description: '/docs/references/migrations/get-migration.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_MIGRATION,
|
|
)
|
|
]
|
|
))
|
|
->param('migrationId', '', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Migration unique ID.', false, ['dbForProject'])
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->action(function (string $migrationId, Response $response, Database $dbForProject) {
|
|
$migration = $dbForProject->getDocument('migrations', $migrationId);
|
|
|
|
if ($migration->isEmpty()) {
|
|
throw new Exception(Exception::MIGRATION_NOT_FOUND);
|
|
}
|
|
|
|
$response->dynamic($migration, Response::MODEL_MIGRATION);
|
|
});
|
|
|
|
Http::get('/v1/migrations/appwrite/report')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Get Appwrite migration report')
|
|
->label('scope', 'migrations.write')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'getAppwriteReport',
|
|
description: '/docs/references/migrations/migration-appwrite-report.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_MIGRATION_REPORT,
|
|
)
|
|
]
|
|
))
|
|
->param('resources', [], new ArrayList(new WhiteList(Appwrite::getSupportedResources())), 'List of resources to migrate')
|
|
->param('endpoint', '', new URL(), "Source's Appwrite Endpoint")
|
|
->param('projectID', '', new Text(512), "Source's Project ID")
|
|
->param('key', '', new Text(512), "Source's API Key")
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('user')
|
|
->action(function (array $resources, string $endpoint, string $projectID, string $key, Response $response) {
|
|
|
|
$appwrite = new Appwrite($projectID, $endpoint, $key);
|
|
|
|
try {
|
|
$report = $appwrite->report($resources);
|
|
} catch (\Throwable $e) {
|
|
switch ($e->getCode()) {
|
|
case 401:
|
|
throw new Exception(Exception::GENERAL_UNAUTHORIZED_SCOPE, 'Source Error: ' . $e->getMessage());
|
|
case 429:
|
|
throw new Exception(Exception::GENERAL_RATE_LIMIT_EXCEEDED, 'Source Error: Rate Limit Exceeded, Is your Cloud Provider blocking Appwrite\'s IP?');
|
|
case 500:
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Source Error: ' . $e->getMessage());
|
|
}
|
|
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Source Error: ' . $e->getMessage());
|
|
}
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_OK)
|
|
->dynamic(new Document($report), Response::MODEL_MIGRATION_REPORT);
|
|
});
|
|
|
|
Http::get('/v1/migrations/firebase/report')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Get Firebase migration report')
|
|
->label('scope', 'migrations.write')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'getFirebaseReport',
|
|
description: '/docs/references/migrations/migration-firebase-report.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_MIGRATION_REPORT,
|
|
)
|
|
]
|
|
))
|
|
->param('resources', [], new ArrayList(new WhiteList(Firebase::getSupportedResources())), 'List of resources to migrate')
|
|
->param('serviceAccount', '', new Text(65536), 'JSON of the Firebase service account credentials')
|
|
->inject('response')
|
|
->action(function (array $resources, string $serviceAccount, Response $response) {
|
|
$serviceAccount = json_decode($serviceAccount, true);
|
|
|
|
if (empty($serviceAccount)) {
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Invalid Service Account JSON');
|
|
}
|
|
|
|
if (!isset($serviceAccount['project_id']) || !isset($serviceAccount['client_email']) || !isset($serviceAccount['private_key'])) {
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Invalid Service Account JSON');
|
|
}
|
|
|
|
$firebase = new Firebase($serviceAccount);
|
|
|
|
try {
|
|
$report = $firebase->report($resources);
|
|
} catch (\Throwable $e) {
|
|
switch ($e->getCode()) {
|
|
case 401:
|
|
throw new Exception(Exception::GENERAL_UNAUTHORIZED_SCOPE, 'Source Error: ' . $e->getMessage());
|
|
case 429:
|
|
throw new Exception(Exception::GENERAL_RATE_LIMIT_EXCEEDED, 'Source Error: Rate Limit Exceeded, Is your Cloud Provider blocking Appwrite\'s IP?');
|
|
case 500:
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Source Error: ' . $e->getMessage());
|
|
}
|
|
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Source Error: ' . $e->getMessage());
|
|
}
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_OK)
|
|
->dynamic(new Document($report), Response::MODEL_MIGRATION_REPORT);
|
|
});
|
|
|
|
Http::get('/v1/migrations/supabase/report')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Get Supabase migration report')
|
|
->label('scope', 'migrations.write')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'getSupabaseReport',
|
|
description: '/docs/references/migrations/migration-supabase-report.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_MIGRATION_REPORT,
|
|
)
|
|
]
|
|
))
|
|
->param('resources', [], new ArrayList(new WhiteList(Supabase::getSupportedResources(), true)), 'List of resources to migrate')
|
|
->param('endpoint', '', new URL(), 'Source\'s Supabase Endpoint.')
|
|
->param('apiKey', '', new Text(512), 'Source\'s API Key.')
|
|
->param('databaseHost', '', new Text(512), 'Source\'s Database Host.')
|
|
->param('username', '', new Text(512), 'Source\'s Database Username.')
|
|
->param('password', '', new Text(512), 'Source\'s Database Password.')
|
|
->param('port', 5432, new Integer(true), 'Source\'s Database Port.', true)
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->action(function (array $resources, string $endpoint, string $apiKey, string $databaseHost, string $username, string $password, int $port, Response $response) {
|
|
$supabase = new Supabase($endpoint, $apiKey, $databaseHost, 'postgres', $username, $password, $port);
|
|
|
|
try {
|
|
$report = $supabase->report($resources);
|
|
} catch (\Throwable $e) {
|
|
switch ($e->getCode()) {
|
|
case 401:
|
|
throw new Exception(Exception::GENERAL_UNAUTHORIZED_SCOPE, 'Source Error: ' . $e->getMessage());
|
|
case 429:
|
|
throw new Exception(Exception::GENERAL_RATE_LIMIT_EXCEEDED, 'Source Error: Rate Limit Exceeded, Is your Cloud Provider blocking Appwrite\'s IP?');
|
|
case 500:
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Source Error: ' . $e->getMessage());
|
|
}
|
|
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Source Error: ' . $e->getMessage());
|
|
}
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_OK)
|
|
->dynamic(new Document($report), Response::MODEL_MIGRATION_REPORT);
|
|
});
|
|
|
|
Http::get('/v1/migrations/nhost/report')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Get NHost migration report')
|
|
->label('scope', 'migrations.write')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'getNHostReport',
|
|
description: '/docs/references/migrations/migration-nhost-report.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_OK,
|
|
model: Response::MODEL_MIGRATION_REPORT,
|
|
)
|
|
]
|
|
))
|
|
->param('resources', [], new ArrayList(new WhiteList(NHost::getSupportedResources())), 'List of resources to migrate.')
|
|
->param('subdomain', '', new Text(512), 'Source\'s Subdomain.')
|
|
->param('region', '', new Text(512), 'Source\'s Region.')
|
|
->param('adminSecret', '', new Text(512), 'Source\'s Admin Secret.')
|
|
->param('database', '', new Text(512), 'Source\'s Database Name.')
|
|
->param('username', '', new Text(512), 'Source\'s Database Username.')
|
|
->param('password', '', new Text(512), 'Source\'s Database Password.')
|
|
->param('port', 5432, new Integer(true), 'Source\'s Database Port.', true)
|
|
->inject('response')
|
|
->action(function (array $resources, string $subdomain, string $region, string $adminSecret, string $database, string $username, string $password, int $port, Response $response) {
|
|
$nhost = new NHost($subdomain, $region, $adminSecret, $database, $username, $password, $port);
|
|
|
|
try {
|
|
$report = $nhost->report($resources);
|
|
} catch (\Throwable $e) {
|
|
switch ($e->getCode()) {
|
|
case 401:
|
|
throw new Exception(Exception::GENERAL_UNAUTHORIZED_SCOPE, 'Source Error: ' . $e->getMessage());
|
|
case 429:
|
|
throw new Exception(Exception::GENERAL_RATE_LIMIT_EXCEEDED, 'Source Error: Rate Limit Exceeded, Is your Cloud Provider blocking Appwrite\'s IP?');
|
|
case 500:
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Source Error: ' . $e->getMessage());
|
|
}
|
|
|
|
throw new Exception(Exception::MIGRATION_PROVIDER_ERROR, 'Source Error: ' . $e->getMessage());
|
|
}
|
|
|
|
$response
|
|
->setStatusCode(Response::STATUS_CODE_OK)
|
|
->dynamic(new Document($report), Response::MODEL_MIGRATION_REPORT);
|
|
});
|
|
|
|
Http::patch('/v1/migrations/:migrationId')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Update retry migration')
|
|
->label('scope', 'migrations.write')
|
|
->label('event', 'migrations.[migrationId].retry')
|
|
->label('audits.event', 'migration.retry')
|
|
->label('audits.resource', 'migrations/{request.migrationId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'retry',
|
|
description: '/docs/references/migrations/retry-migration.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_ACCEPTED,
|
|
model: Response::MODEL_MIGRATION,
|
|
)
|
|
]
|
|
))
|
|
->param('migrationId', '', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Migration unique ID.', false, ['dbForProject'])
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('project')
|
|
->inject('platform')
|
|
->inject('user')
|
|
->inject('queueForMigrations')
|
|
->action(function (string $migrationId, Response $response, Database $dbForProject, Document $project, array $platform, Document $user, Migration $queueForMigrations) {
|
|
$migration = $dbForProject->getDocument('migrations', $migrationId);
|
|
|
|
if ($migration->isEmpty()) {
|
|
throw new Exception(Exception::MIGRATION_NOT_FOUND);
|
|
}
|
|
|
|
if ($migration->getAttribute('status') !== 'failed') {
|
|
throw new Exception(Exception::MIGRATION_IN_PROGRESS, 'Migration not failed yet');
|
|
}
|
|
|
|
$migration
|
|
->setAttribute('status', 'pending')
|
|
->setAttribute('dateUpdated', \time());
|
|
|
|
// Trigger Migration
|
|
$queueForMigrations
|
|
->setMigration($migration)
|
|
->setProject($project)
|
|
->setPlatform($platform)
|
|
->setUser($user)
|
|
->trigger();
|
|
|
|
$response->noContent();
|
|
});
|
|
|
|
Http::delete('/v1/migrations/:migrationId')
|
|
->groups(['api', 'migrations'])
|
|
->desc('Delete migration')
|
|
->label('scope', 'migrations.write')
|
|
->label('event', 'migrations.[migrationId].delete')
|
|
->label('audits.event', 'migrationId.delete')
|
|
->label('audits.resource', 'migrations/{request.migrationId}')
|
|
->label('sdk', new Method(
|
|
namespace: 'migrations',
|
|
group: null,
|
|
name: 'delete',
|
|
description: '/docs/references/migrations/delete-migration.md',
|
|
auth: [AuthType::ADMIN],
|
|
responses: [
|
|
new SDKResponse(
|
|
code: Response::STATUS_CODE_NOCONTENT,
|
|
model: Response::MODEL_NONE,
|
|
)
|
|
],
|
|
contentType: ContentType::NONE
|
|
))
|
|
->param('migrationId', '', fn (Database $dbForProject) => new UID($dbForProject->getAdapter()->getMaxUIDLength()), 'Migration ID.', false, ['dbForProject'])
|
|
->inject('response')
|
|
->inject('dbForProject')
|
|
->inject('queueForEvents')
|
|
->action(function (string $migrationId, Response $response, Database $dbForProject, Event $queueForEvents) {
|
|
$migration = $dbForProject->getDocument('migrations', $migrationId);
|
|
|
|
if ($migration->isEmpty()) {
|
|
throw new Exception(Exception::MIGRATION_NOT_FOUND);
|
|
}
|
|
|
|
if (!$dbForProject->deleteDocument('migrations', $migration->getId())) {
|
|
throw new Exception(Exception::GENERAL_SERVER_ERROR, 'Failed to remove migration from DB');
|
|
}
|
|
|
|
$queueForEvents->setParam('migrationId', $migration->getId());
|
|
|
|
$response->noContent();
|
|
});
|