postgresql.md

PostgresqlResource

Accessed via $enhance->postgresql.

Method	Route
createWebsitePostgresqlDb	POST /orgs/{org_id}/websites/{website_id}/postgresql-dbs
createWebsitePostgresqlUser	POST /orgs/{org_id}/websites/{website_id}/postgresql-users
deleteWebsitePostgresqlDb	DELETE /orgs/{org_id}/websites/{website_id}/postgresql-dbs/{db_name}
deleteWebsitePostgresqlUser	DELETE /orgs/{org_id}/websites/{website_id}/postgresql-users/{username}
getWebsitePostgresqlDbs	GET /orgs/{org_id}/websites/{website_id}/postgresql-dbs
getWebsitePostgresqlUsers	GET /orgs/{org_id}/websites/{website_id}/postgresql-users
grantPostgresqlUserDbPrivileges	POST /orgs/{org_id}/websites/{website_id}/postgresql-users/{username}/privileges
revokePostgresqlUserDbPrivileges	DELETE /orgs/{org_id}/websites/{website_id}/postgresql-users/{username}/privileges/{db_name}
updateWebsitePostgresqlUser	PATCH /orgs/{org_id}/websites/{website_id}/postgresql-users/{username}

createWebsitePostgresqlDb

Create a PostgreSQL database for website

POST /orgs/{org_id}/websites/{website_id}/postgresql-dbs

Parameter	Type	Required
$websiteId	string	yes
$newMySQLDB	NewMySQLDB	yes
$orgId	?string	no

use GoSuccess\Enhance\DTO\NewMySQLDB;

$newMySQLDB = new NewMySQLDB();
$newMySQLDB->name = 'example';

$result = $enhance->postgresql->createWebsitePostgresqlDb('website-id', $newMySQLDB);

createWebsitePostgresqlUser

Create website PostgreSQL database user

POST /orgs/{org_id}/websites/{website_id}/postgresql-users

Parameter	Type	Required
$websiteId	string	yes
$newPostgresqlUser	NewPostgresqlUser	yes
$orgId	?string	no

use GoSuccess\Enhance\DTO\NewPostgresqlUser;

$newPostgresqlUser = new NewPostgresqlUser();
$newPostgresqlUser->username = 'example';
$newPostgresqlUser->password = 's3cret';

$result = $enhance->postgresql->createWebsitePostgresqlUser('website-id', $newPostgresqlUser);

deleteWebsitePostgresqlDb

Delete website PostgreSQL database

DELETE /orgs/{org_id}/websites/{website_id}/postgresql-dbs/{db_name}

Parameter	Type	Required
$websiteId	string	yes
$dbName	string	yes
$orgId	?string	no

$result = $enhance->postgresql->deleteWebsitePostgresqlDb('website-id', 'example');

deleteWebsitePostgresqlUser

Delete website PostgreSQL database user

DELETE /orgs/{org_id}/websites/{website_id}/postgresql-users/{username}

Parameter	Type	Required
$websiteId	string	yes
$username	string	yes
$orgId	?string	no

$result = $enhance->postgresql->deleteWebsitePostgresqlUser('website-id', 'example');

getWebsitePostgresqlDbs

Get website PostgreSQL databases

GET /orgs/{org_id}/websites/{website_id}/postgresql-dbs

Parameter	Type	Required
$websiteId	string	yes
$orgId	?string	no

$result = $enhance->postgresql->getWebsitePostgresqlDbs('website-id');

getWebsitePostgresqlUsers

Get website PostgreSQL database users

GET /orgs/{org_id}/websites/{website_id}/postgresql-users

Parameter	Type	Required
$websiteId	string	yes
$orgId	?string	no

$result = $enhance->postgresql->getWebsitePostgresqlUsers('website-id');

grantPostgresqlUserDbPrivileges

Grant privileges on a specific database

POST /orgs/{org_id}/websites/{website_id}/postgresql-users/{username}/privileges

Parameter	Type	Required
$websiteId	string	yes
$username	string	yes
$value	?string	yes
$orgId	?string	no

$result = $enhance->postgresql->grantPostgresqlUserDbPrivileges('website-id', 'example', 'example');

revokePostgresqlUserDbPrivileges

Remove privileges on this database

DELETE /orgs/{org_id}/websites/{website_id}/postgresql-users/{username}/privileges/{db_name}

Parameter	Type	Required
$websiteId	string	yes
$username	string	yes
$dbName	string	yes
$orgId	?string	no

$result = $enhance->postgresql->revokePostgresqlUserDbPrivileges('website-id', 'example', 'example');

updateWebsitePostgresqlUser

Update website PostgreSQL database user

PATCH /orgs/{org_id}/websites/{website_id}/postgresql-users/{username}

Parameter	Type	Required
$websiteId	string	yes
$username	string	yes
$postgresqlUserUpdate	PostgresqlUserUpdate	yes
$orgId	?string	no

use GoSuccess\Enhance\DTO\PostgresqlUserUpdate;

$postgresqlUserUpdate = new PostgresqlUserUpdate();
$postgresqlUserUpdate->password = 's3cret';

$result = $enhance->postgresql->updateWebsitePostgresqlUser('website-id', 'example', $postgresqlUserUpdate);