pr comments

This commit is contained in:
Mike 2019-03-19 13:02:55 -07:00
parent 007e73ff4c
commit a69d9291cd
2 changed files with 18 additions and 2 deletions

View File

@ -62,7 +62,11 @@ type DatabasesServiceOp struct {
var _ DatabasesService = &DatabasesServiceOp{}
// Database represents a database cluster
// Database represents a DigitalOcean managed database product. These managed databases
// are usually comprised of a cluster of database nodes, a primary and 0 or more replicas.
// The EngineSlug is a string which indicates the type of database service. Some examples are
// "pg", "mysql" or "redis". A Database also includes connection information and other
// properties of the service like region, size and current status.
type Database struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
@ -139,7 +143,10 @@ type DatabaseUpdateMaintenanceRequest struct {
Hour string `json:"hour,omitempty"`
}
// DatabaseDB represents an engine-specific database created within a database cluster
// DatabaseDB represents an engine-specific database created within a database cluster. For SQL
// databases like PostgreSQL or MySQL, a "DB" refers to a database created on the RDBMS. For instance,
// a PostgreSQL database server can contain many database schemas, each with it's own settings, access
// permissions and data. ListDBs will return all databases present on the server.
type DatabaseDB struct {
Name string `json:"name"`
}

9
doc.go
View File

@ -1,2 +1,11 @@
// Package godo is the DigtalOcean API v2 client for Go
//
// Databases
//
// The Databases service provides access to the DigitalOcean managed database
// suite of products. Customers can create new database clusters, migrate them
// between regions, create replicas and interact with their configurations.
// Each database service is refered to as a Database. A SQL database service
// can have multiple databases residing in the system. To help make these
// entities distinct from Databases in godo, we refer to them here as DatabaseDBs.
package godo