Methods summary
public
|
#
__construct( OpenCloud\Database\Resource\Instance $instance, mixed $info = null )
Creates a new database object
Creates a new database object
Unlike other objects (Servers, DataObjects, etc.), passing a database name to
the constructor does not pull information from the database. For
example, if you pass an ID to the Server() constructor, it will
attempt to retrieve the information on that server from the service, and will
return an error if it is not found. However, the Cloud Databases service does
not permit retrieval of information on individual databases (only via
Collection), and thus passing in a name via the $info parameter
only creates an in-memory object that is not necessarily tied to an actual
database.
Parameters
- $instance
OpenCloud\Database\Resource\Instance
$instance the parent DbService\Instance of the database
- $info
mixed $info if an array or object, treated as properties to set; if a string, treated
as the database name
Throws
DatabaseNameError if $info is not a string, object, or array
Overrides
|
public
type
|
#
getName( )
Returns name of this database. Because it's so important (i.e. as an
identifier), it will throw an error if not set/empty.
Returns name of this database. Because it's so important (i.e. as an
identifier), it will throw an error if not set/empty.
Returns
type
Throws
|
public
string
|
#
primaryKeyField( )
Returns the primary key field for the object
Returns the primary key field for the object
The primary key is usually 'id', but this function is provided so that (in
rare cases where it is not 'id'), it can be overridden.
Returns
string
Overrides
|
public
OpenCloud\Database\Resource\Instance
|
#
instance( )
Returns the Instance of the database
Returns the Instance of the database
Returns
|
public
OpenCloud\HttpResponse
|
#
create( array $params = array() )
Creates a new database
Parameters
- $params
array $params array of attributes to set prior to Create
Returns
OpenCloud\HttpResponse
Throws
VolumeCreateError if HTTP status is not Success
Api
Overrides
|
public
|
#
update( array $params = array() )
Updates an existing database
Updates an existing database
Parameters
- $params
array $params ignored
Throws
DatabaseUpdateError always; updates are not permitted
Overrides
|
public
OpenCloud\HttpResponseb
|
#
delete( )
Deletes a database
Returns
OpenCloud\HttpResponseb
Throws
DeleteError if HTTP status is not Success
Api
Overrides
|
protected
|
#
createJson( array $params = array() )
Returns the JSON object for creating the database
Returns the JSON object for creating the database
Throws
CreateError if not overridden
Overrides
|