Class protos.google.cloud.sql.v1.Database (0.23.0)
Represents a Database.
Package
@google-cloud/sqlConstructors
(constructor)(properties)
constructor(properties?:google.cloud.sql.v1.IDatabase);Constructs a new Database.
| Parameter | |
|---|---|
| Name | Description |
properties | IDatabaseProperties to set |
Properties
charset
publiccharset:string;Database charset.
collation
publiccollation:string;Database collation.
databaseDetails
publicdatabaseDetails?:"sqlserverDatabaseDetails";Database databaseDetails.
etag
publicetag:string;Database etag.
instance
publicinstance:string;Database instance.
kind
publickind:string;Database kind.
name
publicname:string;Database name.
project
publicproject:string;Database project.
selfLink
publicselfLink:string;Database selfLink.
sqlserverDatabaseDetails
publicsqlserverDatabaseDetails?:(google.cloud.sql.v1.ISqlServerDatabaseDetails|null);Database sqlserverDatabaseDetails.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.sql.v1.IDatabase):google.cloud.sql.v1.Database;Creates a new Database instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IDatabaseProperties to set |
| Returns | |
|---|---|
| Type | Description |
Database | Database instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.sql.v1.Database;Decodes a Database message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Database | Database |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.sql.v1.Database;Decodes a Database message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Database | Database |
encode(message, writer)
publicstaticencode(message:google.cloud.sql.v1.IDatabase,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Database message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IDatabaseDatabase message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.cloud.sql.v1.IDatabase,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Database message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IDatabaseDatabase message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.cloud.sql.v1.Database;Creates a Database message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object | { [k: string]: any }Plain object |
| Returns | |
|---|---|
| Type | Description |
Database | Database |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for Database
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this Database to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.cloud.sql.v1.Database,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a Database message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | DatabaseDatabase |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a Database message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.