Managed Service for PostgreSQL API, gRPC: ManagedRepackService.LaunchRepack
Launches new Repack in given cluster
gRPC request
rpc LaunchRepack (LaunchRepackRequest) returns (LaunchRepackResponse)
LaunchRepackRequest
{
"cluster_id": "string",
"spec": {
"type": "RepackType",
"dbname": "string",
"targets": [
{
"schema": "string",
// Includes only one of the fields `name`, `all_in_schema`
"name": "string",
"all_in_schema": "bool"
// end of the list of possible fields
}
],
"wait_timeout": "int64",
"jobs": "int64"
},
"start_timeout": "google.protobuf.Duration",
"launch_id": "string"
}
Request to launch a new Repack in a cluster.
|
Field |
Description |
|
cluster_id |
string Required field. Required. ID of the PostgreSQL cluster that Repack is running in. The maximum string length in characters is 50. |
|
spec |
Required field. Specification of repack to launch |
|
start_timeout |
Initial timeout to tell finished immediately from running repacks |
|
launch_id |
string UUID of launch to be set by client |
RepackSpec
Represents specification for launching new Repack process
|
Field |
Description |
|
type |
enum RepackType Which objects to repack
|
|
dbname |
string database name this repack process is working with |
|
targets[] |
list of target objects this repack process is working with |
|
wait_timeout |
int64 pg_repack option; timeout to cancel other backends on conflict |
|
jobs |
int64 pg_repack option; Use this many parallel jobs for each table |
RepackTarget
Single object to repack
|
Field |
Description |
|
schema |
string Schema of object to be repacked |
|
name |
string Name of object to be repacked Includes only one of the fields Object to repack within the schema. |
|
all_in_schema |
bool All objects within given schema are to be repacked Includes only one of the fields Object to repack within the schema. |
LaunchRepackResponse
{
// Includes only one of the fields `finished`, `running`
"finished": {
"cluster_id": "string",
"exit_code": "int64",
"launch_id": "string"
},
"running": {
"cluster_id": "string",
"start_time": "google.protobuf.Timestamp",
"spec": {
"type": "RepackType",
"dbname": "string",
"targets": [
{
"schema": "string",
// Includes only one of the fields `name`, `all_in_schema`
"name": "string",
"all_in_schema": "bool"
// end of the list of possible fields
}
],
"wait_timeout": "int64",
"jobs": "int64"
},
"launch_id": "string"
}
// end of the list of possible fields
}
Result of a Repack launch.
|
Field |
Description |
|
finished |
Returned if pg_repack finishes immediately before start_timeout expires Includes only one of the fields Outcome of the launch: finished immediately or still running. |
|
running |
Returned if pg_repack still runs after start_timeout expires Includes only one of the fields Outcome of the launch: finished immediately or still running. |
FinishedRepack
Represents already finished repack process
|
Field |
Description |
|
cluster_id |
string Which cluster this repack was launched in |
|
exit_code |
int64 Exit code of this repack launch |
|
launch_id |
string UUID of launch, identifier of specific instance of launched repack |
RunningRepack
Represents currently running repack process
|
Field |
Description |
|
cluster_id |
string Which cluster this repack runs in |
|
start_time |
When this repack process has been started |
|
spec |
Specification for this running repack |
|
launch_id |
string UUID of launch, identifier of specific instance of launched repack |
RepackSpec
Represents specification for launching new Repack process
|
Field |
Description |
|
type |
enum RepackType Which objects to repack
|
|
dbname |
string database name this repack process is working with |
|
targets[] |
list of target objects this repack process is working with |
|
wait_timeout |
int64 pg_repack option; timeout to cancel other backends on conflict |
|
jobs |
int64 pg_repack option; Use this many parallel jobs for each table |
RepackTarget
Single object to repack
|
Field |
Description |
|
schema |
string Schema of object to be repacked |
|
name |
string Name of object to be repacked Includes only one of the fields Object to repack within the schema. |
|
all_in_schema |
bool All objects within given schema are to be repacked Includes only one of the fields Object to repack within the schema. |