Reference documentation and code samples for the Cloud Spanner V1 Client class SplitPoints.
The split points of a table/index.
Generated from protobuf message google.spanner.admin.database.v1.SplitPoints
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ table |
string
The table to split. |
↳ index |
string
The index to split. If specified, the |
↳ keys |
array<SplitPoints\Key>
Required. The list of split keys, i.e., the split boundaries. |
↳ expire_time |
Google\Protobuf\Timestamp
Optional. The expiration timestamp of the split points. A timestamp in the past means immediate expiration. The maximum value can be 30 days in the future. Defaults to 10 days in the future if not specified. |
getTable
The table to split.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTable
The table to split.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIndex
The index to split.
If specified, the table field must refer to the index's base table.
| Returns | |
|---|---|
| Type | Description |
string |
|
setIndex
The index to split.
If specified, the table field must refer to the index's base table.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKeys
Required. The list of split keys, i.e., the split boundaries.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setKeys
Required. The list of split keys, i.e., the split boundaries.
| Parameter | |
|---|---|
| Name | Description |
var |
array<SplitPoints\Key>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExpireTime
Optional. The expiration timestamp of the split points.
A timestamp in the past means immediate expiration. The maximum value can be 30 days in the future. Defaults to 10 days in the future if not specified.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasExpireTime
clearExpireTime
setExpireTime
Optional. The expiration timestamp of the split points.
A timestamp in the past means immediate expiration. The maximum value can be 30 days in the future. Defaults to 10 days in the future if not specified.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|