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 Database

This class represents a Database in the Rackspace "Red Dwarf" database-as-a-service product.

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

Methods summary

public
# __construct( OpenCloud\Database\Resource\Instance $instance, $info = null )

Parameters

$instance
$service The service that this resource belongs to
$info
$data

Overrides

OpenCloud\Common\Resource\BaseResource::__construct
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

OpenCloud\Common\Exceptions\DatabaseNameError
public string
# primaryKeyField( )

Returns the primary key field for the object

Returns the primary key field for the object

Returns

string
public OpenCloud\Database\Resource\Instance
# instance( )

Returns the Instance of the database

Returns the Instance of the database

Returns

OpenCloud\Database\Resource\Instance
public OpenCloud\HttpResponse
# create( array $params = array() )

Creates a new database

Creates a new database

Parameters

$params
array of attributes to set prior to Create

Returns

OpenCloud\HttpResponse

Api

Overrides

OpenCloud\Common\Resource\PersistentResource::create
public
# update( array $params = array() )

Updates an existing database

Updates an existing database

Parameters

$params
ignored

Throws

DatabaseUpdateError
always; updates are not permitted

Overrides

OpenCloud\Common\Resource\PersistentResource::update

Methods inherited from OpenCloud\Common\Resource\PersistentResource

checkExtension(), createUrl(), delete(), id(), name(), refresh(), refreshFromLocationUrl(), region(), status(), 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(), populate(), setLogger(), stripNamespace(), toCamel(), toUnderscores()

Constants summary

Constants inherited from OpenCloud\Common\Base

PATCH_CONTENT_TYPE

Properties summary

public string $name
#
API documentation generated by ApiGen