Managed PostgreSQL¶
Generated from the gateway schema. Do not edit.
Queries¶
allPostgresClusters¶
query { allPostgresClusters: PostgresClusterListResult! }
Requires: an authenticated member of the tenant
Returns: PostgresClusterListResult!
postgresClusterByCluster¶
query { postgresClusterByCluster(clusterId: ID!, name: String!, namespace: String): PostgresCluster }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
clusterId |
ID! |
|
name |
String! |
|
namespace |
String |
Returns: PostgresCluster
postgresClustersByCluster¶
query { postgresClustersByCluster(clusterId: ID!, namespace: String): PostgresClusterListResult! }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
clusterId |
ID! |
|
namespace |
String |
Returns: PostgresClusterListResult!
postgresDatabasesByCluster¶
query { postgresDatabasesByCluster(clusterId: ID!, namespace: String!, clusterName: String!): DatabaseListResult! }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
clusterId |
ID! |
|
namespace |
String! |
|
clusterName |
String! |
Returns: DatabaseListResult!
Mutations¶
createPostgresCluster¶
mutation { createPostgresCluster(clusterId: ID!, input: PostgresClusterInput!): PostgresCluster! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
clusterId |
ID! |
|
input |
PostgresClusterInput! |
Returns: PostgresCluster!
createPostgresDatabase¶
mutation { createPostgresDatabase(clusterId: ID!, namespace: String!, input: DatabaseInput!): Database! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
clusterId |
ID! |
|
namespace |
String! |
|
input |
DatabaseInput! |
Returns: Database!
deletePostgresCluster¶
mutation { deletePostgresCluster(clusterId: ID!, name: String!, namespace: String!): Boolean! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
clusterId |
ID! |
|
name |
String! |
|
namespace |
String! |
Returns: Boolean!
updatePostgresCluster¶
mutation { updatePostgresCluster(clusterId: ID!, input: PostgresClusterInput!): PostgresCluster! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
clusterId |
ID! |
|
input |
PostgresClusterInput! |
Returns: PostgresCluster!