Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class Database.
Message describing Database object.
Generated from protobuf message google.cloud.alloydb.v1.Database
Namespace
Google \ Cloud \ AlloyDb \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Name of the resource in the form of |
↳ charset |
string
Optional. Immutable. Charset for the database. This field can contain any PostgreSQL supported charset name. Example values include "UTF8", "SQL_ASCII", etc. |
↳ collation |
string
Optional. Immutable. lc_collate for the database. String sort order. Example values include "C", "POSIX", etc. |
↳ character_type |
string
Optional. Immutable. lc_ctype for the database. Character classification (What is a letter? The upper-case equivalent?). Example values include "C", "POSIX", etc. |
↳ database_template |
string
Input only. Immutable. Template of the database to be used for creating a new database. |
↳ is_template_database |
bool
Optional. Whether the database is a template database. |
getName
Identifier. Name of the resource in the form of
projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Name of the resource in the form of
projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCharset
Optional. Immutable. Charset for the database.
This field can contain any PostgreSQL supported charset name. Example values include "UTF8", "SQL_ASCII", etc.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCharset
Optional. Immutable. Charset for the database.
This field can contain any PostgreSQL supported charset name. Example values include "UTF8", "SQL_ASCII", etc.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCollation
Optional. Immutable. lc_collate for the database.
String sort order. Example values include "C", "POSIX", etc.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCollation
Optional. Immutable. lc_collate for the database.
String sort order. Example values include "C", "POSIX", etc.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCharacterType
Optional. Immutable. lc_ctype for the database.
Character classification (What is a letter? The upper-case equivalent?). Example values include "C", "POSIX", etc.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCharacterType
Optional. Immutable. lc_ctype for the database.
Character classification (What is a letter? The upper-case equivalent?). Example values include "C", "POSIX", etc.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDatabaseTemplate
Input only. Immutable. Template of the database to be used for creating a new database.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDatabaseTemplate
Input only. Immutable. Template of the database to be used for creating a new database.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsTemplateDatabase
Optional. Whether the database is a template database.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasIsTemplateDatabase
clearIsTemplateDatabase
setIsTemplateDatabase
Optional. Whether the database is a template database.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|