Overview
  • Namespace
  • Class

Namespaces

  • OpenCloud
    • Autoscale
      • Resource
    • CDN
      • Resource
    • CloudMonitoring
      • Collection
      • Exception
      • Resource
    • Common
      • Collection
      • Constants
      • Exceptions
      • Http
        • Message
      • Log
      • Resource
      • Service
    • Compute
      • Constants
      • Exception
      • Resource
    • Database
      • Resource
    • DNS
      • Collection
      • Resource
    • Identity
      • Constants
      • Resource
    • Image
      • Enum
      • Resource
        • JsonPatch
        • Schema
    • LoadBalancer
      • Collection
      • Enum
      • Resource
    • Networking
      • Resource
    • ObjectStore
      • Constants
      • Enum
      • Exception
      • Resource
      • Upload
    • Orchestration
      • Resource
    • Queues
      • Collection
      • Exception
      • Resource
    • Volume
      • Resource

Classes

  • Backup
  • Configuration
  • Database
  • Datastore
  • DatastoreVersion
  • Instance
  • User

Class Instance

Instance represents an instance of DbService, similar to a Server in a Compute service

OpenCloud\Common\Base
Extended by OpenCloud\Common\Resource\BaseResource
Extended by OpenCloud\Common\Resource\PersistentResource
Extended by OpenCloud\Common\Resource\NovaResource
Extended by OpenCloud\Database\Resource\Instance
Namespace: OpenCloud\Database\Resource
Located at OpenCloud/Database/Resource/Instance.php

Methods summary

public
# __construct( OpenCloud\Database\Service $service, mixed $info = null )

Creates a new instance object

Creates a new instance object

This could use the default constructor, but we want to make sure that the volume attribute is an object.

Parameters

$service

the DbService object associated with this

$info
the ID or array of info for the object

Overrides

OpenCloud\Common\Resource\BaseResource::__construct
public
# restart( )

Restarts the database instance

Restarts the database instance

Api

Returns

\OpenCloud\HttpResponse
public
# resize( OpenCloud\Compute\Resource\Flavor $flavor )

Resizes the database instance (sets RAM)

Resizes the database instance (sets RAM)

Parameters

$flavor
a flavor object

Api

Returns

\OpenCloud\HttpResponse
public OpenCloud\HttpResponse
# resizeVolume( integer $newvolumesize )

Resizes the volume associated with the database instance (disk space)

Resizes the volume associated with the database instance (disk space)

Parameters

$newvolumesize
the size of the new volume, in gigabytes

Returns

OpenCloud\HttpResponse

Api

public OpenCloud\Database\Resource\User
# enableRootUser( )

Enables the root user for the instance

Enables the root user for the instance

Returns

OpenCloud\Database\Resource\User
the root user, including name and password

Throws

InstanceError
if HTTP response is not Success

Api

public boolean
# isRootEnabled( )

Returns TRUE if the root user is enabled

Returns TRUE if the root user is enabled

Returns

boolean
TRUE if the root user is enabled; FALSE otherwise

Throws

InstanceError
if HTTP status is not Success

Api

public OpenCloud\Database\Resource\Database
# database( string $name = '' )

Returns a new Database object

Returns a new Database object

Parameters

$name
the database name

Returns

OpenCloud\Database\Resource\Database
public OpenCloud\Database\Resource\User
# user( string $name = '', array $databases = array() )

Returns a new User object

Returns a new User object

Parameters

$name
the user name
$databases
a simple array of database names

Returns

OpenCloud\Database\Resource\User
public OpenCloud\Common\Collection\PaginatedIterator
# databaseList( )

Returns a Collection of all databases in the instance

Returns a Collection of all databases in the instance

Returns

OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Common\Collection\PaginatedIterator
# userList( )

Returns a Collection of all users in the instance

Returns a Collection of all users in the instance

Returns

OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Common\Collection\PaginatedIterator
# backupList( )

Returns a Collection of all backups for the instance

Returns a Collection of all backups for the instance

Returns

OpenCloud\Common\Collection\PaginatedIterator
public OpenCloud\Database\Resource\Backup
# createBackup( array $params = array() )

Creates a backup for the given instance

Creates a backup for the given instance

Parameters

$params
  • an associate array of key/value pairs name is required description is optional

Returns

OpenCloud\Database\Resource\Backup

Api

public
# populate( mixed $info, boolean $setObjects = true )

Populates the current object based on an unknown data type.

Populates the current object based on an unknown data type.

Parameters

$info
$setObjects

Throws

OpenCloud\Common\Exceptions\InvalidArgumentError

Overrides

OpenCloud\Common\Base::populate

Methods inherited from OpenCloud\Common\Resource\PersistentResource

checkExtension(), create(), createUrl(), delete(), id(), name(), refresh(), refreshFromLocationUrl(), region(), status(), update(), waitFor()

Methods inherited from OpenCloud\Common\Resource\BaseResource

findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), jsonCollectionElement(), jsonCollectionName(), jsonName(), parseResponse(), resourceName(), setMetadata(), setParent(), setService(), url()

Methods inherited from OpenCloud\Common\Base

__call(), checkJsonError(), generateUuid(), getInstance(), getLogger(), hasLogger(), makeResourceIteratorOptions(), setLogger(), stripNamespace(), toCamel(), toUnderscores()

Constants summary

Constants inherited from OpenCloud\Common\Base

PATCH_CONTENT_TYPE

Properties summary

public $id
#
public $name
#
public $status
#
public $links
#
public $hostname
#
public $volume
#
public $created
#
public $updated
#
public $flavor
#
public $backupRef
#
API documentation generated by ApiGen