DatabaseService
Набор методов для управления ресурсами Database для PostgreSQL.
Вызов | Описание |
---|---|
Get | Возвращает указанный ресурс Database для PostgreSQL. |
List | Получает список ресурсов Database для указанного кластера PostgreSQL. |
Create | Создает новую базу данных PostgreSQL в указанном кластере. |
Update | Изменяет указанную базу данных PostgreSQL. |
Delete | Удаляет указанную базу данных PostgreSQL. |
Вызовы DatabaseService
Get
Возвращает указанный ресурс Database для PostgreSQL.
Чтобы получить список доступных ресурсов Database для PostgreSQL, отправьте запрос List.
rpc Get (GetDatabaseRequest) returns (Database)
GetDatabaseRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, к которому принадлежит база данных. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
database_name | string Обязательное поле. Имя запрашиваемого ресурса Database для PostgreSQL. Чтобы получить имя базы данных, используйте запрос DatabaseService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
Database
Поле | Описание |
---|---|
name | string Имя базы данных. |
cluster_id | string Идентификатор кластера PostgreSQL, к которому принадлежит база данных. |
owner | string Имя пользователя, назначенного владельцем базы данных. |
lc_collate | string POSIX-локаль для порядка сортировки строк. Может быть установлен только во время создания. |
lc_ctype | string POSIX-локаль для классификации символов. Может быть установлена только во время создания. |
extensions[] | Extension Расширения PostgreSQL, включенные для базы данных. |
Extension
Поле | Описание |
---|---|
name | string Имя расширения, например pg_trgm или pg_btree . Расширения, которые поддерживает Managed Service for PostgreSQL, перечислены в документации. |
version | string Версия расширения. |
List
Получает список ресурсов Database для указанного кластера PostgreSQL.
rpc List (ListDatabasesRequest) returns (ListDatabasesResponse)
ListDatabasesRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, для которого нужно вывести список баз данных. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListDatabasesResponse.next_page_token, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListDatabasesResponse.next_page_token предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListDatabasesResponse
Поле | Описание |
---|---|
databases[] | Database Список ресурсов Database для баз данных PostgreSQL. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListDatabasesRequest.page_size, используйте next_page_token в качестве значения параметра ListDatabasesRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token для перебора страниц результатов. |
Database
Поле | Описание |
---|---|
name | string Имя базы данных. |
cluster_id | string Идентификатор кластера PostgreSQL, к которому принадлежит база данных. |
owner | string Имя пользователя, назначенного владельцем базы данных. |
lc_collate | string POSIX-локаль для порядка сортировки строк. Может быть установлен только во время создания. |
lc_ctype | string POSIX-локаль для классификации символов. Может быть установлена только во время создания. |
extensions[] | Extension Расширения PostgreSQL, включенные для базы данных. |
Extension
Поле | Описание |
---|---|
name | string Имя расширения, например pg_trgm или pg_btree . Расширения, которые поддерживает Managed Service for PostgreSQL, перечислены в документации. |
version | string Версия расширения. |
Create
Создает новую базу данных PostgreSQL в указанном кластере.
rpc Create (CreateDatabaseRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateDatabaseMetadata
Operation.response:Database
CreateDatabaseRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, в котором следует создать базу данных. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
database_spec | DatabaseSpec Обязательное поле. Конфигурация создаваемой базы данных. |
DatabaseSpec
Поле | Описание |
---|---|
name | string Обязательное поле. Имя базы данных PostgreSQL. Длина 1-63 символов. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
owner | string Обязательное поле. Имя пользователя, которого нужно назначить владельцем базы данных. Чтобы получить список доступных пользователей PostgreSQL, сделайте запрос UserService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_]* . |
lc_collate | string POSIX-локаль для порядка сортировки строк. Может быть установлен только во время создания. Значение должно соответствовать регулярному выражению |[a-zA-Z_]+.UTF-8|C . |
lc_ctype | string POSIX-локаль для классификации символов. Может быть установлена только во время создания. Значение должно соответствовать регулярному выражению |[a-zA-Z_]+.UTF-8|C . |
extensions[] | Extension Расширения PostgreSQL, которые следует подключить для базы данных. |
Extension
Поле | Описание |
---|---|
name | string Имя расширения, например pg_trgm или pg_btree . Расширения, которые поддерживает Managed Service for PostgreSQL, перечислены в документации. |
version | string Версия расширения. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<CreateDatabaseMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Database> в случае успешного выполнения операции. |
CreateDatabaseMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера PostgreSQL, в котором создается база данных. |
database_name | string Имя создаваемой базы данных PostgreSQL. |
Database
Поле | Описание |
---|---|
name | string Имя базы данных. |
cluster_id | string Идентификатор кластера PostgreSQL, к которому принадлежит база данных. |
owner | string Имя пользователя, назначенного владельцем базы данных. |
lc_collate | string POSIX-локаль для порядка сортировки строк. Может быть установлен только во время создания. |
lc_ctype | string POSIX-локаль для классификации символов. Может быть установлена только во время создания. |
extensions[] | Extension Расширения PostgreSQL, включенные для базы данных. |
Extension
Поле | Описание |
---|---|
name | string Имя расширения, например pg_trgm или pg_btree . Расширения, которые поддерживает Managed Service for PostgreSQL, перечислены в документации. |
version | string Версия расширения. |
Update
Изменяет указанную базу данных PostgreSQL.
rpc Update (UpdateDatabaseRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateDatabaseMetadata
Operation.response:Database
UpdateDatabaseRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, в котором следует изменить базу данных. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
database_name | string Обязательное поле. Имя изменяемой базы данных. Чтобы получить имя базы данных, используйте запрос DatabaseService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
update_mask | google.protobuf.FieldMask Маска, которая указывает, какие поля ресурса Database должны быть обновлены. |
extensions[] | Extension Расширения PostgreSQL, которые должны быть подключены для базы данных. Если поле указано, список включенных расширений полностью переписывается. Поэтому, чтобы отключить активное расширение, вам нужно отправить новый список без этого расширения. |
Extension
Поле | Описание |
---|---|
name | string Имя расширения, например pg_trgm или pg_btree . Расширения, которые поддерживает Managed Service for PostgreSQL, перечислены в документации. |
version | string Версия расширения. |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<UpdateDatabaseMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<Database> в случае успешного выполнения операции. |
UpdateDatabaseMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера PostgreSQL, в котором изменяется база данных. |
database_name | string Имя изменяемой базы данных PostgreSQL. |
Database
Поле | Описание |
---|---|
name | string Имя базы данных. |
cluster_id | string Идентификатор кластера PostgreSQL, к которому принадлежит база данных. |
owner | string Имя пользователя, назначенного владельцем базы данных. |
lc_collate | string POSIX-локаль для порядка сортировки строк. Может быть установлен только во время создания. |
lc_ctype | string POSIX-локаль для классификации символов. Может быть установлена только во время создания. |
extensions[] | Extension Расширения PostgreSQL, включенные для базы данных. |
Extension
Поле | Описание |
---|---|
name | string Имя расширения, например pg_trgm или pg_btree . Расширения, которые поддерживает Managed Service for PostgreSQL, перечислены в документации. |
version | string Версия расширения. |
Delete
Удаляет указанную базу данных PostgreSQL.
rpc Delete (DeleteDatabaseRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteDatabaseMetadata
Operation.response:google.protobuf.Empty
DeleteDatabaseRequest
Поле | Описание |
---|---|
cluster_id | string Обязательное поле. Идентификатор кластера PostgreSQL, в котором следует удалить базу данных. Чтобы получить идентификатор кластера, используйте запрос ClusterService.List. Максимальная длина строки в символах — 50. |
database_name | string Обязательное поле. Имя удаляемой базы данных. Чтобы получить имя базы данных, используйте запрос DatabaseService.List. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению [a-zA-Z0-9_-]* . |
Operation
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
created_by | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modified_at | google.protobuf.Timestamp Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. |
done | bool Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response . |
metadata | google.protobuf.Any<DeleteDatabaseMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata . |
result | oneof: error или response Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error . Если done == true — задано значение ровно одного из полей error или response . |
error | google.rpc.Status Описание ошибки в случае сбоя или отмены операции. |
response | google.protobuf.Any<google.protobuf.Empty> в случае успешного выполнения операции. |
DeleteDatabaseMetadata
Поле | Описание |
---|---|
cluster_id | string Идентификатор кластера PostgreSQL, в котором удаляется база данных. |
database_name | string Имя удаляемой базы данных PostgreSQL. |