Databases
extends CloudApiBase
in
implements
CloudApiInterface
Class Databases
Table of Contents
| $client | ClientInterface | |
|---|---|---|
| getAll() | Shows all databases in an application. | DatabasesResponse |
| create() | Create a new database. | OperationResponse |
| delete() | Delete a database. | OperationResponse |
| truncate() | Erases (truncates) a database. | OperationResponse |
| copy() | Copies a database from an environment to an environment. | OperationResponse |
| __construct() | Client constructor. | mixed |
Properties
$client
protected
ClientInterface
$client
Methods
getAll()
Shows all databases in an application.
public
getAll(
$applicationUuid :
string
)
: DatabasesResponse
Parameters
- $applicationUuid : string
Return values
DatabasesResponsecreate()
Create a new database.
public
create(
$applicationUuid :
string
, $name :
string
)
: OperationResponse
Parameters
- $applicationUuid : string
- $name : string
Return values
OperationResponsedelete()
Delete a database.
public
delete(
$applicationUuid :
string
, $name :
string
)
: OperationResponse
Parameters
- $applicationUuid : string
- $name : string
Return values
OperationResponsetruncate()
Erases (truncates) a database.
public
truncate(
$applicationUuid :
string
, $name :
string
)
: OperationResponse
This action will delete all tables of the database in ALL environments within this application.
Parameters
- $applicationUuid : string
- $name : string
Return values
OperationResponsecopy()
Copies a database from an environment to an environment.
public
copy(
$environmentFromUuid :
string
, $dbName :
string
, $environmentToUuid :
string
)
: OperationResponse
Parameters
- $environmentFromUuid : string
- $dbName : string
- $environmentToUuid : string
Return values
OperationResponse__construct()
Client constructor.
public
__construct(
$client :
ClientInterface
)
: mixed
Parameters
- $client : ClientInterface