Database

google.spanner.admin.database.v1. Database

Represents a Database.

Constructor

new Database(propertiesopt)

Constructs a new Database.

Parameters:
Name Type Attributes Description
properties google.spanner.admin.database.v1.IDatabase <optional>

Properties to set
Implements:
  • IDatabase

Members

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
CREATING number

CREATING value
READY number

READY value
READY_OPTIMIZING number

READY_OPTIMIZING value

createTime

Database createTime.

earliestVersionTime

Database earliestVersionTime.

encryptionConfig

Database encryptionConfig.

encryptionInfo

Database encryptionInfo.

name

Database name.

restoreInfo

Database restoreInfo.

state

Database state.

versionRetentionPeriod

Database versionRetentionPeriod.

Methods

(static) create(propertiesopt) → {google.spanner.admin.database.v1.Database}

Creates a new Database instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.spanner.admin.database.v1.IDatabase <optional>

Properties to set
Returns:
Type Description
google.spanner.admin.database.v1.Database

Database instance

(static) decode(reader, lengthopt) → {google.spanner.admin.database.v1.Database}

Decodes a Database message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.spanner.admin.database.v1.Database

Database
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.spanner.admin.database.v1.Database}

Decodes a Database message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.spanner.admin.database.v1.Database

Database
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Database message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.spanner.admin.database.v1.IDatabase

Database message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Database message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.spanner.admin.database.v1.IDatabase

Database message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.spanner.admin.database.v1.Database}

Creates a Database message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.spanner.admin.database.v1.Database

Database

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a Database message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.spanner.admin.database.v1.Database

Database
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Database message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this Database to JSON.

Returns:
Type Description
Object.<string, *>

JSON object