Overview

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
  • PHP

Classes

  • Configuration
  • Database
  • Datastore
  • DatastoreVersion
  • Instance
  • User
  • Overview
  • Namespace
  • Class
  • Tree

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
\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
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
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
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
OpenCloud\Common\Collection\PaginatedIterator
protected stdClass
# createJson( )

Generates the JSON string for Create()

Generates the JSON string for Create()

Returns

stdClass
\stdClass

Throws

RuntimeException
\RuntimeException

Overrides

OpenCloud\Common\Resource\PersistentResource::createJson()
protected @stdClass
# updateJson( mixed $params = array() )

Generates the JSON string for update()

Generates the JSON string for update()

Returns

@stdClass
\@stdClass

Overrides

OpenCloud\Common\Resource\PersistentResource::updateJson()
Methods inherited from OpenCloud\Common\Resource\NovaResource
action()
Methods inherited from OpenCloud\Common\Resource\PersistentResource
checkExtension(), create(), delete(), generateJsonPatch(), getAlias(), getUpdateablePropertiesAsArray(), noCreate(), noDelete(), noUpdate(), recursivelyAliasPropertyValue(), refresh(), refreshFromLocationUrl(), refreshFromParent(), update(), waitFor()
Methods inherited from OpenCloud\Common\Resource\BaseResource
findLink(), getClient(), getMetadata(), getParent(), getService(), getUrl(), jsonCollectionElement(), jsonCollectionName(), jsonName(), parseResponse(), primaryKeyField(), resourceName(), setMetadata(), setParent(), setService()
Methods inherited from OpenCloud\Common\Base
__call(), checkJsonError(), generateUuid(), getInstance(), getJsonHeader(), getLogger(), getPatchHeaders(), getProperty(), hasLogger(), makeResourceIteratorOptions(), populate(), propertyExists(), setLogger(), setProperty(), stripNamespace(), toCamel(), toUnderscores()
Constants inherited from OpenCloud\Common\Base
PATCH_CONTENT_TYPE
Properties summary
public mixed $id
#
public mixed $name
#
public mixed $status
#
public mixed $links
#
public mixed $hostname
#
public mixed $volume
#
public mixed $created
#
public mixed $updated
#
public mixed $flavor
#
protected static string $json_name
#'instance'
protected static string $url_resource
#'instances'
Properties inherited from OpenCloud\Common\Resource\BaseResource
$metadata, $parent, $service
Properties inherited from OpenCloud\Common\Base
$aliases
API documentation generated by ApiGen 2.8.0