Console
    Contact Us Start free

    Cloud Spanner V1 Client - Class Database (1.104.0)

    Reference documentation and code samples for the Cloud Spanner V1 Client class Database.

    A Cloud Spanner database.

    Generated from protobuf message google.spanner.admin.database.v1.Database

    Namespace

    Google \ Cloud \ Spanner \ Admin \ Database \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Required. The name of the database. Values are of the form projects/<project>/instances/<instance>/databases/<database> , where <database> is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.

    ↳ state
    int

    Output only. The current database state.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. If exists, the time at which the database creation started.

    ↳ restore_info
    RestoreInfo

    Output only. Applicable only for restored databases. Contains information about the restore source.

    ↳ encryption_config
    EncryptionConfig

    Output only. For databases that are using customer managed encryption, this field contains the encryption configuration for the database. For databases that are using Google default or other types of encryption, this field is empty.

    ↳ encryption_info
    array< EncryptionInfo >

    Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.

    ↳ version_retention_period
    string

    Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl . Defaults to 1 hour, if not set.

    ↳ earliest_version_time
    Google\Protobuf\Timestamp

    Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.

    ↳ default_leader
    string

    Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.

    ↳ database_dialect
    int

    Output only. The dialect of the Cloud Spanner Database.

    ↳ enable_drop_protection
    bool

    Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion .

    ↳ reconciling
    bool

    Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.

    getName

    Required. The name of the database. Values are of the form projects/<project>/instances/<instance>/databases/<database> , where <database> is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.

    Returns
    Type
    Description
    string

    setName

    Required. The name of the database. Values are of the form projects/<project>/instances/<instance>/databases/<database> , where <database> is as specified in the CREATE DATABASE statement. This name can be passed to other API methods to identify the database.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getState

    Output only. The current database state.

    Returns
    Type
    Description
    int

    setState

    Output only. The current database state.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. If exists, the time at which the database creation started.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. If exists, the time at which the database creation started.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getRestoreInfo

    Output only. Applicable only for restored databases. Contains information about the restore source.

    Returns
    Type
    Description
    RestoreInfo |null

    hasRestoreInfo

    clearRestoreInfo

    setRestoreInfo

    Output only. Applicable only for restored databases. Contains information about the restore source.

    Parameter
    Name
    Description
    var
    RestoreInfo
    Returns
    Type
    Description
    $this

    getEncryptionConfig

    Output only. For databases that are using customer managed encryption, this field contains the encryption configuration for the database.

    For databases that are using Google default or other types of encryption, this field is empty.

    Returns
    Type
    Description
    EncryptionConfig |null

    hasEncryptionConfig

    clearEncryptionConfig

    setEncryptionConfig

    Output only. For databases that are using customer managed encryption, this field contains the encryption configuration for the database.

    For databases that are using Google default or other types of encryption, this field is empty.

    Parameter
    Name
    Description
    var
    EncryptionConfig
    Returns
    Type
    Description
    $this

    getEncryptionInfo

    Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated.

    For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setEncryptionInfo

    Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status' field inside of each EncryptionInfo` is not populated.

    For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field.

    Parameter
    Name
    Description
    var
    array< EncryptionInfo >
    Returns
    Type
    Description
    $this

    getVersionRetentionPeriod

    Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl .

    Defaults to 1 hour, if not set.

    Returns
    Type
    Description
    string

    setVersionRetentionPeriod

    Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl .

    Defaults to 1 hour, if not set.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getEarliestVersionTime

    Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasEarliestVersionTime

    clearEarliestVersionTime

    setEarliestVersionTime

    Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getDefaultLeader

    Output only. The read-write region which contains the database's leader replicas.

    This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.

    Returns
    Type
    Description
    string

    setDefaultLeader

    Output only. The read-write region which contains the database's leader replicas.

    This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDatabaseDialect

    Output only. The dialect of the Cloud Spanner Database.

    Returns
    Type
    Description
    int

    setDatabaseDialect

    Output only. The dialect of the Cloud Spanner Database.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getEnableDropProtection

    Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion .

    Returns
    Type
    Description
    bool

    setEnableDropProtection

    Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion .

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getReconciling

    Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.

    Returns
    Type
    Description
    bool

    setReconciling

    Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: